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 1d752c43e..35e77a663 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 @@ -172,6 +172,10 @@ "name": "enterprise-team-memberships", "description": "Endpoints to manage GitHub Enterprise Team memberships." }, + { + "name": "enterprise-team-organizations", + "description": "Endpoints to manage GitHub Enterprise Team organization assignments." + }, { "name": "code-security", "description": "Endpoints to manage Code security using the REST API." @@ -3212,12 +3216,6 @@ { "$ref": "#/components/parameters/pagination-after" }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" - }, { "$ref": "#/components/parameters/per-page" } @@ -3263,98 +3261,6 @@ } } }, - "/enterprises/{enterprise}/secret-scanning/alerts": { - "get": { - "summary": "List secret scanning alerts for an enterprise", - "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\n\nAlerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](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 a member of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint.", - "tags": [ - "secret-scanning" - ], - "operationId": "secret-scanning/list-alerts-for-enterprise", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise" - }, - "parameters": [ - { - "$ref": "#/components/parameters/enterprise" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-state" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-resolution" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-sort" - }, - { - "$ref": "#/components/parameters/direction" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/pagination-before" - }, - { - "$ref": "#/components/parameters/pagination-after" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-validity" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/organization-secret-scanning-alert" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/organization-secret-scanning-alert-list" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "secret-scanning", - "subcategory": "secret-scanning" - } - } - }, "/enterprises/{enterprise}/teams": { "get": { "summary": "List enterprise teams", @@ -3456,6 +3362,16 @@ ], "default": "disabled" }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint.\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, "group_id": { "type": [ "string", @@ -3857,6 +3773,336 @@ } } }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": { + "get": { + "summary": "Get organization assignments", + "description": "Get all organizations assigned to an enterprise team", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "An array of organizations the team is assigned to", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": { + "post": { + "summary": "Add organization assignments", + "description": "Assign an enterprise team to multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to assign the team to.", + "items": { + "type": "string", + "description": "Organization slug to assign the team to" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Successfully assigned the enterprise team to organizations.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": { + "post": { + "summary": "Remove organization assignments", + "description": "Unassign an enterprise team from multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-remove", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to unassign the team from.", + "items": { + "type": "string", + "description": "Organization slug to unassign the team from" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from organizations." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": { + "get": { + "summary": "Get organization assignment", + "description": "Check if an enterprise team is assigned to an organization", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "The team is assigned to the organization", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-simple" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple" + } + } + } + } + }, + "404": { + "description": "The team is not assigned to the organization" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "put": { + "summary": "Add an organization assignment", + "description": "Assign an enterprise team to an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "201": { + "description": "Successfully assigned the enterprise team to the organization.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-simple" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "delete": { + "summary": "Delete an organization assignment", + "description": "Unassign an enterprise team from an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from the organization." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, "/enterprises/{enterprise}/teams/{team_slug}": { "get": { "summary": "Get an enterprise team", @@ -3958,6 +4204,16 @@ ], "default": "disabled" }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments).\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, "group_id": { "type": [ "string", @@ -7303,10 +7559,125 @@ } } }, + "/organizations/{org}/org-properties/values": { + "get": { + "summary": "Get all custom property values for an organization", + "description": "Gets all custom property values that are set for an organization.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `read:org` scope\n- Actors with the organization-level \"read custom properties for an organization\" fine-grained permission or above", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-orgs-get-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-property-values" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties-for-orgs" + } + }, + "patch": { + "summary": "Create or update custom property values for an organization", + "description": "Create new or update existing custom property values for an organization.\nTo remove a custom property value from an organization, set the property value to `null`.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `admin:org` scope\n- Actors with the organization-level \"edit custom properties for an organization\" fine-grained permission", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-orgs-create-or-update-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the organization.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/create-or-update-custom-properties-values" + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties-for-orgs" + } + } + }, "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", - "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.", + "description": "Gets a report of premium request 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:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -7958,6 +8329,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": [ + "string", + "null" + ] } } }, @@ -7976,6 +8354,11 @@ "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" + }, + "image_gen": { + "description": "Whether this runner should be used to generate custom images.", + "type": "boolean", + "default": false } }, "required": [ @@ -8028,17 +8411,17 @@ } } }, - "/orgs/{org}/actions/hosted-runners/images/github-owned": { + "/orgs/{org}/actions/hosted-runners/images/custom": { "get": { - "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", - "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-github-owned-images-for-org", + "summary": "List custom images for an organization", + "description": "List custom images for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", "tags": [ "actions" ], + "operationId": "actions/list-custom-images-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization" }, "parameters": [ { @@ -8063,14 +8446,14 @@ "images": { "type": "array", "items": { - "$ref": "#/components/schemas/actions-hosted-runner-curated-image" + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" } } } }, "examples": { "default": { - "$ref": "#/components/examples/actions-hosted-runner-curated-image" + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" } } } @@ -8085,17 +8468,292 @@ } } }, - "/orgs/{org}/actions/hosted-runners/images/partner": { + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": { "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 a custom image definition for GitHub Actions Hosted Runners", + "description": "Get a custom image definition for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", "tags": [ "actions" ], + "operationId": "actions/get-custom-image-for-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/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete a custom image from the organization", + "description": "Delete a custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { + "get": { + "summary": "List image versions of a custom image for an organization", + "description": "List image versions of a custom image for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-image-versions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "image_versions" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "image_versions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { + "get": { + "summary": "Get an image version of a custom image for GitHub Actions Hosted Runners", + "description": "Get an image version of a custom image for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-version-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/actions-custom-image-version" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-version" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete an image version of custom image from the organization", + "description": "Delete an image version of custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-version-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/actions-custom-image-version" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/github-owned": { + "get": { + "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", + "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-github-owned-images-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "images" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner-curated-image" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-curated-image" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/partner": { + "get": { + "summary": "Get partner images for GitHub-hosted runners in an organization", + "description": "Get the list of partner images available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-partner-images-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -8394,6 +9052,13 @@ "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" + }, + "image_version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": [ + "string", + "null" + ] } } }, @@ -12565,7 +13230,7 @@ }, "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." + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types." } }, "required": [ @@ -12816,6 +13481,77 @@ } } }, + "/orgs/{org}/attestations/repositories": { + "get": { + "summary": "List attestation repositories", + "description": "List repositories owned by the provided organization that have created at least one attested artifact\nResults will be sorted in ascending order by repository ID", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestation-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/attestations#list-attestation-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/list-attestation-repositories" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + } + } + }, "/orgs/{org}/attestations/{attestation_id}": { "delete": { "summary": "Delete attestations by ID", @@ -12901,7 +13637,7 @@ }, { "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.", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", "in": "query", "required": false, "schema": { @@ -13289,7 +14025,10 @@ }, "code_scanning_alerts": { "description": "The code scanning alerts to include in this campaign", - "type": "array", + "type": [ + "array", + "null" + ], "minItems": 1, "items": { "type": "object", @@ -13323,8 +14062,19 @@ "required": [ "name", "description", - "ends_at", - "code_scanning_alerts" + "ends_at" + ], + "oneOf": [ + { + "required": [ + "code_scanning_alerts" + ] + }, + { + "required": [ + "secret_scanning_alerts" + ] + } ] }, "examples": { @@ -16474,12 +17224,6 @@ { "$ref": "#/components/parameters/pagination-after" }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" - }, { "$ref": "#/components/parameters/per-page" } @@ -23109,17 +23853,21 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } }, @@ -23297,17 +24045,21 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -35187,7 +35939,7 @@ }, { "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.", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", "in": "query", "required": false, "schema": { @@ -44473,16 +45225,6 @@ { "$ref": "#/components/parameters/direction" }, - { - "name": "page", - "description": "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", - "deprecated": true, - "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).\"", @@ -44498,12 +45240,6 @@ }, { "$ref": "#/components/parameters/pagination-after" - }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" } ], "responses": { @@ -61643,7 +62379,7 @@ "/repos/{owner}/{repo}/secret-scanning/scan-history": { "get": { "summary": "Get secret scanning scan history for a repository", - "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\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.", + "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security).\"\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": [ "secret-scanning" ], @@ -73337,7 +74073,7 @@ }, "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." + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types." } }, "required": [ @@ -73673,7 +74409,7 @@ }, { "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.", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", "in": "query", "required": false, "schema": { @@ -75284,17 +76020,21 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -75463,17 +76203,21 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -76022,7 +76766,7 @@ "/users/{username}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for a user", - "description": "Gets a report of premium request usage for a user.", + "description": "Gets a report of premium request usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -102393,6 +103137,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -102590,6 +103342,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -105754,578 +106515,6 @@ ], "additionalProperties": false }, - "secret-scanning-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" - ] - }, - "secret-scanning-alert-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 - ] - }, - "secret-scanning-location-commit": { - "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" - ] - }, - "secret-scanning-location-wiki-commit": { - "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" - ] - }, - "secret-scanning-location-issue-title": { - "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" - ] - }, - "secret-scanning-location-issue-body": { - "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" - ] - }, - "secret-scanning-location-issue-comment": { - "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" - ] - }, - "secret-scanning-location-discussion-title": { - "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" - ] - }, - "secret-scanning-location-discussion-body": { - "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" - ] - }, - "secret-scanning-location-discussion-comment": { - "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" - ] - }, - "secret-scanning-location-pull-request-title": { - "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" - ] - }, - "secret-scanning-location-pull-request-body": { - "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" - ] - }, - "secret-scanning-location-pull-request-comment": { - "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" - ] - }, - "secret-scanning-location-pull-request-review": { - "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" - ] - }, - "secret-scanning-location-pull-request-review-comment": { - "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" - ] - }, - "secret-scanning-first-detected-location": { - "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", - "oneOf": [ - { - "$ref": "#/components/schemas/secret-scanning-location-commit" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-issue-title" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-issue-body" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" - } - ] - }, - "organization-secret-scanning-alert": { - "type": "object", - "properties": { - "number": { - "$ref": "#/components/schemas/alert-number" - }, - "created_at": { - "$ref": "#/components/schemas/alert-created-at" - }, - "updated_at": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/alert-updated-at" - } - ] - }, - "url": { - "$ref": "#/components/schemas/alert-url" - }, - "html_url": { - "$ref": "#/components/schemas/alert-html-url" - }, - "locations_url": { - "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." - }, - "state": { - "$ref": "#/components/schemas/secret-scanning-alert-state" - }, - "resolution": { - "$ref": "#/components/schemas/secret-scanning-alert-resolution" - }, - "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" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "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": { - "$ref": "#/components/schemas/simple-repository" - }, - "push_protection_bypassed": { - "type": [ - "boolean", - "null" - ], - "description": "Whether push protection was bypassed for the detected secret." - }, - "push_protection_bypassed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "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" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "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" - }, - { - "$ref": "#/components/schemas/secret-scanning-first-detected-location" - } - ] - }, - "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." - }, - "assigned_to": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - } - } - }, "enterprise-team": { "title": "Enterprise Team", "description": "Group of enterprise owners and/or members", @@ -106411,538 +106600,140 @@ "group_id" ] }, - "actor": { - "title": "Actor", - "description": "Actor", + "organization-simple": { + "title": "Organization Simple", + "description": "A GitHub organization.", "type": "object", "properties": { - "id": { - "type": "integer" - }, "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { "type": "string", - "format": "uri" + "examples": [ + "github" + ] }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] - }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { "id": { - "description": "Unique identifier for the label.", "type": "integer", - "format": "int64", "examples": [ - 208045946 + 1 ] }, "node_id": { "type": "string", "examples": [ - "MDU6TGFiZWwyMDgwNDU5NDY=" + "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { - "description": "URL for the label", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repositories/42/labels/bug" + "https://api.github.com/orgs/github" ] }, - "name": { - "description": "The name of the label.", + "repos_url": { "type": "string", + "format": "uri", "examples": [ - "bug" + "https://api.github.com/orgs/github/repos" ] }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ], + "events_url": { + "type": "string", + "format": "uri", "examples": [ - "Something isn't working" + "https://api.github.com/orgs/github/events" ] }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", + "hooks_url": { "type": "string", "examples": [ - "FFFFFF" + "https://api.github.com/orgs/github/hooks" ] }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", + "issues_url": { + "type": "string", "examples": [ - true - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - }, - "discussion": { - "title": "Discussion", - "description": "A Discussion in a repository.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - }, - "answer_html_url": { - "type": [ - "string", - "null" + "https://api.github.com/orgs/github/issues" ] }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + "members_url": { "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" + "examples": [ + "https://api.github.com/orgs/github/members{/member}" ] }, - "comments": { - "type": "integer" - }, - "created_at": { + "public_members_url": { "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "locked": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" ] }, - "repository_url": { - "type": "string" - }, - "state": { + "avatar_url": { "type": "string", - "description": "The current state of the discussion.\n`converting` means that the discussion is being converted from an issue.\n`transferring` means that the discussion is being transferred from another repository.", - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" + "examples": [ + "https://github.com/images/error/octocat_happy.gif" ] }, - "state_reason": { - "description": "The reason for the current state", + "description": { "type": [ "string", "null" ], - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ], "examples": [ - "resolved" + "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" + ] + }, + "actor": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" }, - "timeline_url": { + "login": { "type": "string" }, - "title": { + "display_login": { "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "user": { - "title": "User", + "gravatar_id": { "type": [ - "object", + "string", "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" ] }, - "labels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/label" - } + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", "id", - "node_id", - "number", - "title", - "user", - "state", - "state_reason", - "locked", - "comments", - "created_at", - "updated_at", - "active_lock_reason", - "body" + "login", + "gravatar_id", + "url", + "avatar_url" ] }, "milestone": { @@ -107805,350 +107596,13 @@ "node_id", "html_url", "issue_url", + "author_association", "user", "url", "created_at", "updated_at" ] }, - "pull-request-minimal": { - "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" - ] - }, - "release-asset": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded", - "open" - ] - }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "download_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - } - }, - "required": [ - "id", - "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" - ] - }, - "release": { - "title": "Release", - "description": "A release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "assets_url": { - "type": "string", - "format": "uri" - }, - "upload_url": { - "type": "string" - }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "tag_name": { - "description": "The name of the tag.", - "type": "string", - "examples": [ - "v1.0.0" - ] - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", - "type": "string", - "examples": [ - "master" - ] - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "draft": { - "description": "true to create a draft (unpublished) release, false to create a published one.", - "type": "boolean", - "examples": [ - false - ] - }, - "prerelease": { - "description": "Whether to identify the release as a prerelease or a full release.", - "type": "boolean", - "examples": [ - false - ] - }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean", - "examples": [ - false - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "author": { - "$ref": "#/components/schemas/simple-user" - }, - "assets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/release-asset" - } - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "mentions_count": { - "type": "integer" - }, - "discussion_url": { - "description": "The URL of the release discussion.", - "type": "string", - "format": "uri" - }, - "reactions": { - "$ref": "#/components/schemas/reaction-rollup" - } - }, - "required": [ - "assets_url", - "upload_url", - "tarball_url", - "zipball_url", - "created_at", - "published_at", - "draft", - "id", - "node_id", - "author", - "html_url", - "name", - "prerelease", - "tag_name", - "target_commitish", - "assets", - "url" - ] - }, "event": { "title": "Event", "description": "Event", @@ -108190,56 +107644,47 @@ "$ref": "#/components/schemas/actor" }, "payload": { - "oneOf": [ - { - "$ref": "#/components/schemas/events/create-event" - }, - { - "$ref": "#/components/schemas/events/delete-event" - }, - { - "$ref": "#/components/schemas/events/discussion-event" - }, - { - "$ref": "#/components/schemas/events/issues-event" - }, - { - "$ref": "#/components/schemas/events/issue-comment-event" - }, - { - "$ref": "#/components/schemas/events/fork-event" - }, - { - "$ref": "#/components/schemas/events/gollum-event" - }, - { - "$ref": "#/components/schemas/events/member-event" - }, - { - "$ref": "#/components/schemas/events/public-event" - }, - { - "$ref": "#/components/schemas/events/push-event" - }, - { - "$ref": "#/components/schemas/events/pull-request-event" - }, - { - "$ref": "#/components/schemas/events/pull-request-review-comment-event" - }, - { - "$ref": "#/components/schemas/events/pull-request-review-event" + "type": "object", + "properties": { + "action": { + "type": "string" }, - { - "$ref": "#/components/schemas/events/commit-comment-event" + "issue": { + "$ref": "#/components/schemas/issue" }, - { - "$ref": "#/components/schemas/events/release-event" + "comment": { + "$ref": "#/components/schemas/issue-comment" }, - { - "$ref": "#/components/schemas/events/watch-event" + "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" @@ -110613,105 +110058,6 @@ "subscribed" ] }, - "organization-simple": { - "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" - ] - }, "dependabot-repository-access-details": { "title": "Dependabot Repository Access Details", "description": "Information about repositories that Dependabot is able to access in an organization", @@ -110748,6 +110094,40 @@ }, "additionalProperties": false }, + "custom-property-value": { + "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" + ] + }, "billing-premium-request-usage-report-org": { "type": "object", "properties": { @@ -110813,7 +110193,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -110821,7 +110201,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -110829,7 +110209,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -111522,6 +110902,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -111692,6 +111079,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -111704,6 +111095,128 @@ "platform" ] }, + "actions-hosted-runner-custom-image": { + "title": "GitHub-hosted runner custom image details", + "description": "Provides details of a custom 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": "integer", + "examples": [ + 1 + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "examples": [ + 200 + ] + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + "CustomImage" + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "examples": [ + "custom" + ] + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "examples": [ + 4 + ] + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "examples": [ + "1.3.0" + ] + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "examples": [ + "Ready" + ] + } + }, + "required": [ + "id", + "platform", + "name", + "source", + "versions_count", + "total_versions_size", + "latest_version", + "state" + ] + }, + "actions-hosted-runner-custom-image-version": { + "title": "GitHub-hosted runner custom image version details.", + "description": "Provides details of a hosted runner custom image version", + "type": "object", + "properties": { + "version": { + "description": "The version of image.", + "type": "string", + "examples": [ + "1.0.0" + ] + }, + "state": { + "description": "The state of image version.", + "type": "string", + "examples": [ + "Ready" + ] + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "examples": [ + 30 + ] + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "examples": [ + "2024-11-09T23:39:01Z" + ] + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "examples": [ + "None" + ] + } + }, + "required": [ + "version", + "state", + "size_gb", + "created_on", + "state_details" + ] + }, "actions-hosted-runner-curated-image": { "title": "GitHub-hosted runner image details.", "description": "Provides details of a hosted runner image", @@ -112449,6 +111962,15 @@ "closed" ] }, + "campaign-alert-type": { + "title": "Campaign alert type", + "description": "Indicates the alert type of a campaign", + "type": "string", + "enum": [ + "code_scanning", + "secret_scanning" + ] + }, "team-simple": { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", @@ -117390,40 +116912,6 @@ "value_type" ] }, - "custom-property-value": { - "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" - ] - }, "org-repo-custom-property-values": { "title": "Organization Repository Custom Property Values", "description": "List of custom property values for a repository", @@ -119923,6 +119411,578 @@ } ] }, + "secret-scanning-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" + ] + }, + "secret-scanning-alert-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 + ] + }, + "secret-scanning-location-commit": { + "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" + ] + }, + "secret-scanning-location-wiki-commit": { + "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" + ] + }, + "secret-scanning-location-issue-title": { + "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" + ] + }, + "secret-scanning-location-issue-body": { + "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" + ] + }, + "secret-scanning-location-issue-comment": { + "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" + ] + }, + "secret-scanning-location-discussion-title": { + "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" + ] + }, + "secret-scanning-location-discussion-body": { + "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" + ] + }, + "secret-scanning-location-discussion-comment": { + "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" + ] + }, + "secret-scanning-location-pull-request-title": { + "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" + ] + }, + "secret-scanning-location-pull-request-body": { + "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" + ] + }, + "secret-scanning-location-pull-request-comment": { + "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" + ] + }, + "secret-scanning-location-pull-request-review": { + "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" + ] + }, + "secret-scanning-location-pull-request-review-comment": { + "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" + ] + }, + "secret-scanning-first-detected-location": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "$ref": "#/components/schemas/secret-scanning-location-commit" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-issue-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-issue-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-issue-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" + } + ] + }, + "organization-secret-scanning-alert": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/alert-updated-at" + } + ] + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + }, + "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" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "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": { + "$ref": "#/components/schemas/simple-repository" + }, + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "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" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "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" + }, + { + "$ref": "#/components/schemas/secret-scanning-first-detected-location" + } + ] + }, + "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." + }, + "assigned_to": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + } + } + }, "secret-scanning-row-version": { "type": [ "string", @@ -123245,6 +123305,101 @@ "sha" ] }, + "pull-request-minimal": { + "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" + ] + }, "simple-commit": { "title": "Simple Commit", "description": "A commit.", @@ -132964,6 +133119,75 @@ } ] }, + "label": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "examples": [ + 208045946 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDU6TGFiZWwyMDgwNDU5NDY=" + ] + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/labels/bug" + ] + }, + "name": { + "description": "The name of the label.", + "type": "string", + "examples": [ + "bug" + ] + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": [ + "string", + "null" + ], + "examples": [ + "Something isn't working" + ] + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string", + "examples": [ + "FFFFFF" + ] + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + }, "timeline-comment-event": { "title": "Timeline Comment Event", "description": "Timeline Comment Event", @@ -135753,6 +135977,249 @@ "updated_at" ] }, + "release-asset": { + "title": "Release Asset", + "description": "Data related to a release.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "browser_download_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The file name of the asset.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "label": { + "type": [ + "string", + "null" + ] + }, + "state": { + "description": "State of the release asset.", + "type": "string", + "enum": [ + "uploaded", + "open" + ] + }, + "content_type": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "digest": { + "type": [ + "string", + "null" + ] + }, + "download_count": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "uploader": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + } + }, + "required": [ + "id", + "name", + "content_type", + "size", + "digest", + "state", + "url", + "node_id", + "download_count", + "label", + "uploader", + "browser_download_url", + "created_at", + "updated_at" + ] + }, + "release": { + "title": "Release", + "description": "A release.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "assets_url": { + "type": "string", + "format": "uri" + }, + "upload_url": { + "type": "string" + }, + "tarball_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "zipball_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "tag_name": { + "description": "The name of the tag.", + "type": "string", + "examples": [ + "v1.0.0" + ] + }, + "target_commitish": { + "description": "Specifies the commitish value that determines where the Git tag is created from.", + "type": "string", + "examples": [ + "master" + ] + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "draft": { + "description": "true to create a draft (unpublished) release, false to create a published one.", + "type": "boolean", + "examples": [ + false + ] + }, + "prerelease": { + "description": "Whether to identify the release as a prerelease or a full release.", + "type": "boolean", + "examples": [ + false + ] + }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "published_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "author": { + "$ref": "#/components/schemas/simple-user" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/release-asset" + } + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "mentions_count": { + "type": "integer" + }, + "discussion_url": { + "description": "The URL of the release discussion.", + "type": "string", + "format": "uri" + }, + "reactions": { + "$ref": "#/components/schemas/reaction-rollup" + } + }, + "required": [ + "assets_url", + "upload_url", + "tarball_url", + "zipball_url", + "created_at", + "published_at", + "draft", + "id", + "node_id", + "author", + "html_url", + "name", + "prerelease", + "tag_name", + "target_commitish", + "assets", + "url" + ] + }, "release-notes-content": { "title": "Generated Release Notes Content", "description": "Generated name and body describing a release", @@ -140006,7 +140473,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -140014,7 +140481,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -140022,7 +140489,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -142565,107 +143032,24 @@ "body" ] }, - "webhooks_comment": { + "discussion": { + "title": "Discussion", + "description": "A Discussion in a repository.", "type": "object", "properties": { - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "type": "string" - }, - "child_comment_count": { - "type": "integer" - }, - "created_at": { - "type": "string" - }, - "discussion_id": { - "type": "integer" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "parent_id": { + "active_lock_reason": { "type": [ - "integer", + "string", "null" ] }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "answer_chosen_at": { + "type": [ + "string", + "null" ] }, - "repository_url": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "user": { + "answer_chosen_by": { "title": "User", "type": [ "object", @@ -142709,8 +143093,7 @@ "format": "uri" }, "id": { - "type": "integer", - "format": "int64" + "type": "integer" }, "login": { "type": "string" @@ -142764,148 +143147,13 @@ "login", "id" ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "parent_id", - "child_comment_count", - "repository_url", - "discussion_id", - "author_association", - "user", - "created_at", - "updated_at", - "body", - "reactions" - ] - }, - "webhooks_label": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" }, - "default": { - "type": "boolean" - }, - "description": { + "answer_html_url": { "type": [ "string", "null" ] }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - }, - "webhooks_repositories": { - "description": "An array of repository objects that the installation can access.", - "type": "array", - "items": { - "type": "object", - "properties": { - "full_name": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "name", - "full_name", - "private" - ] - } - }, - "webhooks_repositories_added": { - "description": "An array of repository objects, which were added to the installation.", - "type": "array", - "items": { - "type": "object", - "properties": { - "full_name": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "name", - "full_name", - "private" - ] - } - }, - "webhooks_repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "webhooks_issue_comment": { - "title": "issue comment", - "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.", - "type": "object", - "properties": { "author_association": { "title": "AuthorAssociation", "description": "How the author is associated with the repository.", @@ -142922,31 +143170,679 @@ ] }, "body": { - "description": "Contents of the issue comment", "type": "string" }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, "created_at": { "type": "string", "format": "date-time" }, "html_url": { - "type": "string", - "format": "uri" + "type": "string" }, "id": { - "description": "Unique identifier of the issue comment", - "type": "integer", - "format": "int64" + "type": "integer" }, - "issue_url": { - "type": "string", - "format": "uri" + "locked": { + "type": "boolean" }, "node_id": { "type": "string" }, - "performed_via_github_app": { - "$ref": "#/components/schemas/integration" + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "description": "The current state of the discussion.\n`converting` means that the discussion is being converted from an issue.\n`transferring` means that the discussion is being transferred from another repository.", + "enum": [ + "open", + "closed", + "locked", + "converting", + "transferring" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "outdated", + "duplicate", + "reopened", + null + ], + "examples": [ + "resolved" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "labels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/label" + } + } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "state_reason", + "locked", + "comments", + "created_at", + "updated_at", + "author_association", + "active_lock_reason", + "body" + ] + }, + "webhooks_comment": { + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "type": "string" + }, + "child_comment_count": { + "type": "integer" + }, + "created_at": { + "type": "string" + }, + "discussion_id": { + "type": "integer" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "parent_id": { + "type": [ + "integer", + "null" + ] + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "parent_id", + "child_comment_count", + "repository_url", + "discussion_id", + "author_association", + "user", + "created_at", + "updated_at", + "body", + "reactions" + ] + }, + "webhooks_label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, + "webhooks_repositories": { + "description": "An array of repository objects that the installation can access.", + "type": "array", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private" + ] + } + }, + "webhooks_repositories_added": { + "description": "An array of repository objects, which were added to the installation.", + "type": "array", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private" + ] + } + }, + "webhooks_repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "webhooks_issue_comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.", + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/integration" }, "reactions": { "title": "Reactions", @@ -284202,1060 +285098,6 @@ "workflow", "workflow_run" ] - }, - "create-event": { - "title": "CreateEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "full_ref": { - "type": "string" - }, - "master_branch": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "full_ref", - "master_branch", - "pusher_type" - ] - }, - "delete-event": { - "title": "DeleteEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "full_ref": { - "type": "string" - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "full_ref", - "pusher_type" - ] - }, - "discussion-event": { - "title": "DiscussionEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "discussion": { - "$ref": "#/components/schemas/discussion" - } - }, - "required": [ - "action", - "discussion" - ] - }, - "issues-event": { - "title": "IssuesEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "$ref": "#/components/schemas/issue" - }, - "assignee": { - "$ref": "#/components/schemas/simple-user" - }, - "assignees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/simple-user" - } - }, - "label": { - "$ref": "#/components/schemas/label" - }, - "labels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/label" - } - } - }, - "required": [ - "action", - "issue" - ] - }, - "issue-comment-event": { - "title": "IssueCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "$ref": "#/components/schemas/issue" - }, - "comment": { - "$ref": "#/components/schemas/issue-comment" - } - }, - "required": [ - "action", - "issue", - "comment" - ] - }, - "fork-event": { - "title": "ForkEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "forkee": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "private": { - "type": "boolean" - }, - "owner": { - "$ref": "#/components/schemas/simple-user" - }, - "html_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "git_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "forks_count": { - "type": "integer" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "open_issues_count": { - "type": "integer" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/license-simple" - } - ] - }, - "allow_forking": { - "type": "boolean" - }, - "is_template": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "visibility": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "public": { - "type": "boolean" - } - } - } - }, - "required": [ - "action", - "forkee" - ] - }, - "gollum-event": { - "title": "GollumEvent", - "type": "object", - "properties": { - "pages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "page_name": { - "type": [ - "string", - "null" - ] - }, - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "action": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } - } - } - }, - "required": [ - "pages" - ] - }, - "member-event": { - "title": "MemberEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "member": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "member" - ] - }, - "public-event": { - "title": "PublicEvent", - "type": "object" - }, - "push-event": { - "title": "PushEvent", - "type": "object", - "properties": { - "repository_id": { - "type": "integer" - }, - "push_id": { - "type": "integer" - }, - "ref": { - "type": "string" - }, - "head": { - "type": "string" - }, - "before": { - "type": "string" - } - }, - "required": [ - "repository_id", - "push_id", - "ref", - "head", - "before" - ] - }, - "pull-request-event": { - "title": "PullRequestEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "pull_request": { - "$ref": "#/components/schemas/pull-request-minimal" - }, - "assignee": { - "$ref": "#/components/schemas/simple-user" - }, - "assignees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/simple-user" - } - }, - "label": { - "$ref": "#/components/schemas/label" - }, - "labels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/label" - } - } - }, - "required": [ - "action", - "number", - "pull_request" - ] - }, - "pull-request-review-comment-event": { - "title": "PullRequestReviewCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "pull_request": { - "$ref": "#/components/schemas/pull-request-minimal" - }, - "comment": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "pull_request_review_id": { - "type": [ - "integer", - "null" - ] - }, - "diff_hunk": { - "type": "string" - }, - "path": { - "type": "string" - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "original_position": { - "type": "integer" - }, - "subject_type": { - "type": [ - "string", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - } - }, - "body": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "original_commit_id": { - "type": "string" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "in_reply_to_id": { - "type": "integer" - } - }, - "required": [ - "url", - "pull_request_review_id", - "id", - "node_id", - "diff_hunk", - "path", - "position", - "original_position", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "_links", - "reactions" - ] - } - }, - "required": [ - "action", - "comment", - "pull_request" - ] - }, - "pull-request-review-event": { - "title": "PullRequestReviewEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "review": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "body": { - "type": "string" - }, - "commit_id": { - "type": "string" - }, - "submitted_at": { - "type": [ - "string", - "null" - ] - }, - "state": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "html", - "pull_request" - ] - }, - "updated_at": { - "type": "string" - } - } - }, - "pull_request": { - "$ref": "#/components/schemas/pull-request-minimal" - } - }, - "required": [ - "action", - "review", - "pull_request" - ] - }, - "commit-comment-event": { - "title": "CommitCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "comment": { - "type": "object", - "properties": { - "html_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "body": { - "type": "string" - }, - "path": { - "type": [ - "string", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "reactions": { - "$ref": "#/components/schemas/reaction-rollup" - } - } - } - }, - "required": [ - "action", - "comment" - ] - }, - "release-event": { - "title": "ReleaseEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "release": { - "allOf": [ - { - "$ref": "#/components/schemas/release" - }, - { - "type": "object", - "properties": { - "is_short_description_html_truncated": { - "type": "boolean" - }, - "short_description_html": { - "type": "string" - } - } - } - ] - } - }, - "required": [ - "action", - "release" - ] - }, - "watch-event": { - "title": "WatchEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - } - }, - "required": [ - "action" - ] } }, "examples": { @@ -288819,192 +288661,6 @@ } ] }, - "organization-secret-scanning-alert-list": { - "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 - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://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" - }, - "has_more_locations": true, - "assigned_to": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - ] - }, "enterprise-teams-items": { "value": [ { @@ -289067,6 +288723,40 @@ "site_admin": false } }, + "organization-simple": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + }, + "organization-simple-items": { + "value": [ + { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + ] + }, "public-events-items": { "value": [ { @@ -290587,24 +290277,6 @@ "octocat": { "value": " MMM. .MMM\n MMMMMMMMMMMMMMMMMMM\n MMMMMMMMMMMMMMMMMMM ___________________________________\n MMMMMMMMMMMMMMMMMMMMM | |\n MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. |\n MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________|\n MMMM::- -:::::::- -::MMMM |/\n MM~:~ 00~:::::~ 00~:~MM\n .. MMMMM::.00:::+:::.00::MMMMM ..\n .MM::::: ._. :::::MM.\n MMMM;:::::;MMMM\n -MM MMMMMMM\n ^ M+ MMMMMMMMM\n MMMMMMM MM MM MM\n MM MM MM MM\n MM MM MM MM\n .~~MM~MM~MM~MM~~.\n ~~~~MM:~MM~~~MM~:MM~~~~\n ~~~~~~==~==~~~==~==~~~~~~\n ~~~~~~==~==~==~==~~~~~~\n :~==~==~==~==~~\n" }, - "organization-simple-items": { - "value": [ - { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - } - ] - }, "dependabot-repository-access-details": { "value": { "default_level": "public", @@ -290683,6 +290355,40 @@ ] } }, + "custom-property-values": { + "value": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + }, + "create-or-update-custom-properties-values": { + "value": { + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + }, "billing-premium-request-usage-report-org": { "value": { "timePeriod": { @@ -290908,6 +290614,45 @@ "last_active_on": "2022-10-09T23:39:01Z" } }, + "actions-hosted-runner-custom-image-versions": { + "value": { + "total_count": 2, + "image_versions": [ + { + "version": "1.1.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-09T23:39:01Z" + }, + { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + ] + } + }, + "actions-hosted-runner-custom-image": { + "value": { + "id": 1, + "platform": "linux-x64", + "name": "CustomImage", + "source": "custom", + "versions_count": 4, + "total_versions_size": 200, + "latest_version": "1.3.0", + "state": "Ready" + } + }, + "actions-hosted-runner-custom-image-version": { + "value": { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + }, "actions-hosted-runner-curated-image": { "value": { "id": "ubuntu-20.04", @@ -291971,6 +291716,18 @@ ] } }, + "list-attestation-repositories": { + "value": [ + { + "id": 123, + "name": "foo" + }, + { + "id": 456, + "name": "bar" + } + ] + }, "list-attestations": { "value": { "attestations": [ @@ -296857,6 +296614,192 @@ } ] }, + "organization-secret-scanning-alert-list": { + "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 + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://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" + }, + "has_more_locations": true, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + }, "secret-scanning-pattern-configuration": { "value": { "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", @@ -308305,40 +308248,6 @@ } ] }, - "custom-property-values": { - "value": [ - { - "property_name": "environment", - "value": "production" - }, - { - "property_name": "service", - "value": "web" - }, - { - "property_name": "team", - "value": "octocat" - } - ] - }, - "create-or-update-custom-properties-values": { - "value": { - "properties": [ - { - "property_name": "environment", - "value": "production" - }, - { - "property_name": "service", - "value": "web" - }, - { - "property_name": "team", - "value": "octocat" - } - ] - } - }, "pull-request": { "value": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -318019,113 +317928,6 @@ "default": "created" } }, - "pagination-first": { - "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 - } - }, - "pagination-last": { - "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 - } - }, - "secret-scanning-alert-state": { - "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" - ] - } - }, - "secret-scanning-alert-secret-type": { - "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" - } - }, - "secret-scanning-alert-resolution": { - "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" - } - }, - "secret-scanning-alert-sort": { - "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" - } - }, - "secret-scanning-alert-validity": { - "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" - } - }, - "secret-scanning-alert-publicly-leaked": { - "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 - } - }, - "secret-scanning-alert-multi-repo": { - "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 - } - }, - "secret-scanning-alert-hide-secret": { - "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 - } - }, "enterprise-team": { "name": "enterprise-team", "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", @@ -318144,6 +317946,15 @@ "type": "string" } }, + "org": { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "team-slug": { "name": "team_slug", "description": "The slug of the team name.", @@ -318288,15 +318099,6 @@ "type": "integer" } }, - "org": { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, "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.", @@ -318369,6 +318171,25 @@ "type": "integer" } }, + "actions-custom-image-definition-id": { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "actions-custom-image-version": { + "name": "version", + "description": "Version of a custom image", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+$" + } + }, "hosted-runner-id": { "name": "hosted_runner_id", "description": "Unique identifier of the GitHub-hosted runner.", @@ -318966,6 +318787,51 @@ "type": "integer" } }, + "secret-scanning-alert-state": { + "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" + ] + } + }, + "secret-scanning-alert-secret-type": { + "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" + } + }, + "secret-scanning-alert-resolution": { + "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" + } + }, + "secret-scanning-alert-sort": { + "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" + } + }, "secret-scanning-pagination-before-org-repo": { "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.", @@ -318984,6 +318850,45 @@ "type": "string" } }, + "secret-scanning-alert-validity": { + "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" + } + }, + "secret-scanning-alert-publicly-leaked": { + "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 + } + }, + "secret-scanning-alert-multi-repo": { + "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 + } + }, + "secret-scanning-alert-hide-secret": { + "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 + } + }, "network-configuration-id": { "name": "network_configuration_id", "description": "Unique identifier of the hosted compute network configuration.", 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 5a3328d6f..a5e785bdd 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 @@ -91,6 +91,8 @@ tags: description: Endpoints to manage GitHub Enterprise Teams. - name: enterprise-team-memberships description: Endpoints to manage GitHub Enterprise Team memberships. +- name: enterprise-team-organizations + description: Endpoints to manage GitHub Enterprise Team organization assignments. - name: code-security description: Endpoints to manage Code security using the REST API. - name: private-registries @@ -2302,8 +2304,6 @@ paths: - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" - "$ref": "#/components/parameters/per-page" responses: '200': @@ -2331,61 +2331,6 @@ paths: previews: [] category: dependabot subcategory: alerts - "/enterprises/{enterprise}/secret-scanning/alerts": - get: - summary: List secret scanning alerts for an enterprise - description: |- - Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - - Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). - - The authenticated user must be a member of the enterprise in order to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. - tags: - - secret-scanning - operationId: secret-scanning/list-alerts-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise - parameters: - - "$ref": "#/components/parameters/enterprise" - - "$ref": "#/components/parameters/secret-scanning-alert-state" - - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - - "$ref": "#/components/parameters/secret-scanning-alert-resolution" - - "$ref": "#/components/parameters/secret-scanning-alert-sort" - - "$ref": "#/components/parameters/direction" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/pagination-before" - - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/secret-scanning-alert-validity" - - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" - - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/organization-secret-scanning-alert" - examples: - default: - "$ref": "#/components/examples/organization-secret-scanning-alert-list" - headers: - Link: - "$ref": "#/components/headers/link" - '404': - "$ref": "#/components/responses/not_found" - '503': - "$ref": "#/components/responses/service_unavailable" - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: secret-scanning - subcategory: secret-scanning "/enterprises/{enterprise}/teams": get: summary: List enterprise teams @@ -2459,6 +2404,18 @@ paths: - all - disabled default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled group_id: type: - string @@ -2706,6 +2663,209 @@ paths: enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-members + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": + get: + summary: Get organization assignments + description: Get all organizations assigned to an enterprise team + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignments + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: An array of organizations the team is assigned to + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": + post: + summary: Add organization assignments + description: Assign an enterprise team to multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to assign the team to. + items: + type: string + description: Organization slug to assign the team to + examples: + default: + value: + organization_slugs: + - github + responses: + '200': + description: Successfully assigned the enterprise team to organizations. + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": + post: + summary: Remove organization assignments + description: Unassign an enterprise team from multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-remove + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to unassign the team from. + items: + type: string + description: Organization slug to unassign the team from + examples: + default: + value: + organization_slugs: + - github + responses: + '204': + description: Successfully unassigned the enterprise team from organizations. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": + get: + summary: Get organization assignment + description: Check if an enterprise team is assigned to an organization + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '200': + description: The team is assigned to the organization + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + '404': + description: The team is not assigned to the organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + put: + summary: Add an organization assignment + description: Assign an enterprise team to an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '201': + description: Successfully assigned the enterprise team to the organization. + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + delete: + summary: Delete an organization assignment + description: Unassign an enterprise team from an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/delete + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Successfully unassigned the enterprise team from the organization. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations "/enterprises/{enterprise}/teams/{team_slug}": get: summary: Get an enterprise team @@ -2781,6 +2941,18 @@ paths: - all - disabled default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled group_id: type: - string @@ -5136,12 +5308,107 @@ paths: enabledForGitHubApps: true category: dependabot subcategory: repository-access + "/organizations/{org}/org-properties/values": + get: + summary: Get all custom property values for an organization + description: |- + Gets all custom property values that are set for an organization. + + The organization must belong to an enterprise. + + Access requirements: + - Organization admins + - OAuth tokens and personal access tokens (classic) with the `read:org` scope + - Actors with the organization-level "read custom properties for an organization" fine-grained permission or above + tags: + - orgs + operationId: orgs/custom-properties-for-orgs-get-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/custom-property-value" + examples: + default: + "$ref": "#/components/examples/custom-property-values" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties-for-orgs + patch: + summary: Create or update custom property values for an organization + description: |- + Create new or update existing custom property values for an organization. + To remove a custom property value from an organization, set the property value to `null`. + + The organization must belong to an enterprise. + + Access requirements: + - Organization admins + - OAuth tokens and personal access tokens (classic) with the `admin:org` scope + - Actors with the organization-level "edit custom properties for an organization" fine-grained permission + tags: + - orgs + operationId: orgs/custom-properties-for-orgs-create-or-update-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: A list of custom property names and associated values + to apply to the organization. + items: + "$ref": "#/components/schemas/custom-property-value" + required: + - properties + examples: + default: + "$ref": "#/components/examples/create-or-update-custom-properties-values" + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties-for-orgs "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization - description: Gets a report of premium request usage for an organization. To - use this endpoint, you must be an administrator of an organization within - an enterprise or an organization account. + description: |- + Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-org @@ -5701,6 +5968,12 @@ paths: - github - partner - custom + version: + description: The version of the runner image to deploy. This + is relevant only for runners using custom images. + type: + - string + - 'null' size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -5718,6 +5991,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_gen: + description: Whether this runner should be used to generate custom + images. + type: boolean + default: false required: - name - image @@ -5749,6 +6027,197 @@ paths: githubCloudOnly: false category: actions subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom": + get: + summary: List custom images for an organization + description: |- + List custom images for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-images-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": + get: + summary: Get a custom image definition for GitHub Actions Hosted Runners + description: |- + Get a custom image definition for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete a custom image from the organization + description: |- + Delete a custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": + get: + summary: List image versions of a custom image for an organization + description: |- + List image versions of a custom image for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-image-versions-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization + parameters: + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - image_versions + properties: + total_count: + type: integer + image_versions: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": + get: + summary: Get an image version of a custom image for GitHub Actions Hosted Runners + description: |- + Get an image version of a custom image for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-version-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/actions-custom-image-version" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-version" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete an image version of custom image from the organization + description: |- + Delete an image version of custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-version-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/actions-custom-image-version" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/images/github-owned": get: summary: Get GitHub-owned images for GitHub-hosted runners in an organization @@ -6005,6 +6474,12 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_version: + description: The version of the runner image to deploy. This is + relevant only for runners using custom images. + type: + - string + - 'null' examples: default: value: @@ -9055,7 +9530,8 @@ paths: type: string description: |- Optional filter for fetching attestations with a given predicate type. - This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. required: - subject_digests examples: @@ -9221,6 +9697,54 @@ paths: enabledForGitHubApps: true category: orgs subcategory: attestations + "/orgs/{org}/attestations/repositories": + get: + summary: List attestation repositories + description: |- + List repositories owned by the provided organization that have created at least one attested artifact + Results will be sorted in ascending order by repository ID + tags: + - orgs + operationId: orgs/list-attestation-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#list-attestation-repositories + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/org" + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + examples: + default: + "$ref": "#/components/examples/list-attestation-repositories" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations "/orgs/{org}/attestations/{attestation_id}": delete: summary: Delete attestations by ID @@ -9285,7 +9809,8 @@ paths: - name: predicate_type description: |- Optional filter for fetching attestations with a given predicate type. - This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. in: query required: false schema: @@ -9563,7 +10088,9 @@ paths: format: uri code_scanning_alerts: description: The code scanning alerts to include in this campaign - type: array + type: + - array + - 'null' minItems: 1 items: type: object @@ -9590,7 +10117,11 @@ paths: - name - description - ends_at - - code_scanning_alerts + oneOf: + - required: + - code_scanning_alerts + - required: + - secret_scanning_alerts examples: default: value: @@ -11974,8 +12505,6 @@ paths: - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" - "$ref": "#/components/parameters/per-page" responses: '200': @@ -16692,17 +17221,19 @@ paths: schema: type: string - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/per-page" @@ -16814,17 +17345,19 @@ paths: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/item-id" - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -25403,7 +25936,8 @@ paths: - name: predicate_type description: |- Optional filter for fetching attestations with a given predicate type. - This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. in: query required: false schema: @@ -32333,14 +32867,6 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" - - name: page - description: "**Closing down notice**. Page number of the results to fetch. - Use cursor-based pagination with `before` or `after` instead." - deprecated: true - 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)." @@ -32351,8 +32877,6 @@ paths: default: 30 - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" responses: '200': description: Response @@ -44635,6 +45159,9 @@ paths: description: |- Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + > [!NOTE] + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + OAuth 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: - secret-scanning @@ -53151,7 +53678,8 @@ paths: type: string description: |- Optional filter for fetching attestations with a given predicate type. - This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. required: - subject_digests examples: @@ -53380,7 +53908,8 @@ paths: - name: predicate_type description: |- Optional filter for fetching attestations with a given predicate type. - This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. in: query required: false schema: @@ -54458,17 +54987,19 @@ paths: schema: type: string - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -54576,17 +55107,19 @@ paths: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/item-id" - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -54950,7 +55483,10 @@ paths: "/users/{username}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for a user - description: Gets a report of premium request usage for a user. + description: |- + Gets a report of premium request usage for a user. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-user @@ -73832,6 +74368,13 @@ components: GitHub Actions workflow files. enum: - write + custom_properties_for_organizations: + type: string + description: The level of permission to grant the access token to view and + edit custom properties for an organization, when allowed by the property. + enum: + - read + - write members: type: string description: The level of permission to grant the access token for organization @@ -74008,6 +74551,14 @@ components: enum: - read - write + enterprise_custom_properties_for_organizations: + type: string + description: The level of permission to grant the access token for organization + custom properties management at the enterprise level. + enum: + - read + - write + - admin example: contents: read issues: read @@ -76466,424 +77017,6 @@ components: - fixed_at - repository additionalProperties: false - secret-scanning-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 - secret-scanning-alert-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 - - - secret-scanning-location-commit: - 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 - secret-scanning-location-wiki-commit: - 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 - secret-scanning-location-issue-title: - 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 - secret-scanning-location-issue-body: - 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 - secret-scanning-location-issue-comment: - 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 - secret-scanning-location-discussion-title: - 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 - secret-scanning-location-discussion-body: - 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 - secret-scanning-location-discussion-comment: - 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 - secret-scanning-location-pull-request-title: - 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 - secret-scanning-location-pull-request-body: - 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 - secret-scanning-location-pull-request-comment: - 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 - secret-scanning-location-pull-request-review: - 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 - secret-scanning-location-pull-request-review-comment: - 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 - secret-scanning-first-detected-location: - description: 'Details on the location where the token was initially detected. - This can be a commit, wiki commit, issue, discussion, pull request. - - ' - oneOf: - - "$ref": "#/components/schemas/secret-scanning-location-commit" - - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" - - "$ref": "#/components/schemas/secret-scanning-location-issue-title" - - "$ref": "#/components/schemas/secret-scanning-location-issue-body" - - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" - - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" - - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" - - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" - - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" - - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" - - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" - - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" - - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" - organization-secret-scanning-alert: - type: object - properties: - number: - "$ref": "#/components/schemas/alert-number" - created_at: - "$ref": "#/components/schemas/alert-created-at" - updated_at: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/alert-updated-at" - url: - "$ref": "#/components/schemas/alert-url" - html_url: - "$ref": "#/components/schemas/alert-html-url" - locations_url: - type: string - format: uri - description: The REST API URL of the code locations for this alert. - state: - "$ref": "#/components/schemas/secret-scanning-alert-state" - resolution: - "$ref": "#/components/schemas/secret-scanning-alert-resolution" - 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' - - "$ref": "#/components/schemas/simple-user" - 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`. - For 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: - "$ref": "#/components/schemas/simple-repository" - push_protection_bypassed: - type: - - boolean - - 'null' - description: Whether push protection was bypassed for the detected secret. - push_protection_bypassed_by: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - 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' - - "$ref": "#/components/schemas/simple-user" - 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' - - "$ref": "#/components/schemas/secret-scanning-first-detected-location" - 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. - assigned_to: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" enterprise-team: title: Enterprise Team description: Group of enterprise owners and/or members @@ -76948,404 +77081,104 @@ components: - created_at - updated_at - group_id - actor: - title: Actor - description: Actor + organization-simple: + title: Organization Simple + description: A GitHub organization. type: object properties: - id: - type: integer login: type: string - display_login: + examples: + - github + id: + type: integer + examples: + - 1 + node_id: type: string - gravatar_id: - type: - - string - - 'null' + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= url: type: string format: uri - avatar_url: + examples: + - https://api.github.com/orgs/github + repos_url: type: string format: uri - required: - - id - - login - - gravatar_id - - url - - avatar_url - label: - title: Label - description: Color-coded labels help you categorize and filter your issues (just - like labels in Gmail). - type: object - properties: - id: - description: Unique identifier for the label. - type: integer - format: int64 examples: - - 208045946 - node_id: + - https://api.github.com/orgs/github/repos + events_url: type: string + format: uri examples: - - MDU6TGFiZWwyMDgwNDU5NDY= - url: - description: URL for the label + - https://api.github.com/orgs/github/events + hooks_url: type: string - format: uri examples: - - https://api.github.com/repositories/42/labels/bug - name: - description: The name of the label. + - https://api.github.com/orgs/github/hooks + issues_url: type: string examples: - - bug + - 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: - description: Optional description of the label, such as its purpose. type: - string - 'null' examples: - - Something isn't working - color: - description: '6-character hex code, without the leading #, identifying the - color' - type: string - examples: - - FFFFFF - default: - description: Whether this label comes by default in a new repository. - type: boolean - examples: - - true + - A great organization required: + - login + - url - id - node_id - - url - - name + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url - description - - color - - default - discussion: - title: Discussion - description: A Discussion in a repository. + actor: + title: Actor + description: Actor type: object properties: - active_lock_reason: - type: - - string - - 'null' - answer_chosen_at: - type: - - string - - 'null' - answer_chosen_by: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - answer_html_url: - type: - - string - - 'null' - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - type: string - category: - type: object - properties: - created_at: - type: string - format: date-time - description: - type: string - emoji: - type: string - id: - type: integer - is_answerable: - type: boolean - name: - type: string - node_id: - type: string - repository_id: - type: integer - slug: - type: string - updated_at: - type: string - required: - - id - - repository_id - - emoji - - name - - description - - created_at - - updated_at - - slug - - is_answerable - comments: - type: integer - created_at: - type: string - format: date-time - html_url: - type: string id: type: integer - locked: - type: boolean - node_id: - type: string - number: - type: integer - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: + login: type: string - state: + display_login: type: string - description: |- - The current state of the discussion. - `converting` means that the discussion is being converted from an issue. - `transferring` means that the discussion is being transferred from another repository. - enum: - - open - - closed - - locked - - converting - - transferring - state_reason: - description: The reason for the current state + gravatar_id: type: - string - 'null' - enum: - - resolved - - outdated - - duplicate - - reopened - - - examples: - - resolved - timeline_url: - type: string - title: + url: type: string - updated_at: + format: uri + avatar_url: type: string - format: date-time - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - labels: - type: array - items: - "$ref": "#/components/schemas/label" + format: uri required: - - repository_url - - category - - answer_html_url - - answer_chosen_at - - answer_chosen_by - - html_url - id - - node_id - - number - - title - - user - - state - - state_reason - - locked - - comments - - created_at - - updated_at - - active_lock_reason - - body + - login + - gravatar_id + - url + - avatar_url milestone: title: Milestone description: A collection of related issues and pull requests. @@ -77953,256 +77786,11 @@ components: - node_id - html_url - issue_url + - author_association - user - url - created_at - updated_at - pull-request-minimal: - 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 - release-asset: - title: Release Asset - description: Data related to a release. - type: object - properties: - url: - type: string - format: uri - browser_download_url: - type: string - format: uri - id: - type: integer - node_id: - type: string - name: - description: The file name of the asset. - type: string - examples: - - Team Environment - label: - type: - - string - - 'null' - state: - description: State of the release asset. - type: string - enum: - - uploaded - - open - content_type: - type: string - size: - type: integer - digest: - type: - - string - - 'null' - download_count: - type: integer - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - uploader: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - required: - - id - - name - - content_type - - size - - digest - - state - - url - - node_id - - download_count - - label - - uploader - - browser_download_url - - created_at - - updated_at - release: - title: Release - description: A release. - type: object - properties: - url: - type: string - format: uri - html_url: - type: string - format: uri - assets_url: - type: string - format: uri - upload_url: - type: string - tarball_url: - type: - - string - - 'null' - format: uri - zipball_url: - type: - - string - - 'null' - format: uri - id: - type: integer - node_id: - type: string - tag_name: - description: The name of the tag. - type: string - examples: - - v1.0.0 - target_commitish: - description: Specifies the commitish value that determines where the Git - tag is created from. - type: string - examples: - - master - name: - type: - - string - - 'null' - body: - type: - - string - - 'null' - draft: - description: true to create a draft (unpublished) release, false to create - a published one. - type: boolean - examples: - - false - prerelease: - description: Whether to identify the release as a prerelease or a full release. - type: boolean - examples: - - false - immutable: - description: Whether or not the release is immutable. - type: boolean - examples: - - false - created_at: - type: string - format: date-time - published_at: - type: - - string - - 'null' - format: date-time - updated_at: - type: - - string - - 'null' - format: date-time - author: - "$ref": "#/components/schemas/simple-user" - assets: - type: array - items: - "$ref": "#/components/schemas/release-asset" - body_html: - type: string - body_text: - type: string - mentions_count: - type: integer - discussion_url: - description: The URL of the release discussion. - type: string - format: uri - reactions: - "$ref": "#/components/schemas/reaction-rollup" - required: - - assets_url - - upload_url - - tarball_url - - zipball_url - - created_at - - published_at - - draft - - id - - node_id - - author - - html_url - - name - - prerelease - - tag_name - - target_commitish - - assets - - url event: title: Event description: Event @@ -78233,23 +77821,33 @@ components: org: "$ref": "#/components/schemas/actor" payload: - oneOf: - - "$ref": "#/components/schemas/events/create-event" - - "$ref": "#/components/schemas/events/delete-event" - - "$ref": "#/components/schemas/events/discussion-event" - - "$ref": "#/components/schemas/events/issues-event" - - "$ref": "#/components/schemas/events/issue-comment-event" - - "$ref": "#/components/schemas/events/fork-event" - - "$ref": "#/components/schemas/events/gollum-event" - - "$ref": "#/components/schemas/events/member-event" - - "$ref": "#/components/schemas/events/public-event" - - "$ref": "#/components/schemas/events/push-event" - - "$ref": "#/components/schemas/events/pull-request-event" - - "$ref": "#/components/schemas/events/pull-request-review-comment-event" - - "$ref": "#/components/schemas/events/pull-request-review-event" - - "$ref": "#/components/schemas/events/commit-comment-event" - - "$ref": "#/components/schemas/events/release-event" - - "$ref": "#/components/schemas/events/watch-event" + type: object + properties: + action: + type: string + issue: + "$ref": "#/components/schemas/issue" + comment: + "$ref": "#/components/schemas/issue-comment" + 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: @@ -79957,77 +79555,6 @@ components: - reason - url - subscribed - organization-simple: - 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 dependabot-repository-access-details: title: Dependabot Repository Access Details description: Information about repositories that Dependabot is able to access @@ -80052,6 +79579,28 @@ components: - type: 'null' - "$ref": "#/components/schemas/simple-repository" additionalProperties: false + custom-property-value: + 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 billing-premium-request-usage-report-org: type: object properties: @@ -80102,19 +79651,19 @@ components: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -80647,6 +80196,11 @@ components: - github - partner - custom + version: + description: The image version of the hosted runner pool. + type: string + examples: + - latest required: - id - size_gb @@ -80771,6 +80325,9 @@ components: format: date-time examples: - '2022-10-09T23:39:01Z' + image_gen: + type: boolean + description: Whether custom image generation is enabled for the hosted runners. required: - id - name @@ -80779,6 +80336,97 @@ components: - status - public_ip_enabled - platform + actions-hosted-runner-custom-image: + title: GitHub-hosted runner custom image details + description: Provides details of a custom 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: integer + examples: + - 1 + platform: + description: The operating system of the image. + type: string + examples: + - linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + examples: + - 200 + name: + description: Display name for this image. + type: string + examples: + - CustomImage + source: + description: The image provider. + type: string + examples: + - custom + versions_count: + description: The number of image versions associated with the image. + type: integer + examples: + - 4 + latest_version: + description: The latest image version associated with the image. + type: string + examples: + - 1.3.0 + state: + description: The number of image versions associated with the image. + type: string + examples: + - Ready + required: + - id + - platform + - name + - source + - versions_count + - total_versions_size + - latest_version + - state + actions-hosted-runner-custom-image-version: + title: GitHub-hosted runner custom image version details. + description: Provides details of a hosted runner custom image version + type: object + properties: + version: + description: The version of image. + type: string + examples: + - 1.0.0 + state: + description: The state of image version. + type: string + examples: + - Ready + size_gb: + description: Image version size in GB. + type: integer + examples: + - 30 + created_on: + description: The creation date time of the image version. + type: string + examples: + - '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + examples: + - None + required: + - version + - state + - size_gb + - created_on + - state_details actions-hosted-runner-curated-image: title: GitHub-hosted runner image details. description: Provides details of a hosted runner image @@ -81357,6 +81005,13 @@ components: enum: - open - closed + campaign-alert-type: + title: Campaign alert type + description: Indicates the alert type of a campaign + type: string + enum: + - code_scanning + - secret_scanning team-simple: title: Team Simple description: Groups of organization members that gives permissions on specified @@ -85089,28 +84744,6 @@ components: - org_actors required: - value_type - custom-property-value: - 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 org-repo-custom-property-values: title: Organization Repository Custom Property Values description: List of custom property values for a repository @@ -86946,6 +86579,424 @@ components: state: type: object description: The state of the ruleset version + secret-scanning-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 + secret-scanning-alert-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 + - + secret-scanning-location-commit: + 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 + secret-scanning-location-wiki-commit: + 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 + secret-scanning-location-issue-title: + 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 + secret-scanning-location-issue-body: + 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 + secret-scanning-location-issue-comment: + 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 + secret-scanning-location-discussion-title: + 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 + secret-scanning-location-discussion-body: + 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 + secret-scanning-location-discussion-comment: + 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 + secret-scanning-location-pull-request-title: + 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 + secret-scanning-location-pull-request-body: + 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 + secret-scanning-location-pull-request-comment: + 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 + secret-scanning-location-pull-request-review: + 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 + secret-scanning-location-pull-request-review-comment: + 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 + secret-scanning-first-detected-location: + description: 'Details on the location where the token was initially detected. + This can be a commit, wiki commit, issue, discussion, pull request. + + ' + oneOf: + - "$ref": "#/components/schemas/secret-scanning-location-commit" + - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + - "$ref": "#/components/schemas/secret-scanning-location-issue-title" + - "$ref": "#/components/schemas/secret-scanning-location-issue-body" + - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" + organization-secret-scanning-alert: + type: object + properties: + number: + "$ref": "#/components/schemas/alert-number" + created_at: + "$ref": "#/components/schemas/alert-created-at" + updated_at: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/alert-updated-at" + url: + "$ref": "#/components/schemas/alert-url" + html_url: + "$ref": "#/components/schemas/alert-html-url" + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: + "$ref": "#/components/schemas/secret-scanning-alert-state" + resolution: + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + 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' + - "$ref": "#/components/schemas/simple-user" + 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`. + For 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: + "$ref": "#/components/schemas/simple-repository" + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + 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' + - "$ref": "#/components/schemas/simple-user" + 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' + - "$ref": "#/components/schemas/secret-scanning-first-detected-location" + 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. + assigned_to: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" secret-scanning-row-version: type: - string @@ -89390,6 +89441,73 @@ components: required: - path - sha + pull-request-minimal: + 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 simple-commit: title: Simple Commit description: A commit. @@ -96358,6 +96476,59 @@ components: - "$ref": "#/components/schemas/moved-column-in-project-issue-event" - "$ref": "#/components/schemas/removed-from-project-issue-event" - "$ref": "#/components/schemas/converted-note-to-issue-issue-event" + label: + title: Label + description: Color-coded labels help you categorize and filter your issues (just + like labels in Gmail). + type: object + properties: + id: + description: Unique identifier for the label. + type: integer + format: int64 + examples: + - 208045946 + node_id: + type: string + examples: + - MDU6TGFiZWwyMDgwNDU5NDY= + url: + description: URL for the label + type: string + format: uri + examples: + - https://api.github.com/repositories/42/labels/bug + name: + description: The name of the label. + type: string + examples: + - bug + description: + description: Optional description of the label, such as its purpose. + type: + - string + - 'null' + examples: + - Something isn't working + color: + description: '6-character hex code, without the leading #, identifying the + color' + type: string + examples: + - FFFFFF + default: + description: Whether this label comes by default in a new repository. + type: boolean + examples: + - true + required: + - id + - node_id + - url + - name + - description + - color + - default timeline-comment-event: title: Timeline Comment Event description: Timeline Comment Event @@ -98318,6 +98489,185 @@ components: - author_association - created_at - updated_at + release-asset: + title: Release Asset + description: Data related to a release. + type: object + properties: + url: + type: string + format: uri + browser_download_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + name: + description: The file name of the asset. + type: string + examples: + - Team Environment + label: + type: + - string + - 'null' + state: + description: State of the release asset. + type: string + enum: + - uploaded + - open + content_type: + type: string + size: + type: integer + digest: + type: + - string + - 'null' + download_count: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + uploader: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - id + - name + - content_type + - size + - digest + - state + - url + - node_id + - download_count + - label + - uploader + - browser_download_url + - created_at + - updated_at + release: + title: Release + description: A release. + type: object + properties: + url: + type: string + format: uri + html_url: + type: string + format: uri + assets_url: + type: string + format: uri + upload_url: + type: string + tarball_url: + type: + - string + - 'null' + format: uri + zipball_url: + type: + - string + - 'null' + format: uri + id: + type: integer + node_id: + type: string + tag_name: + description: The name of the tag. + type: string + examples: + - v1.0.0 + target_commitish: + description: Specifies the commitish value that determines where the Git + tag is created from. + type: string + examples: + - master + name: + type: + - string + - 'null' + body: + type: + - string + - 'null' + draft: + description: true to create a draft (unpublished) release, false to create + a published one. + type: boolean + examples: + - false + prerelease: + description: Whether to identify the release as a prerelease or a full release. + type: boolean + examples: + - false + immutable: + description: Whether or not the release is immutable. + type: boolean + examples: + - false + created_at: + type: string + format: date-time + published_at: + type: + - string + - 'null' + format: date-time + updated_at: + type: + - string + - 'null' + format: date-time + author: + "$ref": "#/components/schemas/simple-user" + assets: + type: array + items: + "$ref": "#/components/schemas/release-asset" + body_html: + type: string + body_text: + type: string + mentions_count: + type: integer + discussion_url: + description: The URL of the release discussion. + type: string + format: uri + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - assets_url + - upload_url + - tarball_url + - zipball_url + - created_at + - published_at + - draft + - id + - node_id + - author + - html_url + - name + - prerelease + - tag_name + - target_commitish + - assets + - url release-notes-content: title: Generated Release Notes Content description: Generated name and body describing a release @@ -101269,19 +101619,19 @@ components: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -103182,6 +103532,325 @@ components: - created_at - updated_at - body + discussion: + title: Discussion + description: A Discussion in a repository. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + answer_chosen_at: + type: + - string + - 'null' + answer_chosen_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + answer_html_url: + type: + - string + - 'null' + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + type: string + category: + type: object + properties: + created_at: + type: string + format: date-time + description: + type: string + emoji: + type: string + id: + type: integer + is_answerable: + type: boolean + name: + type: string + node_id: + type: string + repository_id: + type: integer + slug: + type: string + updated_at: + type: string + required: + - id + - repository_id + - emoji + - name + - description + - created_at + - updated_at + - slug + - is_answerable + comments: + type: integer + created_at: + type: string + format: date-time + html_url: + type: string + id: + type: integer + locked: + type: boolean + node_id: + type: string + number: + type: integer + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + state: + type: string + description: |- + The current state of the discussion. + `converting` means that the discussion is being converted from an issue. + `transferring` means that the discussion is being transferred from another repository. + enum: + - open + - closed + - locked + - converting + - transferring + state_reason: + description: The reason for the current state + type: + - string + - 'null' + enum: + - resolved + - outdated + - duplicate + - reopened + - + examples: + - resolved + timeline_url: + type: string + title: + type: string + updated_at: + type: string + format: date-time + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + labels: + type: array + items: + "$ref": "#/components/schemas/label" + required: + - repository_url + - category + - answer_html_url + - answer_chosen_at + - answer_chosen_by + - html_url + - id + - node_id + - number + - title + - user + - state + - state_reason + - locked + - comments + - created_at + - updated_at + - author_association + - active_lock_reason + - body webhooks_comment: type: object properties: @@ -208453,778 +209122,63 @@ components: format: uri user_view_type: type: string - required: - - login - - id - updated_at: - type: string - format: date-time - url: - type: string - format: uri - workflow_id: - type: integer - workflow_url: - type: string - format: uri - display_title: - type: string - required: - - artifacts_url - - cancel_url - - check_suite_url - - check_suite_id - - check_suite_node_id - - conclusion - - created_at - - event - - head_branch - - head_commit - - head_repository - - head_sha - - html_url - - id - - jobs_url - - logs_url - - node_id - - name - - path - - pull_requests - - repository - - rerun_url - - run_number - - status - - updated_at - - url - - workflow_id - - workflow_url - - run_attempt - - run_started_at - - previous_attempt_url - - actor - - triggering_actor - - display_title - required: - - action - - repository - - sender - - workflow - - workflow_run - create-event: - title: CreateEvent - type: object - properties: - ref: - type: string - ref_type: - type: string - full_ref: - type: string - master_branch: - type: string - description: - type: - - string - - 'null' - pusher_type: - type: string - required: - - ref - - ref_type - - full_ref - - master_branch - - pusher_type - delete-event: - title: DeleteEvent - type: object - properties: - ref: - type: string - ref_type: - type: string - full_ref: - type: string - pusher_type: - type: string - required: - - ref - - ref_type - - full_ref - - pusher_type - discussion-event: - title: DiscussionEvent - type: object - properties: - action: - type: string - discussion: - "$ref": "#/components/schemas/discussion" - required: - - action - - discussion - issues-event: - title: IssuesEvent - type: object - properties: - action: - type: string - issue: - "$ref": "#/components/schemas/issue" - assignee: - "$ref": "#/components/schemas/simple-user" - assignees: - type: array - items: - "$ref": "#/components/schemas/simple-user" - label: - "$ref": "#/components/schemas/label" - labels: - type: array - items: - "$ref": "#/components/schemas/label" - required: - - action - - issue - issue-comment-event: - title: IssueCommentEvent - type: object - properties: - action: - type: string - issue: - "$ref": "#/components/schemas/issue" - comment: - "$ref": "#/components/schemas/issue-comment" - required: - - action - - issue - - comment - fork-event: - title: ForkEvent - type: object - properties: - action: - type: string - forkee: - type: object - properties: - id: - type: integer - node_id: - type: string - name: - type: string - full_name: - type: string - private: - type: boolean - owner: - "$ref": "#/components/schemas/simple-user" - html_url: - type: string - description: - type: - - string - - 'null' - fork: - type: boolean - url: - type: string - forks_url: - type: string - keys_url: - type: string - collaborators_url: - type: string - teams_url: - type: string - hooks_url: - type: string - issue_events_url: - type: string - events_url: - type: string - assignees_url: - type: string - branches_url: - type: string - tags_url: - type: string - blobs_url: - type: string - git_tags_url: - type: string - git_refs_url: - type: string - trees_url: - type: string - statuses_url: - type: string - languages_url: - type: string - stargazers_url: - type: string - contributors_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - commits_url: - type: string - git_commits_url: - type: string - comments_url: - type: string - issue_comment_url: - type: string - contents_url: - type: string - compare_url: - type: string - merges_url: - type: string - archive_url: - type: string - downloads_url: - type: string - issues_url: - type: string - pulls_url: - type: string - milestones_url: - type: string - notifications_url: - type: string - labels_url: - type: string - releases_url: - type: string - deployments_url: - type: string - created_at: - type: - - string - - 'null' - format: date-time - updated_at: - type: - - string - - 'null' - format: date-time - pushed_at: - type: - - string - - 'null' - format: date-time - git_url: - type: string - ssh_url: - type: string - clone_url: - type: string - svn_url: - type: string - homepage: - type: - - string - - 'null' - size: - type: integer - stargazers_count: - type: integer - watchers_count: - type: integer - language: - type: - - string - - 'null' - has_issues: - type: boolean - has_projects: - type: boolean - has_downloads: - type: boolean - has_wiki: - type: boolean - has_pages: - type: boolean - has_discussions: - type: boolean - forks_count: - type: integer - mirror_url: - type: - - string - - 'null' - archived: - type: boolean - disabled: - type: boolean - open_issues_count: - type: integer - license: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/license-simple" - allow_forking: - type: boolean - is_template: - type: boolean - web_commit_signoff_required: - type: boolean - topics: - type: array - items: - type: string - visibility: - type: string - forks: - type: integer - open_issues: - type: integer - watchers: - type: integer - default_branch: - type: string - public: - type: boolean - required: - - action - - forkee - gollum-event: - title: GollumEvent - type: object - properties: - pages: - type: array - items: - type: object - properties: - page_name: - type: - - string - - 'null' - title: - type: - - string - - 'null' - summary: - type: - - string - - 'null' - action: - type: string - sha: - type: string - html_url: - type: string - required: - - pages - member-event: - title: MemberEvent - type: object - properties: - action: - type: string - member: - "$ref": "#/components/schemas/simple-user" - required: - - action - - member - public-event: - title: PublicEvent - type: object - push-event: - title: PushEvent - type: object - properties: - repository_id: - type: integer - push_id: - type: integer - ref: - type: string - head: - type: string - before: - type: string - required: - - repository_id - - push_id - - ref - - head - - before - pull-request-event: - title: PullRequestEvent - type: object - properties: - action: - type: string - number: - type: integer - pull_request: - "$ref": "#/components/schemas/pull-request-minimal" - assignee: - "$ref": "#/components/schemas/simple-user" - assignees: - type: array - items: - "$ref": "#/components/schemas/simple-user" - label: - "$ref": "#/components/schemas/label" - labels: - type: array - items: - "$ref": "#/components/schemas/label" - required: - - action - - number - - pull_request - pull-request-review-comment-event: - title: PullRequestReviewCommentEvent - type: object - properties: - action: - type: string - pull_request: - "$ref": "#/components/schemas/pull-request-minimal" - comment: - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - format: uri - pull_request_review_id: - type: - - integer - - 'null' - diff_hunk: - type: string - path: - type: string - position: - type: - - integer - - 'null' - original_position: - type: integer - subject_type: - type: - - string - - 'null' - commit_id: - type: string - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - body: - type: string - created_at: - type: string - format: date-time + required: + - login + - id updated_at: type: string format: date-time - html_url: + url: type: string format: uri - pull_request_url: + workflow_id: + type: integer + workflow_url: type: string format: uri - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - original_commit_id: + display_title: type: string - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - in_reply_to_id: - type: integer required: - - url - - pull_request_review_id + - artifacts_url + - cancel_url + - check_suite_url + - check_suite_id + - check_suite_node_id + - conclusion + - created_at + - event + - head_branch + - head_commit + - head_repository + - head_sha + - html_url - id + - jobs_url + - logs_url - node_id - - diff_hunk + - name - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at + - pull_requests + - repository + - rerun_url + - run_number + - status - updated_at - - html_url - - pull_request_url - - _links - - reactions - required: - - action - - comment - - pull_request - pull-request-review-event: - title: PullRequestReviewEvent - type: object - properties: - action: - type: string - review: - type: object - properties: - id: - type: integer - node_id: - type: string - user: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - body: - type: string - commit_id: - type: string - submitted_at: - type: - - string - - 'null' - state: - type: string - html_url: - type: string - format: uri - pull_request_url: - type: string - format: uri - _links: - type: object - properties: - html: - type: object - properties: - href: - type: string - required: - - href - pull_request: - type: object - properties: - href: - type: string - required: - - href - required: - - html - - pull_request - updated_at: - type: string - pull_request: - "$ref": "#/components/schemas/pull-request-minimal" - required: - - action - - review - - pull_request - commit-comment-event: - title: CommitCommentEvent - type: object - properties: - action: - type: string - comment: - type: object - properties: - html_url: - type: string - format: uri - url: - type: string - format: uri - id: - type: integer - node_id: - type: string - body: - type: string - path: - type: - - string - - 'null' - position: - type: - - integer - - 'null' - line: - type: - - integer - - 'null' - commit_id: - type: string - user: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - reactions: - "$ref": "#/components/schemas/reaction-rollup" - required: - - action - - comment - release-event: - title: ReleaseEvent - type: object - properties: - action: - type: string - release: - allOf: - - "$ref": "#/components/schemas/release" - - type: object - properties: - is_short_description_html_truncated: - type: boolean - short_description_html: - type: string - required: - - action - - release - watch-event: - title: WatchEvent - type: object - properties: - action: - type: string + - url + - workflow_id + - workflow_url + - run_attempt + - run_started_at + - previous_attempt_url + - actor + - triggering_actor + - display_title required: - action + - repository + - sender + - workflow + - workflow_run examples: root: value: @@ -212583,181 +212537,6 @@ components: 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} - organization-secret-scanning-alert-list: - 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 - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://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 - has_more_locations: true - assigned_to: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false enterprise-teams-items: value: - id: 1 @@ -212810,6 +212589,34 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false + organization-simple: + value: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + organization-simple-items: + value: + - login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization public-events-items: value: - id: '22249084947' @@ -214185,20 +213992,6 @@ components: ~~~~~~==~==~~~==~==~~~~~~ ~~~~~~==~==~==~==~~~~~~ :~==~==~==~==~~ - organization-simple-items: - value: - - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization dependabot-repository-access-details: value: default_level: public @@ -214271,6 +214064,23 @@ components: 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 + custom-property-values: + value: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + create-or-update-custom-properties-values: + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat billing-premium-request-usage-report-org: value: timePeriod: @@ -214452,6 +214262,34 @@ components: prefix: 20.80.208.150 length: 31 last_active_on: '2022-10-09T23:39:01Z' + actions-hosted-runner-custom-image-versions: + value: + total_count: 2 + image_versions: + - version: 1.1.0 + size_gb: 75 + state: Ready + created_on: '2024-11-09T23:39:01Z' + - version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + actions-hosted-runner-custom-image: + value: + id: 1 + platform: linux-x64 + name: CustomImage + source: custom + versions_count: 4 + total_versions_size: 200 + latest_version: 1.3.0 + state: Ready + actions-hosted-runner-custom-image-version: + value: + version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' actions-hosted-runner-curated-image: value: id: ubuntu-20.04 @@ -215296,6 +215134,12 @@ components: signatures: - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== repository_id: 1 + list-attestation-repositories: + value: + - id: 123 + name: foo + - id: 456 + name: bar list-attestations: value: attestations: @@ -219518,6 +219362,181 @@ components: parameters: operator: contains pattern: github + organization-secret-scanning-alert-list: + 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 + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://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 + has_more_locations: true + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false secret-scanning-pattern-configuration: value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K @@ -229287,23 +229306,6 @@ components: site_admin: false created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' - custom-property-values: - value: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat - create-or-update-custom-properties-values: - value: - properties: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat pull-request: value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 @@ -237798,109 +237800,6 @@ components: - updated - epss_percentage default: created - pagination-first: - name: first - description: |- - **Deprecated**. The number of results per page (max 100), starting from the first matching result. - This parameter must not be used in combination with `last`. - Instead, 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 - pagination-last: - name: last - description: |- - **Deprecated**. The number of results per page (max 100), starting from the last matching result. - This parameter must not be used in combination with `first`. - Instead, 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 - secret-scanning-alert-state: - 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 - secret-scanning-alert-secret-type: - 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 - secret-scanning-alert-resolution: - 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 - secret-scanning-alert-sort: - 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 - secret-scanning-alert-validity: - 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 - secret-scanning-alert-publicly-leaked: - 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 - secret-scanning-alert-multi-repo: - 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 - secret-scanning-alert-hide-secret: - 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 enterprise-team: name: enterprise-team description: The slug version of the enterprise team name. You can also substitute @@ -237916,6 +237815,13 @@ components: required: true schema: type: string + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string team-slug: name: team_slug description: The slug of the team name. @@ -238037,13 +237943,6 @@ components: required: false schema: type: integer - org: - name: org - description: The organization name. The name is not case sensitive. - in: path - required: true - schema: - type: string billing-usage-report-year: name: year description: If specified, only return results for a single year. The value @@ -238110,6 +238009,21 @@ components: required: false schema: type: integer + actions-custom-image-definition-id: + name: image_definition_id + description: Image definition ID of custom image + in: path + required: true + schema: + type: integer + actions-custom-image-version: + name: version + description: Version of a custom image + in: path + required: true + schema: + type: string + pattern: "^\\d+\\.\\d+\\.\\d+$" hosted-runner-id: name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. @@ -238622,6 +238536,48 @@ components: required: true schema: type: integer + secret-scanning-alert-state: + 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 + secret-scanning-alert-secret-type: + 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 + secret-scanning-alert-resolution: + 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 + secret-scanning-alert-sort: + 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 secret-scanning-pagination-before-org-repo: 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). @@ -238640,6 +238596,42 @@ components: required: false schema: type: string + secret-scanning-alert-validity: + 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 + secret-scanning-alert-publicly-leaked: + 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 + secret-scanning-alert-multi-repo: + 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 + secret-scanning-alert-hide-secret: + 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 network-configuration-id: name: network_configuration_id description: Unique identifier of the hosted compute network configuration. diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 1d752c43e..35e77a663 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -172,6 +172,10 @@ "name": "enterprise-team-memberships", "description": "Endpoints to manage GitHub Enterprise Team memberships." }, + { + "name": "enterprise-team-organizations", + "description": "Endpoints to manage GitHub Enterprise Team organization assignments." + }, { "name": "code-security", "description": "Endpoints to manage Code security using the REST API." @@ -3212,12 +3216,6 @@ { "$ref": "#/components/parameters/pagination-after" }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" - }, { "$ref": "#/components/parameters/per-page" } @@ -3263,98 +3261,6 @@ } } }, - "/enterprises/{enterprise}/secret-scanning/alerts": { - "get": { - "summary": "List secret scanning alerts for an enterprise", - "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\n\nAlerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](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 a member of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint.", - "tags": [ - "secret-scanning" - ], - "operationId": "secret-scanning/list-alerts-for-enterprise", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise" - }, - "parameters": [ - { - "$ref": "#/components/parameters/enterprise" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-state" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-resolution" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-sort" - }, - { - "$ref": "#/components/parameters/direction" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/pagination-before" - }, - { - "$ref": "#/components/parameters/pagination-after" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-validity" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/organization-secret-scanning-alert" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/organization-secret-scanning-alert-list" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "secret-scanning", - "subcategory": "secret-scanning" - } - } - }, "/enterprises/{enterprise}/teams": { "get": { "summary": "List enterprise teams", @@ -3456,6 +3362,16 @@ ], "default": "disabled" }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint.\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, "group_id": { "type": [ "string", @@ -3857,6 +3773,336 @@ } } }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": { + "get": { + "summary": "Get organization assignments", + "description": "Get all organizations assigned to an enterprise team", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "An array of organizations the team is assigned to", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": { + "post": { + "summary": "Add organization assignments", + "description": "Assign an enterprise team to multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to assign the team to.", + "items": { + "type": "string", + "description": "Organization slug to assign the team to" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Successfully assigned the enterprise team to organizations.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": { + "post": { + "summary": "Remove organization assignments", + "description": "Unassign an enterprise team from multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-remove", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to unassign the team from.", + "items": { + "type": "string", + "description": "Organization slug to unassign the team from" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from organizations." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": { + "get": { + "summary": "Get organization assignment", + "description": "Check if an enterprise team is assigned to an organization", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "The team is assigned to the organization", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-simple" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple" + } + } + } + } + }, + "404": { + "description": "The team is not assigned to the organization" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "put": { + "summary": "Add an organization assignment", + "description": "Assign an enterprise team to an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "201": { + "description": "Successfully assigned the enterprise team to the organization.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-simple" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "delete": { + "summary": "Delete an organization assignment", + "description": "Unassign an enterprise team from an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from the organization." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, "/enterprises/{enterprise}/teams/{team_slug}": { "get": { "summary": "Get an enterprise team", @@ -3958,6 +4204,16 @@ ], "default": "disabled" }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments).\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, "group_id": { "type": [ "string", @@ -7303,10 +7559,125 @@ } } }, + "/organizations/{org}/org-properties/values": { + "get": { + "summary": "Get all custom property values for an organization", + "description": "Gets all custom property values that are set for an organization.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `read:org` scope\n- Actors with the organization-level \"read custom properties for an organization\" fine-grained permission or above", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-orgs-get-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-property-values" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties-for-orgs" + } + }, + "patch": { + "summary": "Create or update custom property values for an organization", + "description": "Create new or update existing custom property values for an organization.\nTo remove a custom property value from an organization, set the property value to `null`.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `admin:org` scope\n- Actors with the organization-level \"edit custom properties for an organization\" fine-grained permission", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-orgs-create-or-update-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the organization.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/create-or-update-custom-properties-values" + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties-for-orgs" + } + } + }, "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", - "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.", + "description": "Gets a report of premium request 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:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -7958,6 +8329,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": [ + "string", + "null" + ] } } }, @@ -7976,6 +8354,11 @@ "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" + }, + "image_gen": { + "description": "Whether this runner should be used to generate custom images.", + "type": "boolean", + "default": false } }, "required": [ @@ -8028,17 +8411,17 @@ } } }, - "/orgs/{org}/actions/hosted-runners/images/github-owned": { + "/orgs/{org}/actions/hosted-runners/images/custom": { "get": { - "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", - "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-github-owned-images-for-org", + "summary": "List custom images for an organization", + "description": "List custom images for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", "tags": [ "actions" ], + "operationId": "actions/list-custom-images-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization" }, "parameters": [ { @@ -8063,14 +8446,14 @@ "images": { "type": "array", "items": { - "$ref": "#/components/schemas/actions-hosted-runner-curated-image" + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" } } } }, "examples": { "default": { - "$ref": "#/components/examples/actions-hosted-runner-curated-image" + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" } } } @@ -8085,17 +8468,292 @@ } } }, - "/orgs/{org}/actions/hosted-runners/images/partner": { + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": { "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 a custom image definition for GitHub Actions Hosted Runners", + "description": "Get a custom image definition for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", "tags": [ "actions" ], + "operationId": "actions/get-custom-image-for-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/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete a custom image from the organization", + "description": "Delete a custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { + "get": { + "summary": "List image versions of a custom image for an organization", + "description": "List image versions of a custom image for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-image-versions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "image_versions" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "image_versions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { + "get": { + "summary": "Get an image version of a custom image for GitHub Actions Hosted Runners", + "description": "Get an image version of a custom image for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-version-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/actions-custom-image-version" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-version" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete an image version of custom image from the organization", + "description": "Delete an image version of custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-version-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/actions-custom-image-version" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/github-owned": { + "get": { + "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", + "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-github-owned-images-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "images" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner-curated-image" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-curated-image" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/partner": { + "get": { + "summary": "Get partner images for GitHub-hosted runners in an organization", + "description": "Get the list of partner images available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-partner-images-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -8394,6 +9052,13 @@ "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" + }, + "image_version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": [ + "string", + "null" + ] } } }, @@ -12565,7 +13230,7 @@ }, "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." + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types." } }, "required": [ @@ -12816,6 +13481,77 @@ } } }, + "/orgs/{org}/attestations/repositories": { + "get": { + "summary": "List attestation repositories", + "description": "List repositories owned by the provided organization that have created at least one attested artifact\nResults will be sorted in ascending order by repository ID", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestation-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/attestations#list-attestation-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/list-attestation-repositories" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + } + } + }, "/orgs/{org}/attestations/{attestation_id}": { "delete": { "summary": "Delete attestations by ID", @@ -12901,7 +13637,7 @@ }, { "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.", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", "in": "query", "required": false, "schema": { @@ -13289,7 +14025,10 @@ }, "code_scanning_alerts": { "description": "The code scanning alerts to include in this campaign", - "type": "array", + "type": [ + "array", + "null" + ], "minItems": 1, "items": { "type": "object", @@ -13323,8 +14062,19 @@ "required": [ "name", "description", - "ends_at", - "code_scanning_alerts" + "ends_at" + ], + "oneOf": [ + { + "required": [ + "code_scanning_alerts" + ] + }, + { + "required": [ + "secret_scanning_alerts" + ] + } ] }, "examples": { @@ -16474,12 +17224,6 @@ { "$ref": "#/components/parameters/pagination-after" }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" - }, { "$ref": "#/components/parameters/per-page" } @@ -23109,17 +23853,21 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } }, @@ -23297,17 +24045,21 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -35187,7 +35939,7 @@ }, { "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.", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", "in": "query", "required": false, "schema": { @@ -44473,16 +45225,6 @@ { "$ref": "#/components/parameters/direction" }, - { - "name": "page", - "description": "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", - "deprecated": true, - "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).\"", @@ -44498,12 +45240,6 @@ }, { "$ref": "#/components/parameters/pagination-after" - }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" } ], "responses": { @@ -61643,7 +62379,7 @@ "/repos/{owner}/{repo}/secret-scanning/scan-history": { "get": { "summary": "Get secret scanning scan history for a repository", - "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\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.", + "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security).\"\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": [ "secret-scanning" ], @@ -73337,7 +74073,7 @@ }, "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." + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types." } }, "required": [ @@ -73673,7 +74409,7 @@ }, { "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.", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", "in": "query", "required": false, "schema": { @@ -75284,17 +76020,21 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -75463,17 +76203,21 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -76022,7 +76766,7 @@ "/users/{username}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for a user", - "description": "Gets a report of premium request usage for a user.", + "description": "Gets a report of premium request usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -102393,6 +103137,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -102590,6 +103342,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -105754,578 +106515,6 @@ ], "additionalProperties": false }, - "secret-scanning-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" - ] - }, - "secret-scanning-alert-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 - ] - }, - "secret-scanning-location-commit": { - "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" - ] - }, - "secret-scanning-location-wiki-commit": { - "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" - ] - }, - "secret-scanning-location-issue-title": { - "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" - ] - }, - "secret-scanning-location-issue-body": { - "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" - ] - }, - "secret-scanning-location-issue-comment": { - "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" - ] - }, - "secret-scanning-location-discussion-title": { - "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" - ] - }, - "secret-scanning-location-discussion-body": { - "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" - ] - }, - "secret-scanning-location-discussion-comment": { - "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" - ] - }, - "secret-scanning-location-pull-request-title": { - "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" - ] - }, - "secret-scanning-location-pull-request-body": { - "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" - ] - }, - "secret-scanning-location-pull-request-comment": { - "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" - ] - }, - "secret-scanning-location-pull-request-review": { - "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" - ] - }, - "secret-scanning-location-pull-request-review-comment": { - "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" - ] - }, - "secret-scanning-first-detected-location": { - "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", - "oneOf": [ - { - "$ref": "#/components/schemas/secret-scanning-location-commit" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-issue-title" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-issue-body" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" - } - ] - }, - "organization-secret-scanning-alert": { - "type": "object", - "properties": { - "number": { - "$ref": "#/components/schemas/alert-number" - }, - "created_at": { - "$ref": "#/components/schemas/alert-created-at" - }, - "updated_at": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/alert-updated-at" - } - ] - }, - "url": { - "$ref": "#/components/schemas/alert-url" - }, - "html_url": { - "$ref": "#/components/schemas/alert-html-url" - }, - "locations_url": { - "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." - }, - "state": { - "$ref": "#/components/schemas/secret-scanning-alert-state" - }, - "resolution": { - "$ref": "#/components/schemas/secret-scanning-alert-resolution" - }, - "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" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "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": { - "$ref": "#/components/schemas/simple-repository" - }, - "push_protection_bypassed": { - "type": [ - "boolean", - "null" - ], - "description": "Whether push protection was bypassed for the detected secret." - }, - "push_protection_bypassed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "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" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "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" - }, - { - "$ref": "#/components/schemas/secret-scanning-first-detected-location" - } - ] - }, - "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." - }, - "assigned_to": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - } - } - }, "enterprise-team": { "title": "Enterprise Team", "description": "Group of enterprise owners and/or members", @@ -106411,538 +106600,140 @@ "group_id" ] }, - "actor": { - "title": "Actor", - "description": "Actor", + "organization-simple": { + "title": "Organization Simple", + "description": "A GitHub organization.", "type": "object", "properties": { - "id": { - "type": "integer" - }, "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { "type": "string", - "format": "uri" + "examples": [ + "github" + ] }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] - }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { "id": { - "description": "Unique identifier for the label.", "type": "integer", - "format": "int64", "examples": [ - 208045946 + 1 ] }, "node_id": { "type": "string", "examples": [ - "MDU6TGFiZWwyMDgwNDU5NDY=" + "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { - "description": "URL for the label", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repositories/42/labels/bug" + "https://api.github.com/orgs/github" ] }, - "name": { - "description": "The name of the label.", + "repos_url": { "type": "string", + "format": "uri", "examples": [ - "bug" + "https://api.github.com/orgs/github/repos" ] }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ], + "events_url": { + "type": "string", + "format": "uri", "examples": [ - "Something isn't working" + "https://api.github.com/orgs/github/events" ] }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", + "hooks_url": { "type": "string", "examples": [ - "FFFFFF" + "https://api.github.com/orgs/github/hooks" ] }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", + "issues_url": { + "type": "string", "examples": [ - true - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - }, - "discussion": { - "title": "Discussion", - "description": "A Discussion in a repository.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - }, - "answer_html_url": { - "type": [ - "string", - "null" + "https://api.github.com/orgs/github/issues" ] }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + "members_url": { "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" + "examples": [ + "https://api.github.com/orgs/github/members{/member}" ] }, - "comments": { - "type": "integer" - }, - "created_at": { + "public_members_url": { "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "locked": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" ] }, - "repository_url": { - "type": "string" - }, - "state": { + "avatar_url": { "type": "string", - "description": "The current state of the discussion.\n`converting` means that the discussion is being converted from an issue.\n`transferring` means that the discussion is being transferred from another repository.", - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" + "examples": [ + "https://github.com/images/error/octocat_happy.gif" ] }, - "state_reason": { - "description": "The reason for the current state", + "description": { "type": [ "string", "null" ], - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ], "examples": [ - "resolved" + "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" + ] + }, + "actor": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" }, - "timeline_url": { + "login": { "type": "string" }, - "title": { + "display_login": { "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "user": { - "title": "User", + "gravatar_id": { "type": [ - "object", + "string", "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" ] }, - "labels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/label" - } + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", "id", - "node_id", - "number", - "title", - "user", - "state", - "state_reason", - "locked", - "comments", - "created_at", - "updated_at", - "active_lock_reason", - "body" + "login", + "gravatar_id", + "url", + "avatar_url" ] }, "milestone": { @@ -107805,350 +107596,13 @@ "node_id", "html_url", "issue_url", + "author_association", "user", "url", "created_at", "updated_at" ] }, - "pull-request-minimal": { - "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" - ] - }, - "release-asset": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded", - "open" - ] - }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "download_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - } - }, - "required": [ - "id", - "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" - ] - }, - "release": { - "title": "Release", - "description": "A release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "assets_url": { - "type": "string", - "format": "uri" - }, - "upload_url": { - "type": "string" - }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "tag_name": { - "description": "The name of the tag.", - "type": "string", - "examples": [ - "v1.0.0" - ] - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", - "type": "string", - "examples": [ - "master" - ] - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "draft": { - "description": "true to create a draft (unpublished) release, false to create a published one.", - "type": "boolean", - "examples": [ - false - ] - }, - "prerelease": { - "description": "Whether to identify the release as a prerelease or a full release.", - "type": "boolean", - "examples": [ - false - ] - }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean", - "examples": [ - false - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "author": { - "$ref": "#/components/schemas/simple-user" - }, - "assets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/release-asset" - } - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "mentions_count": { - "type": "integer" - }, - "discussion_url": { - "description": "The URL of the release discussion.", - "type": "string", - "format": "uri" - }, - "reactions": { - "$ref": "#/components/schemas/reaction-rollup" - } - }, - "required": [ - "assets_url", - "upload_url", - "tarball_url", - "zipball_url", - "created_at", - "published_at", - "draft", - "id", - "node_id", - "author", - "html_url", - "name", - "prerelease", - "tag_name", - "target_commitish", - "assets", - "url" - ] - }, "event": { "title": "Event", "description": "Event", @@ -108190,56 +107644,47 @@ "$ref": "#/components/schemas/actor" }, "payload": { - "oneOf": [ - { - "$ref": "#/components/schemas/events/create-event" - }, - { - "$ref": "#/components/schemas/events/delete-event" - }, - { - "$ref": "#/components/schemas/events/discussion-event" - }, - { - "$ref": "#/components/schemas/events/issues-event" - }, - { - "$ref": "#/components/schemas/events/issue-comment-event" - }, - { - "$ref": "#/components/schemas/events/fork-event" - }, - { - "$ref": "#/components/schemas/events/gollum-event" - }, - { - "$ref": "#/components/schemas/events/member-event" - }, - { - "$ref": "#/components/schemas/events/public-event" - }, - { - "$ref": "#/components/schemas/events/push-event" - }, - { - "$ref": "#/components/schemas/events/pull-request-event" - }, - { - "$ref": "#/components/schemas/events/pull-request-review-comment-event" - }, - { - "$ref": "#/components/schemas/events/pull-request-review-event" + "type": "object", + "properties": { + "action": { + "type": "string" }, - { - "$ref": "#/components/schemas/events/commit-comment-event" + "issue": { + "$ref": "#/components/schemas/issue" }, - { - "$ref": "#/components/schemas/events/release-event" + "comment": { + "$ref": "#/components/schemas/issue-comment" }, - { - "$ref": "#/components/schemas/events/watch-event" + "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" @@ -110613,105 +110058,6 @@ "subscribed" ] }, - "organization-simple": { - "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" - ] - }, "dependabot-repository-access-details": { "title": "Dependabot Repository Access Details", "description": "Information about repositories that Dependabot is able to access in an organization", @@ -110748,6 +110094,40 @@ }, "additionalProperties": false }, + "custom-property-value": { + "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" + ] + }, "billing-premium-request-usage-report-org": { "type": "object", "properties": { @@ -110813,7 +110193,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -110821,7 +110201,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -110829,7 +110209,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -111522,6 +110902,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -111692,6 +111079,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -111704,6 +111095,128 @@ "platform" ] }, + "actions-hosted-runner-custom-image": { + "title": "GitHub-hosted runner custom image details", + "description": "Provides details of a custom 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": "integer", + "examples": [ + 1 + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "examples": [ + 200 + ] + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + "CustomImage" + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "examples": [ + "custom" + ] + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "examples": [ + 4 + ] + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "examples": [ + "1.3.0" + ] + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "examples": [ + "Ready" + ] + } + }, + "required": [ + "id", + "platform", + "name", + "source", + "versions_count", + "total_versions_size", + "latest_version", + "state" + ] + }, + "actions-hosted-runner-custom-image-version": { + "title": "GitHub-hosted runner custom image version details.", + "description": "Provides details of a hosted runner custom image version", + "type": "object", + "properties": { + "version": { + "description": "The version of image.", + "type": "string", + "examples": [ + "1.0.0" + ] + }, + "state": { + "description": "The state of image version.", + "type": "string", + "examples": [ + "Ready" + ] + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "examples": [ + 30 + ] + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "examples": [ + "2024-11-09T23:39:01Z" + ] + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "examples": [ + "None" + ] + } + }, + "required": [ + "version", + "state", + "size_gb", + "created_on", + "state_details" + ] + }, "actions-hosted-runner-curated-image": { "title": "GitHub-hosted runner image details.", "description": "Provides details of a hosted runner image", @@ -112449,6 +111962,15 @@ "closed" ] }, + "campaign-alert-type": { + "title": "Campaign alert type", + "description": "Indicates the alert type of a campaign", + "type": "string", + "enum": [ + "code_scanning", + "secret_scanning" + ] + }, "team-simple": { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", @@ -117390,40 +116912,6 @@ "value_type" ] }, - "custom-property-value": { - "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" - ] - }, "org-repo-custom-property-values": { "title": "Organization Repository Custom Property Values", "description": "List of custom property values for a repository", @@ -119923,6 +119411,578 @@ } ] }, + "secret-scanning-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" + ] + }, + "secret-scanning-alert-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 + ] + }, + "secret-scanning-location-commit": { + "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" + ] + }, + "secret-scanning-location-wiki-commit": { + "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" + ] + }, + "secret-scanning-location-issue-title": { + "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" + ] + }, + "secret-scanning-location-issue-body": { + "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" + ] + }, + "secret-scanning-location-issue-comment": { + "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" + ] + }, + "secret-scanning-location-discussion-title": { + "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" + ] + }, + "secret-scanning-location-discussion-body": { + "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" + ] + }, + "secret-scanning-location-discussion-comment": { + "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" + ] + }, + "secret-scanning-location-pull-request-title": { + "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" + ] + }, + "secret-scanning-location-pull-request-body": { + "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" + ] + }, + "secret-scanning-location-pull-request-comment": { + "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" + ] + }, + "secret-scanning-location-pull-request-review": { + "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" + ] + }, + "secret-scanning-location-pull-request-review-comment": { + "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" + ] + }, + "secret-scanning-first-detected-location": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "$ref": "#/components/schemas/secret-scanning-location-commit" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-issue-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-issue-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-issue-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" + } + ] + }, + "organization-secret-scanning-alert": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/alert-updated-at" + } + ] + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + }, + "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" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "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": { + "$ref": "#/components/schemas/simple-repository" + }, + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "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" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "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" + }, + { + "$ref": "#/components/schemas/secret-scanning-first-detected-location" + } + ] + }, + "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." + }, + "assigned_to": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + } + } + }, "secret-scanning-row-version": { "type": [ "string", @@ -123245,6 +123305,101 @@ "sha" ] }, + "pull-request-minimal": { + "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" + ] + }, "simple-commit": { "title": "Simple Commit", "description": "A commit.", @@ -132964,6 +133119,75 @@ } ] }, + "label": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "examples": [ + 208045946 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDU6TGFiZWwyMDgwNDU5NDY=" + ] + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/labels/bug" + ] + }, + "name": { + "description": "The name of the label.", + "type": "string", + "examples": [ + "bug" + ] + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": [ + "string", + "null" + ], + "examples": [ + "Something isn't working" + ] + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string", + "examples": [ + "FFFFFF" + ] + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + }, "timeline-comment-event": { "title": "Timeline Comment Event", "description": "Timeline Comment Event", @@ -135753,6 +135977,249 @@ "updated_at" ] }, + "release-asset": { + "title": "Release Asset", + "description": "Data related to a release.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "browser_download_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The file name of the asset.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "label": { + "type": [ + "string", + "null" + ] + }, + "state": { + "description": "State of the release asset.", + "type": "string", + "enum": [ + "uploaded", + "open" + ] + }, + "content_type": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "digest": { + "type": [ + "string", + "null" + ] + }, + "download_count": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "uploader": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + } + }, + "required": [ + "id", + "name", + "content_type", + "size", + "digest", + "state", + "url", + "node_id", + "download_count", + "label", + "uploader", + "browser_download_url", + "created_at", + "updated_at" + ] + }, + "release": { + "title": "Release", + "description": "A release.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "assets_url": { + "type": "string", + "format": "uri" + }, + "upload_url": { + "type": "string" + }, + "tarball_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "zipball_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "tag_name": { + "description": "The name of the tag.", + "type": "string", + "examples": [ + "v1.0.0" + ] + }, + "target_commitish": { + "description": "Specifies the commitish value that determines where the Git tag is created from.", + "type": "string", + "examples": [ + "master" + ] + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "draft": { + "description": "true to create a draft (unpublished) release, false to create a published one.", + "type": "boolean", + "examples": [ + false + ] + }, + "prerelease": { + "description": "Whether to identify the release as a prerelease or a full release.", + "type": "boolean", + "examples": [ + false + ] + }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "published_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "author": { + "$ref": "#/components/schemas/simple-user" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/release-asset" + } + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "mentions_count": { + "type": "integer" + }, + "discussion_url": { + "description": "The URL of the release discussion.", + "type": "string", + "format": "uri" + }, + "reactions": { + "$ref": "#/components/schemas/reaction-rollup" + } + }, + "required": [ + "assets_url", + "upload_url", + "tarball_url", + "zipball_url", + "created_at", + "published_at", + "draft", + "id", + "node_id", + "author", + "html_url", + "name", + "prerelease", + "tag_name", + "target_commitish", + "assets", + "url" + ] + }, "release-notes-content": { "title": "Generated Release Notes Content", "description": "Generated name and body describing a release", @@ -140006,7 +140473,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -140014,7 +140481,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -140022,7 +140489,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -142565,107 +143032,24 @@ "body" ] }, - "webhooks_comment": { + "discussion": { + "title": "Discussion", + "description": "A Discussion in a repository.", "type": "object", "properties": { - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "type": "string" - }, - "child_comment_count": { - "type": "integer" - }, - "created_at": { - "type": "string" - }, - "discussion_id": { - "type": "integer" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "parent_id": { + "active_lock_reason": { "type": [ - "integer", + "string", "null" ] }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "answer_chosen_at": { + "type": [ + "string", + "null" ] }, - "repository_url": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "user": { + "answer_chosen_by": { "title": "User", "type": [ "object", @@ -142709,8 +143093,7 @@ "format": "uri" }, "id": { - "type": "integer", - "format": "int64" + "type": "integer" }, "login": { "type": "string" @@ -142764,148 +143147,13 @@ "login", "id" ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "parent_id", - "child_comment_count", - "repository_url", - "discussion_id", - "author_association", - "user", - "created_at", - "updated_at", - "body", - "reactions" - ] - }, - "webhooks_label": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" }, - "default": { - "type": "boolean" - }, - "description": { + "answer_html_url": { "type": [ "string", "null" ] }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - }, - "webhooks_repositories": { - "description": "An array of repository objects that the installation can access.", - "type": "array", - "items": { - "type": "object", - "properties": { - "full_name": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "name", - "full_name", - "private" - ] - } - }, - "webhooks_repositories_added": { - "description": "An array of repository objects, which were added to the installation.", - "type": "array", - "items": { - "type": "object", - "properties": { - "full_name": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "name", - "full_name", - "private" - ] - } - }, - "webhooks_repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "webhooks_issue_comment": { - "title": "issue comment", - "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.", - "type": "object", - "properties": { "author_association": { "title": "AuthorAssociation", "description": "How the author is associated with the repository.", @@ -142922,31 +143170,679 @@ ] }, "body": { - "description": "Contents of the issue comment", "type": "string" }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, "created_at": { "type": "string", "format": "date-time" }, "html_url": { - "type": "string", - "format": "uri" + "type": "string" }, "id": { - "description": "Unique identifier of the issue comment", - "type": "integer", - "format": "int64" + "type": "integer" }, - "issue_url": { - "type": "string", - "format": "uri" + "locked": { + "type": "boolean" }, "node_id": { "type": "string" }, - "performed_via_github_app": { - "$ref": "#/components/schemas/integration" + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "description": "The current state of the discussion.\n`converting` means that the discussion is being converted from an issue.\n`transferring` means that the discussion is being transferred from another repository.", + "enum": [ + "open", + "closed", + "locked", + "converting", + "transferring" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "outdated", + "duplicate", + "reopened", + null + ], + "examples": [ + "resolved" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "labels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/label" + } + } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "state_reason", + "locked", + "comments", + "created_at", + "updated_at", + "author_association", + "active_lock_reason", + "body" + ] + }, + "webhooks_comment": { + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "type": "string" + }, + "child_comment_count": { + "type": "integer" + }, + "created_at": { + "type": "string" + }, + "discussion_id": { + "type": "integer" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "parent_id": { + "type": [ + "integer", + "null" + ] + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "parent_id", + "child_comment_count", + "repository_url", + "discussion_id", + "author_association", + "user", + "created_at", + "updated_at", + "body", + "reactions" + ] + }, + "webhooks_label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, + "webhooks_repositories": { + "description": "An array of repository objects that the installation can access.", + "type": "array", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private" + ] + } + }, + "webhooks_repositories_added": { + "description": "An array of repository objects, which were added to the installation.", + "type": "array", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private" + ] + } + }, + "webhooks_repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "webhooks_issue_comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.", + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/integration" }, "reactions": { "title": "Reactions", @@ -284202,1060 +285098,6 @@ "workflow", "workflow_run" ] - }, - "create-event": { - "title": "CreateEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "full_ref": { - "type": "string" - }, - "master_branch": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "full_ref", - "master_branch", - "pusher_type" - ] - }, - "delete-event": { - "title": "DeleteEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "full_ref": { - "type": "string" - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "full_ref", - "pusher_type" - ] - }, - "discussion-event": { - "title": "DiscussionEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "discussion": { - "$ref": "#/components/schemas/discussion" - } - }, - "required": [ - "action", - "discussion" - ] - }, - "issues-event": { - "title": "IssuesEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "$ref": "#/components/schemas/issue" - }, - "assignee": { - "$ref": "#/components/schemas/simple-user" - }, - "assignees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/simple-user" - } - }, - "label": { - "$ref": "#/components/schemas/label" - }, - "labels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/label" - } - } - }, - "required": [ - "action", - "issue" - ] - }, - "issue-comment-event": { - "title": "IssueCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "$ref": "#/components/schemas/issue" - }, - "comment": { - "$ref": "#/components/schemas/issue-comment" - } - }, - "required": [ - "action", - "issue", - "comment" - ] - }, - "fork-event": { - "title": "ForkEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "forkee": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "private": { - "type": "boolean" - }, - "owner": { - "$ref": "#/components/schemas/simple-user" - }, - "html_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "git_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "forks_count": { - "type": "integer" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "open_issues_count": { - "type": "integer" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/license-simple" - } - ] - }, - "allow_forking": { - "type": "boolean" - }, - "is_template": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "visibility": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "public": { - "type": "boolean" - } - } - } - }, - "required": [ - "action", - "forkee" - ] - }, - "gollum-event": { - "title": "GollumEvent", - "type": "object", - "properties": { - "pages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "page_name": { - "type": [ - "string", - "null" - ] - }, - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "action": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } - } - } - }, - "required": [ - "pages" - ] - }, - "member-event": { - "title": "MemberEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "member": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "member" - ] - }, - "public-event": { - "title": "PublicEvent", - "type": "object" - }, - "push-event": { - "title": "PushEvent", - "type": "object", - "properties": { - "repository_id": { - "type": "integer" - }, - "push_id": { - "type": "integer" - }, - "ref": { - "type": "string" - }, - "head": { - "type": "string" - }, - "before": { - "type": "string" - } - }, - "required": [ - "repository_id", - "push_id", - "ref", - "head", - "before" - ] - }, - "pull-request-event": { - "title": "PullRequestEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "pull_request": { - "$ref": "#/components/schemas/pull-request-minimal" - }, - "assignee": { - "$ref": "#/components/schemas/simple-user" - }, - "assignees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/simple-user" - } - }, - "label": { - "$ref": "#/components/schemas/label" - }, - "labels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/label" - } - } - }, - "required": [ - "action", - "number", - "pull_request" - ] - }, - "pull-request-review-comment-event": { - "title": "PullRequestReviewCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "pull_request": { - "$ref": "#/components/schemas/pull-request-minimal" - }, - "comment": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "pull_request_review_id": { - "type": [ - "integer", - "null" - ] - }, - "diff_hunk": { - "type": "string" - }, - "path": { - "type": "string" - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "original_position": { - "type": "integer" - }, - "subject_type": { - "type": [ - "string", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - } - }, - "body": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "original_commit_id": { - "type": "string" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "in_reply_to_id": { - "type": "integer" - } - }, - "required": [ - "url", - "pull_request_review_id", - "id", - "node_id", - "diff_hunk", - "path", - "position", - "original_position", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "_links", - "reactions" - ] - } - }, - "required": [ - "action", - "comment", - "pull_request" - ] - }, - "pull-request-review-event": { - "title": "PullRequestReviewEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "review": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "body": { - "type": "string" - }, - "commit_id": { - "type": "string" - }, - "submitted_at": { - "type": [ - "string", - "null" - ] - }, - "state": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "html", - "pull_request" - ] - }, - "updated_at": { - "type": "string" - } - } - }, - "pull_request": { - "$ref": "#/components/schemas/pull-request-minimal" - } - }, - "required": [ - "action", - "review", - "pull_request" - ] - }, - "commit-comment-event": { - "title": "CommitCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "comment": { - "type": "object", - "properties": { - "html_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "body": { - "type": "string" - }, - "path": { - "type": [ - "string", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "reactions": { - "$ref": "#/components/schemas/reaction-rollup" - } - } - } - }, - "required": [ - "action", - "comment" - ] - }, - "release-event": { - "title": "ReleaseEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "release": { - "allOf": [ - { - "$ref": "#/components/schemas/release" - }, - { - "type": "object", - "properties": { - "is_short_description_html_truncated": { - "type": "boolean" - }, - "short_description_html": { - "type": "string" - } - } - } - ] - } - }, - "required": [ - "action", - "release" - ] - }, - "watch-event": { - "title": "WatchEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - } - }, - "required": [ - "action" - ] } }, "examples": { @@ -288819,192 +288661,6 @@ } ] }, - "organization-secret-scanning-alert-list": { - "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 - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://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" - }, - "has_more_locations": true, - "assigned_to": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - ] - }, "enterprise-teams-items": { "value": [ { @@ -289067,6 +288723,40 @@ "site_admin": false } }, + "organization-simple": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + }, + "organization-simple-items": { + "value": [ + { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + ] + }, "public-events-items": { "value": [ { @@ -290587,24 +290277,6 @@ "octocat": { "value": " MMM. .MMM\n MMMMMMMMMMMMMMMMMMM\n MMMMMMMMMMMMMMMMMMM ___________________________________\n MMMMMMMMMMMMMMMMMMMMM | |\n MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. |\n MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________|\n MMMM::- -:::::::- -::MMMM |/\n MM~:~ 00~:::::~ 00~:~MM\n .. MMMMM::.00:::+:::.00::MMMMM ..\n .MM::::: ._. :::::MM.\n MMMM;:::::;MMMM\n -MM MMMMMMM\n ^ M+ MMMMMMMMM\n MMMMMMM MM MM MM\n MM MM MM MM\n MM MM MM MM\n .~~MM~MM~MM~MM~~.\n ~~~~MM:~MM~~~MM~:MM~~~~\n ~~~~~~==~==~~~==~==~~~~~~\n ~~~~~~==~==~==~==~~~~~~\n :~==~==~==~==~~\n" }, - "organization-simple-items": { - "value": [ - { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - } - ] - }, "dependabot-repository-access-details": { "value": { "default_level": "public", @@ -290683,6 +290355,40 @@ ] } }, + "custom-property-values": { + "value": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + }, + "create-or-update-custom-properties-values": { + "value": { + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + }, "billing-premium-request-usage-report-org": { "value": { "timePeriod": { @@ -290908,6 +290614,45 @@ "last_active_on": "2022-10-09T23:39:01Z" } }, + "actions-hosted-runner-custom-image-versions": { + "value": { + "total_count": 2, + "image_versions": [ + { + "version": "1.1.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-09T23:39:01Z" + }, + { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + ] + } + }, + "actions-hosted-runner-custom-image": { + "value": { + "id": 1, + "platform": "linux-x64", + "name": "CustomImage", + "source": "custom", + "versions_count": 4, + "total_versions_size": 200, + "latest_version": "1.3.0", + "state": "Ready" + } + }, + "actions-hosted-runner-custom-image-version": { + "value": { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + }, "actions-hosted-runner-curated-image": { "value": { "id": "ubuntu-20.04", @@ -291971,6 +291716,18 @@ ] } }, + "list-attestation-repositories": { + "value": [ + { + "id": 123, + "name": "foo" + }, + { + "id": 456, + "name": "bar" + } + ] + }, "list-attestations": { "value": { "attestations": [ @@ -296857,6 +296614,192 @@ } ] }, + "organization-secret-scanning-alert-list": { + "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 + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://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" + }, + "has_more_locations": true, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + }, "secret-scanning-pattern-configuration": { "value": { "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", @@ -308305,40 +308248,6 @@ } ] }, - "custom-property-values": { - "value": [ - { - "property_name": "environment", - "value": "production" - }, - { - "property_name": "service", - "value": "web" - }, - { - "property_name": "team", - "value": "octocat" - } - ] - }, - "create-or-update-custom-properties-values": { - "value": { - "properties": [ - { - "property_name": "environment", - "value": "production" - }, - { - "property_name": "service", - "value": "web" - }, - { - "property_name": "team", - "value": "octocat" - } - ] - } - }, "pull-request": { "value": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -318019,113 +317928,6 @@ "default": "created" } }, - "pagination-first": { - "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 - } - }, - "pagination-last": { - "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 - } - }, - "secret-scanning-alert-state": { - "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" - ] - } - }, - "secret-scanning-alert-secret-type": { - "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" - } - }, - "secret-scanning-alert-resolution": { - "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" - } - }, - "secret-scanning-alert-sort": { - "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" - } - }, - "secret-scanning-alert-validity": { - "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" - } - }, - "secret-scanning-alert-publicly-leaked": { - "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 - } - }, - "secret-scanning-alert-multi-repo": { - "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 - } - }, - "secret-scanning-alert-hide-secret": { - "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 - } - }, "enterprise-team": { "name": "enterprise-team", "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", @@ -318144,6 +317946,15 @@ "type": "string" } }, + "org": { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "team-slug": { "name": "team_slug", "description": "The slug of the team name.", @@ -318288,15 +318099,6 @@ "type": "integer" } }, - "org": { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, "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.", @@ -318369,6 +318171,25 @@ "type": "integer" } }, + "actions-custom-image-definition-id": { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "actions-custom-image-version": { + "name": "version", + "description": "Version of a custom image", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+$" + } + }, "hosted-runner-id": { "name": "hosted_runner_id", "description": "Unique identifier of the GitHub-hosted runner.", @@ -318966,6 +318787,51 @@ "type": "integer" } }, + "secret-scanning-alert-state": { + "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" + ] + } + }, + "secret-scanning-alert-secret-type": { + "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" + } + }, + "secret-scanning-alert-resolution": { + "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" + } + }, + "secret-scanning-alert-sort": { + "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" + } + }, "secret-scanning-pagination-before-org-repo": { "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.", @@ -318984,6 +318850,45 @@ "type": "string" } }, + "secret-scanning-alert-validity": { + "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" + } + }, + "secret-scanning-alert-publicly-leaked": { + "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 + } + }, + "secret-scanning-alert-multi-repo": { + "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 + } + }, + "secret-scanning-alert-hide-secret": { + "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 + } + }, "network-configuration-id": { "name": "network_configuration_id", "description": "Unique identifier of the hosted compute network configuration.", diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 5a3328d6f..a5e785bdd 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -91,6 +91,8 @@ tags: description: Endpoints to manage GitHub Enterprise Teams. - name: enterprise-team-memberships description: Endpoints to manage GitHub Enterprise Team memberships. +- name: enterprise-team-organizations + description: Endpoints to manage GitHub Enterprise Team organization assignments. - name: code-security description: Endpoints to manage Code security using the REST API. - name: private-registries @@ -2302,8 +2304,6 @@ paths: - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" - "$ref": "#/components/parameters/per-page" responses: '200': @@ -2331,61 +2331,6 @@ paths: previews: [] category: dependabot subcategory: alerts - "/enterprises/{enterprise}/secret-scanning/alerts": - get: - summary: List secret scanning alerts for an enterprise - description: |- - Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - - Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). - - The authenticated user must be a member of the enterprise in order to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. - tags: - - secret-scanning - operationId: secret-scanning/list-alerts-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise - parameters: - - "$ref": "#/components/parameters/enterprise" - - "$ref": "#/components/parameters/secret-scanning-alert-state" - - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - - "$ref": "#/components/parameters/secret-scanning-alert-resolution" - - "$ref": "#/components/parameters/secret-scanning-alert-sort" - - "$ref": "#/components/parameters/direction" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/pagination-before" - - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/secret-scanning-alert-validity" - - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" - - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/organization-secret-scanning-alert" - examples: - default: - "$ref": "#/components/examples/organization-secret-scanning-alert-list" - headers: - Link: - "$ref": "#/components/headers/link" - '404': - "$ref": "#/components/responses/not_found" - '503': - "$ref": "#/components/responses/service_unavailable" - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: secret-scanning - subcategory: secret-scanning "/enterprises/{enterprise}/teams": get: summary: List enterprise teams @@ -2459,6 +2404,18 @@ paths: - all - disabled default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled group_id: type: - string @@ -2706,6 +2663,209 @@ paths: enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-members + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": + get: + summary: Get organization assignments + description: Get all organizations assigned to an enterprise team + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignments + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: An array of organizations the team is assigned to + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": + post: + summary: Add organization assignments + description: Assign an enterprise team to multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to assign the team to. + items: + type: string + description: Organization slug to assign the team to + examples: + default: + value: + organization_slugs: + - github + responses: + '200': + description: Successfully assigned the enterprise team to organizations. + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": + post: + summary: Remove organization assignments + description: Unassign an enterprise team from multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-remove + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to unassign the team from. + items: + type: string + description: Organization slug to unassign the team from + examples: + default: + value: + organization_slugs: + - github + responses: + '204': + description: Successfully unassigned the enterprise team from organizations. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": + get: + summary: Get organization assignment + description: Check if an enterprise team is assigned to an organization + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '200': + description: The team is assigned to the organization + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + '404': + description: The team is not assigned to the organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + put: + summary: Add an organization assignment + description: Assign an enterprise team to an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '201': + description: Successfully assigned the enterprise team to the organization. + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + delete: + summary: Delete an organization assignment + description: Unassign an enterprise team from an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/delete + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Successfully unassigned the enterprise team from the organization. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations "/enterprises/{enterprise}/teams/{team_slug}": get: summary: Get an enterprise team @@ -2781,6 +2941,18 @@ paths: - all - disabled default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled group_id: type: - string @@ -5136,12 +5308,107 @@ paths: enabledForGitHubApps: true category: dependabot subcategory: repository-access + "/organizations/{org}/org-properties/values": + get: + summary: Get all custom property values for an organization + description: |- + Gets all custom property values that are set for an organization. + + The organization must belong to an enterprise. + + Access requirements: + - Organization admins + - OAuth tokens and personal access tokens (classic) with the `read:org` scope + - Actors with the organization-level "read custom properties for an organization" fine-grained permission or above + tags: + - orgs + operationId: orgs/custom-properties-for-orgs-get-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/custom-property-value" + examples: + default: + "$ref": "#/components/examples/custom-property-values" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties-for-orgs + patch: + summary: Create or update custom property values for an organization + description: |- + Create new or update existing custom property values for an organization. + To remove a custom property value from an organization, set the property value to `null`. + + The organization must belong to an enterprise. + + Access requirements: + - Organization admins + - OAuth tokens and personal access tokens (classic) with the `admin:org` scope + - Actors with the organization-level "edit custom properties for an organization" fine-grained permission + tags: + - orgs + operationId: orgs/custom-properties-for-orgs-create-or-update-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: A list of custom property names and associated values + to apply to the organization. + items: + "$ref": "#/components/schemas/custom-property-value" + required: + - properties + examples: + default: + "$ref": "#/components/examples/create-or-update-custom-properties-values" + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties-for-orgs "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization - description: Gets a report of premium request usage for an organization. To - use this endpoint, you must be an administrator of an organization within - an enterprise or an organization account. + description: |- + Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-org @@ -5701,6 +5968,12 @@ paths: - github - partner - custom + version: + description: The version of the runner image to deploy. This + is relevant only for runners using custom images. + type: + - string + - 'null' size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -5718,6 +5991,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_gen: + description: Whether this runner should be used to generate custom + images. + type: boolean + default: false required: - name - image @@ -5749,6 +6027,197 @@ paths: githubCloudOnly: false category: actions subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom": + get: + summary: List custom images for an organization + description: |- + List custom images for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-images-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": + get: + summary: Get a custom image definition for GitHub Actions Hosted Runners + description: |- + Get a custom image definition for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete a custom image from the organization + description: |- + Delete a custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": + get: + summary: List image versions of a custom image for an organization + description: |- + List image versions of a custom image for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-image-versions-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization + parameters: + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - image_versions + properties: + total_count: + type: integer + image_versions: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": + get: + summary: Get an image version of a custom image for GitHub Actions Hosted Runners + description: |- + Get an image version of a custom image for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-version-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/actions-custom-image-version" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-version" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete an image version of custom image from the organization + description: |- + Delete an image version of custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-version-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/actions-custom-image-version" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/images/github-owned": get: summary: Get GitHub-owned images for GitHub-hosted runners in an organization @@ -6005,6 +6474,12 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_version: + description: The version of the runner image to deploy. This is + relevant only for runners using custom images. + type: + - string + - 'null' examples: default: value: @@ -9055,7 +9530,8 @@ paths: type: string description: |- Optional filter for fetching attestations with a given predicate type. - This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. required: - subject_digests examples: @@ -9221,6 +9697,54 @@ paths: enabledForGitHubApps: true category: orgs subcategory: attestations + "/orgs/{org}/attestations/repositories": + get: + summary: List attestation repositories + description: |- + List repositories owned by the provided organization that have created at least one attested artifact + Results will be sorted in ascending order by repository ID + tags: + - orgs + operationId: orgs/list-attestation-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#list-attestation-repositories + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/org" + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + examples: + default: + "$ref": "#/components/examples/list-attestation-repositories" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations "/orgs/{org}/attestations/{attestation_id}": delete: summary: Delete attestations by ID @@ -9285,7 +9809,8 @@ paths: - name: predicate_type description: |- Optional filter for fetching attestations with a given predicate type. - This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. in: query required: false schema: @@ -9563,7 +10088,9 @@ paths: format: uri code_scanning_alerts: description: The code scanning alerts to include in this campaign - type: array + type: + - array + - 'null' minItems: 1 items: type: object @@ -9590,7 +10117,11 @@ paths: - name - description - ends_at - - code_scanning_alerts + oneOf: + - required: + - code_scanning_alerts + - required: + - secret_scanning_alerts examples: default: value: @@ -11974,8 +12505,6 @@ paths: - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" - "$ref": "#/components/parameters/per-page" responses: '200': @@ -16692,17 +17221,19 @@ paths: schema: type: string - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/per-page" @@ -16814,17 +17345,19 @@ paths: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/item-id" - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -25403,7 +25936,8 @@ paths: - name: predicate_type description: |- Optional filter for fetching attestations with a given predicate type. - This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. in: query required: false schema: @@ -32333,14 +32867,6 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" - - name: page - description: "**Closing down notice**. Page number of the results to fetch. - Use cursor-based pagination with `before` or `after` instead." - deprecated: true - 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)." @@ -32351,8 +32877,6 @@ paths: default: 30 - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" responses: '200': description: Response @@ -44635,6 +45159,9 @@ paths: description: |- Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + > [!NOTE] + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + OAuth 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: - secret-scanning @@ -53151,7 +53678,8 @@ paths: type: string description: |- Optional filter for fetching attestations with a given predicate type. - This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. required: - subject_digests examples: @@ -53380,7 +53908,8 @@ paths: - name: predicate_type description: |- Optional filter for fetching attestations with a given predicate type. - This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. in: query required: false schema: @@ -54458,17 +54987,19 @@ paths: schema: type: string - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -54576,17 +55107,19 @@ paths: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/item-id" - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -54950,7 +55483,10 @@ paths: "/users/{username}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for a user - description: Gets a report of premium request usage for a user. + description: |- + Gets a report of premium request usage for a user. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-user @@ -73832,6 +74368,13 @@ components: GitHub Actions workflow files. enum: - write + custom_properties_for_organizations: + type: string + description: The level of permission to grant the access token to view and + edit custom properties for an organization, when allowed by the property. + enum: + - read + - write members: type: string description: The level of permission to grant the access token for organization @@ -74008,6 +74551,14 @@ components: enum: - read - write + enterprise_custom_properties_for_organizations: + type: string + description: The level of permission to grant the access token for organization + custom properties management at the enterprise level. + enum: + - read + - write + - admin example: contents: read issues: read @@ -76466,424 +77017,6 @@ components: - fixed_at - repository additionalProperties: false - secret-scanning-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 - secret-scanning-alert-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 - - - secret-scanning-location-commit: - 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 - secret-scanning-location-wiki-commit: - 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 - secret-scanning-location-issue-title: - 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 - secret-scanning-location-issue-body: - 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 - secret-scanning-location-issue-comment: - 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 - secret-scanning-location-discussion-title: - 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 - secret-scanning-location-discussion-body: - 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 - secret-scanning-location-discussion-comment: - 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 - secret-scanning-location-pull-request-title: - 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 - secret-scanning-location-pull-request-body: - 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 - secret-scanning-location-pull-request-comment: - 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 - secret-scanning-location-pull-request-review: - 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 - secret-scanning-location-pull-request-review-comment: - 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 - secret-scanning-first-detected-location: - description: 'Details on the location where the token was initially detected. - This can be a commit, wiki commit, issue, discussion, pull request. - - ' - oneOf: - - "$ref": "#/components/schemas/secret-scanning-location-commit" - - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" - - "$ref": "#/components/schemas/secret-scanning-location-issue-title" - - "$ref": "#/components/schemas/secret-scanning-location-issue-body" - - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" - - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" - - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" - - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" - - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" - - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" - - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" - - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" - - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" - organization-secret-scanning-alert: - type: object - properties: - number: - "$ref": "#/components/schemas/alert-number" - created_at: - "$ref": "#/components/schemas/alert-created-at" - updated_at: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/alert-updated-at" - url: - "$ref": "#/components/schemas/alert-url" - html_url: - "$ref": "#/components/schemas/alert-html-url" - locations_url: - type: string - format: uri - description: The REST API URL of the code locations for this alert. - state: - "$ref": "#/components/schemas/secret-scanning-alert-state" - resolution: - "$ref": "#/components/schemas/secret-scanning-alert-resolution" - 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' - - "$ref": "#/components/schemas/simple-user" - 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`. - For 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: - "$ref": "#/components/schemas/simple-repository" - push_protection_bypassed: - type: - - boolean - - 'null' - description: Whether push protection was bypassed for the detected secret. - push_protection_bypassed_by: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - 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' - - "$ref": "#/components/schemas/simple-user" - 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' - - "$ref": "#/components/schemas/secret-scanning-first-detected-location" - 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. - assigned_to: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" enterprise-team: title: Enterprise Team description: Group of enterprise owners and/or members @@ -76948,404 +77081,104 @@ components: - created_at - updated_at - group_id - actor: - title: Actor - description: Actor + organization-simple: + title: Organization Simple + description: A GitHub organization. type: object properties: - id: - type: integer login: type: string - display_login: + examples: + - github + id: + type: integer + examples: + - 1 + node_id: type: string - gravatar_id: - type: - - string - - 'null' + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= url: type: string format: uri - avatar_url: + examples: + - https://api.github.com/orgs/github + repos_url: type: string format: uri - required: - - id - - login - - gravatar_id - - url - - avatar_url - label: - title: Label - description: Color-coded labels help you categorize and filter your issues (just - like labels in Gmail). - type: object - properties: - id: - description: Unique identifier for the label. - type: integer - format: int64 examples: - - 208045946 - node_id: + - https://api.github.com/orgs/github/repos + events_url: type: string + format: uri examples: - - MDU6TGFiZWwyMDgwNDU5NDY= - url: - description: URL for the label + - https://api.github.com/orgs/github/events + hooks_url: type: string - format: uri examples: - - https://api.github.com/repositories/42/labels/bug - name: - description: The name of the label. + - https://api.github.com/orgs/github/hooks + issues_url: type: string examples: - - bug + - 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: - description: Optional description of the label, such as its purpose. type: - string - 'null' examples: - - Something isn't working - color: - description: '6-character hex code, without the leading #, identifying the - color' - type: string - examples: - - FFFFFF - default: - description: Whether this label comes by default in a new repository. - type: boolean - examples: - - true + - A great organization required: + - login + - url - id - node_id - - url - - name + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url - description - - color - - default - discussion: - title: Discussion - description: A Discussion in a repository. + actor: + title: Actor + description: Actor type: object properties: - active_lock_reason: - type: - - string - - 'null' - answer_chosen_at: - type: - - string - - 'null' - answer_chosen_by: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - answer_html_url: - type: - - string - - 'null' - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - type: string - category: - type: object - properties: - created_at: - type: string - format: date-time - description: - type: string - emoji: - type: string - id: - type: integer - is_answerable: - type: boolean - name: - type: string - node_id: - type: string - repository_id: - type: integer - slug: - type: string - updated_at: - type: string - required: - - id - - repository_id - - emoji - - name - - description - - created_at - - updated_at - - slug - - is_answerable - comments: - type: integer - created_at: - type: string - format: date-time - html_url: - type: string id: type: integer - locked: - type: boolean - node_id: - type: string - number: - type: integer - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: + login: type: string - state: + display_login: type: string - description: |- - The current state of the discussion. - `converting` means that the discussion is being converted from an issue. - `transferring` means that the discussion is being transferred from another repository. - enum: - - open - - closed - - locked - - converting - - transferring - state_reason: - description: The reason for the current state + gravatar_id: type: - string - 'null' - enum: - - resolved - - outdated - - duplicate - - reopened - - - examples: - - resolved - timeline_url: - type: string - title: + url: type: string - updated_at: + format: uri + avatar_url: type: string - format: date-time - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - labels: - type: array - items: - "$ref": "#/components/schemas/label" + format: uri required: - - repository_url - - category - - answer_html_url - - answer_chosen_at - - answer_chosen_by - - html_url - id - - node_id - - number - - title - - user - - state - - state_reason - - locked - - comments - - created_at - - updated_at - - active_lock_reason - - body + - login + - gravatar_id + - url + - avatar_url milestone: title: Milestone description: A collection of related issues and pull requests. @@ -77953,256 +77786,11 @@ components: - node_id - html_url - issue_url + - author_association - user - url - created_at - updated_at - pull-request-minimal: - 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 - release-asset: - title: Release Asset - description: Data related to a release. - type: object - properties: - url: - type: string - format: uri - browser_download_url: - type: string - format: uri - id: - type: integer - node_id: - type: string - name: - description: The file name of the asset. - type: string - examples: - - Team Environment - label: - type: - - string - - 'null' - state: - description: State of the release asset. - type: string - enum: - - uploaded - - open - content_type: - type: string - size: - type: integer - digest: - type: - - string - - 'null' - download_count: - type: integer - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - uploader: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - required: - - id - - name - - content_type - - size - - digest - - state - - url - - node_id - - download_count - - label - - uploader - - browser_download_url - - created_at - - updated_at - release: - title: Release - description: A release. - type: object - properties: - url: - type: string - format: uri - html_url: - type: string - format: uri - assets_url: - type: string - format: uri - upload_url: - type: string - tarball_url: - type: - - string - - 'null' - format: uri - zipball_url: - type: - - string - - 'null' - format: uri - id: - type: integer - node_id: - type: string - tag_name: - description: The name of the tag. - type: string - examples: - - v1.0.0 - target_commitish: - description: Specifies the commitish value that determines where the Git - tag is created from. - type: string - examples: - - master - name: - type: - - string - - 'null' - body: - type: - - string - - 'null' - draft: - description: true to create a draft (unpublished) release, false to create - a published one. - type: boolean - examples: - - false - prerelease: - description: Whether to identify the release as a prerelease or a full release. - type: boolean - examples: - - false - immutable: - description: Whether or not the release is immutable. - type: boolean - examples: - - false - created_at: - type: string - format: date-time - published_at: - type: - - string - - 'null' - format: date-time - updated_at: - type: - - string - - 'null' - format: date-time - author: - "$ref": "#/components/schemas/simple-user" - assets: - type: array - items: - "$ref": "#/components/schemas/release-asset" - body_html: - type: string - body_text: - type: string - mentions_count: - type: integer - discussion_url: - description: The URL of the release discussion. - type: string - format: uri - reactions: - "$ref": "#/components/schemas/reaction-rollup" - required: - - assets_url - - upload_url - - tarball_url - - zipball_url - - created_at - - published_at - - draft - - id - - node_id - - author - - html_url - - name - - prerelease - - tag_name - - target_commitish - - assets - - url event: title: Event description: Event @@ -78233,23 +77821,33 @@ components: org: "$ref": "#/components/schemas/actor" payload: - oneOf: - - "$ref": "#/components/schemas/events/create-event" - - "$ref": "#/components/schemas/events/delete-event" - - "$ref": "#/components/schemas/events/discussion-event" - - "$ref": "#/components/schemas/events/issues-event" - - "$ref": "#/components/schemas/events/issue-comment-event" - - "$ref": "#/components/schemas/events/fork-event" - - "$ref": "#/components/schemas/events/gollum-event" - - "$ref": "#/components/schemas/events/member-event" - - "$ref": "#/components/schemas/events/public-event" - - "$ref": "#/components/schemas/events/push-event" - - "$ref": "#/components/schemas/events/pull-request-event" - - "$ref": "#/components/schemas/events/pull-request-review-comment-event" - - "$ref": "#/components/schemas/events/pull-request-review-event" - - "$ref": "#/components/schemas/events/commit-comment-event" - - "$ref": "#/components/schemas/events/release-event" - - "$ref": "#/components/schemas/events/watch-event" + type: object + properties: + action: + type: string + issue: + "$ref": "#/components/schemas/issue" + comment: + "$ref": "#/components/schemas/issue-comment" + 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: @@ -79957,77 +79555,6 @@ components: - reason - url - subscribed - organization-simple: - 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 dependabot-repository-access-details: title: Dependabot Repository Access Details description: Information about repositories that Dependabot is able to access @@ -80052,6 +79579,28 @@ components: - type: 'null' - "$ref": "#/components/schemas/simple-repository" additionalProperties: false + custom-property-value: + 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 billing-premium-request-usage-report-org: type: object properties: @@ -80102,19 +79651,19 @@ components: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -80647,6 +80196,11 @@ components: - github - partner - custom + version: + description: The image version of the hosted runner pool. + type: string + examples: + - latest required: - id - size_gb @@ -80771,6 +80325,9 @@ components: format: date-time examples: - '2022-10-09T23:39:01Z' + image_gen: + type: boolean + description: Whether custom image generation is enabled for the hosted runners. required: - id - name @@ -80779,6 +80336,97 @@ components: - status - public_ip_enabled - platform + actions-hosted-runner-custom-image: + title: GitHub-hosted runner custom image details + description: Provides details of a custom 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: integer + examples: + - 1 + platform: + description: The operating system of the image. + type: string + examples: + - linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + examples: + - 200 + name: + description: Display name for this image. + type: string + examples: + - CustomImage + source: + description: The image provider. + type: string + examples: + - custom + versions_count: + description: The number of image versions associated with the image. + type: integer + examples: + - 4 + latest_version: + description: The latest image version associated with the image. + type: string + examples: + - 1.3.0 + state: + description: The number of image versions associated with the image. + type: string + examples: + - Ready + required: + - id + - platform + - name + - source + - versions_count + - total_versions_size + - latest_version + - state + actions-hosted-runner-custom-image-version: + title: GitHub-hosted runner custom image version details. + description: Provides details of a hosted runner custom image version + type: object + properties: + version: + description: The version of image. + type: string + examples: + - 1.0.0 + state: + description: The state of image version. + type: string + examples: + - Ready + size_gb: + description: Image version size in GB. + type: integer + examples: + - 30 + created_on: + description: The creation date time of the image version. + type: string + examples: + - '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + examples: + - None + required: + - version + - state + - size_gb + - created_on + - state_details actions-hosted-runner-curated-image: title: GitHub-hosted runner image details. description: Provides details of a hosted runner image @@ -81357,6 +81005,13 @@ components: enum: - open - closed + campaign-alert-type: + title: Campaign alert type + description: Indicates the alert type of a campaign + type: string + enum: + - code_scanning + - secret_scanning team-simple: title: Team Simple description: Groups of organization members that gives permissions on specified @@ -85089,28 +84744,6 @@ components: - org_actors required: - value_type - custom-property-value: - 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 org-repo-custom-property-values: title: Organization Repository Custom Property Values description: List of custom property values for a repository @@ -86946,6 +86579,424 @@ components: state: type: object description: The state of the ruleset version + secret-scanning-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 + secret-scanning-alert-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 + - + secret-scanning-location-commit: + 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 + secret-scanning-location-wiki-commit: + 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 + secret-scanning-location-issue-title: + 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 + secret-scanning-location-issue-body: + 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 + secret-scanning-location-issue-comment: + 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 + secret-scanning-location-discussion-title: + 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 + secret-scanning-location-discussion-body: + 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 + secret-scanning-location-discussion-comment: + 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 + secret-scanning-location-pull-request-title: + 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 + secret-scanning-location-pull-request-body: + 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 + secret-scanning-location-pull-request-comment: + 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 + secret-scanning-location-pull-request-review: + 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 + secret-scanning-location-pull-request-review-comment: + 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 + secret-scanning-first-detected-location: + description: 'Details on the location where the token was initially detected. + This can be a commit, wiki commit, issue, discussion, pull request. + + ' + oneOf: + - "$ref": "#/components/schemas/secret-scanning-location-commit" + - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + - "$ref": "#/components/schemas/secret-scanning-location-issue-title" + - "$ref": "#/components/schemas/secret-scanning-location-issue-body" + - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" + organization-secret-scanning-alert: + type: object + properties: + number: + "$ref": "#/components/schemas/alert-number" + created_at: + "$ref": "#/components/schemas/alert-created-at" + updated_at: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/alert-updated-at" + url: + "$ref": "#/components/schemas/alert-url" + html_url: + "$ref": "#/components/schemas/alert-html-url" + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: + "$ref": "#/components/schemas/secret-scanning-alert-state" + resolution: + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + 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' + - "$ref": "#/components/schemas/simple-user" + 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`. + For 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: + "$ref": "#/components/schemas/simple-repository" + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + 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' + - "$ref": "#/components/schemas/simple-user" + 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' + - "$ref": "#/components/schemas/secret-scanning-first-detected-location" + 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. + assigned_to: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" secret-scanning-row-version: type: - string @@ -89390,6 +89441,73 @@ components: required: - path - sha + pull-request-minimal: + 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 simple-commit: title: Simple Commit description: A commit. @@ -96358,6 +96476,59 @@ components: - "$ref": "#/components/schemas/moved-column-in-project-issue-event" - "$ref": "#/components/schemas/removed-from-project-issue-event" - "$ref": "#/components/schemas/converted-note-to-issue-issue-event" + label: + title: Label + description: Color-coded labels help you categorize and filter your issues (just + like labels in Gmail). + type: object + properties: + id: + description: Unique identifier for the label. + type: integer + format: int64 + examples: + - 208045946 + node_id: + type: string + examples: + - MDU6TGFiZWwyMDgwNDU5NDY= + url: + description: URL for the label + type: string + format: uri + examples: + - https://api.github.com/repositories/42/labels/bug + name: + description: The name of the label. + type: string + examples: + - bug + description: + description: Optional description of the label, such as its purpose. + type: + - string + - 'null' + examples: + - Something isn't working + color: + description: '6-character hex code, without the leading #, identifying the + color' + type: string + examples: + - FFFFFF + default: + description: Whether this label comes by default in a new repository. + type: boolean + examples: + - true + required: + - id + - node_id + - url + - name + - description + - color + - default timeline-comment-event: title: Timeline Comment Event description: Timeline Comment Event @@ -98318,6 +98489,185 @@ components: - author_association - created_at - updated_at + release-asset: + title: Release Asset + description: Data related to a release. + type: object + properties: + url: + type: string + format: uri + browser_download_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + name: + description: The file name of the asset. + type: string + examples: + - Team Environment + label: + type: + - string + - 'null' + state: + description: State of the release asset. + type: string + enum: + - uploaded + - open + content_type: + type: string + size: + type: integer + digest: + type: + - string + - 'null' + download_count: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + uploader: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - id + - name + - content_type + - size + - digest + - state + - url + - node_id + - download_count + - label + - uploader + - browser_download_url + - created_at + - updated_at + release: + title: Release + description: A release. + type: object + properties: + url: + type: string + format: uri + html_url: + type: string + format: uri + assets_url: + type: string + format: uri + upload_url: + type: string + tarball_url: + type: + - string + - 'null' + format: uri + zipball_url: + type: + - string + - 'null' + format: uri + id: + type: integer + node_id: + type: string + tag_name: + description: The name of the tag. + type: string + examples: + - v1.0.0 + target_commitish: + description: Specifies the commitish value that determines where the Git + tag is created from. + type: string + examples: + - master + name: + type: + - string + - 'null' + body: + type: + - string + - 'null' + draft: + description: true to create a draft (unpublished) release, false to create + a published one. + type: boolean + examples: + - false + prerelease: + description: Whether to identify the release as a prerelease or a full release. + type: boolean + examples: + - false + immutable: + description: Whether or not the release is immutable. + type: boolean + examples: + - false + created_at: + type: string + format: date-time + published_at: + type: + - string + - 'null' + format: date-time + updated_at: + type: + - string + - 'null' + format: date-time + author: + "$ref": "#/components/schemas/simple-user" + assets: + type: array + items: + "$ref": "#/components/schemas/release-asset" + body_html: + type: string + body_text: + type: string + mentions_count: + type: integer + discussion_url: + description: The URL of the release discussion. + type: string + format: uri + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - assets_url + - upload_url + - tarball_url + - zipball_url + - created_at + - published_at + - draft + - id + - node_id + - author + - html_url + - name + - prerelease + - tag_name + - target_commitish + - assets + - url release-notes-content: title: Generated Release Notes Content description: Generated name and body describing a release @@ -101269,19 +101619,19 @@ components: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -103182,6 +103532,325 @@ components: - created_at - updated_at - body + discussion: + title: Discussion + description: A Discussion in a repository. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + answer_chosen_at: + type: + - string + - 'null' + answer_chosen_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + answer_html_url: + type: + - string + - 'null' + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + type: string + category: + type: object + properties: + created_at: + type: string + format: date-time + description: + type: string + emoji: + type: string + id: + type: integer + is_answerable: + type: boolean + name: + type: string + node_id: + type: string + repository_id: + type: integer + slug: + type: string + updated_at: + type: string + required: + - id + - repository_id + - emoji + - name + - description + - created_at + - updated_at + - slug + - is_answerable + comments: + type: integer + created_at: + type: string + format: date-time + html_url: + type: string + id: + type: integer + locked: + type: boolean + node_id: + type: string + number: + type: integer + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + state: + type: string + description: |- + The current state of the discussion. + `converting` means that the discussion is being converted from an issue. + `transferring` means that the discussion is being transferred from another repository. + enum: + - open + - closed + - locked + - converting + - transferring + state_reason: + description: The reason for the current state + type: + - string + - 'null' + enum: + - resolved + - outdated + - duplicate + - reopened + - + examples: + - resolved + timeline_url: + type: string + title: + type: string + updated_at: + type: string + format: date-time + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + labels: + type: array + items: + "$ref": "#/components/schemas/label" + required: + - repository_url + - category + - answer_html_url + - answer_chosen_at + - answer_chosen_by + - html_url + - id + - node_id + - number + - title + - user + - state + - state_reason + - locked + - comments + - created_at + - updated_at + - author_association + - active_lock_reason + - body webhooks_comment: type: object properties: @@ -208453,778 +209122,63 @@ components: format: uri user_view_type: type: string - required: - - login - - id - updated_at: - type: string - format: date-time - url: - type: string - format: uri - workflow_id: - type: integer - workflow_url: - type: string - format: uri - display_title: - type: string - required: - - artifacts_url - - cancel_url - - check_suite_url - - check_suite_id - - check_suite_node_id - - conclusion - - created_at - - event - - head_branch - - head_commit - - head_repository - - head_sha - - html_url - - id - - jobs_url - - logs_url - - node_id - - name - - path - - pull_requests - - repository - - rerun_url - - run_number - - status - - updated_at - - url - - workflow_id - - workflow_url - - run_attempt - - run_started_at - - previous_attempt_url - - actor - - triggering_actor - - display_title - required: - - action - - repository - - sender - - workflow - - workflow_run - create-event: - title: CreateEvent - type: object - properties: - ref: - type: string - ref_type: - type: string - full_ref: - type: string - master_branch: - type: string - description: - type: - - string - - 'null' - pusher_type: - type: string - required: - - ref - - ref_type - - full_ref - - master_branch - - pusher_type - delete-event: - title: DeleteEvent - type: object - properties: - ref: - type: string - ref_type: - type: string - full_ref: - type: string - pusher_type: - type: string - required: - - ref - - ref_type - - full_ref - - pusher_type - discussion-event: - title: DiscussionEvent - type: object - properties: - action: - type: string - discussion: - "$ref": "#/components/schemas/discussion" - required: - - action - - discussion - issues-event: - title: IssuesEvent - type: object - properties: - action: - type: string - issue: - "$ref": "#/components/schemas/issue" - assignee: - "$ref": "#/components/schemas/simple-user" - assignees: - type: array - items: - "$ref": "#/components/schemas/simple-user" - label: - "$ref": "#/components/schemas/label" - labels: - type: array - items: - "$ref": "#/components/schemas/label" - required: - - action - - issue - issue-comment-event: - title: IssueCommentEvent - type: object - properties: - action: - type: string - issue: - "$ref": "#/components/schemas/issue" - comment: - "$ref": "#/components/schemas/issue-comment" - required: - - action - - issue - - comment - fork-event: - title: ForkEvent - type: object - properties: - action: - type: string - forkee: - type: object - properties: - id: - type: integer - node_id: - type: string - name: - type: string - full_name: - type: string - private: - type: boolean - owner: - "$ref": "#/components/schemas/simple-user" - html_url: - type: string - description: - type: - - string - - 'null' - fork: - type: boolean - url: - type: string - forks_url: - type: string - keys_url: - type: string - collaborators_url: - type: string - teams_url: - type: string - hooks_url: - type: string - issue_events_url: - type: string - events_url: - type: string - assignees_url: - type: string - branches_url: - type: string - tags_url: - type: string - blobs_url: - type: string - git_tags_url: - type: string - git_refs_url: - type: string - trees_url: - type: string - statuses_url: - type: string - languages_url: - type: string - stargazers_url: - type: string - contributors_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - commits_url: - type: string - git_commits_url: - type: string - comments_url: - type: string - issue_comment_url: - type: string - contents_url: - type: string - compare_url: - type: string - merges_url: - type: string - archive_url: - type: string - downloads_url: - type: string - issues_url: - type: string - pulls_url: - type: string - milestones_url: - type: string - notifications_url: - type: string - labels_url: - type: string - releases_url: - type: string - deployments_url: - type: string - created_at: - type: - - string - - 'null' - format: date-time - updated_at: - type: - - string - - 'null' - format: date-time - pushed_at: - type: - - string - - 'null' - format: date-time - git_url: - type: string - ssh_url: - type: string - clone_url: - type: string - svn_url: - type: string - homepage: - type: - - string - - 'null' - size: - type: integer - stargazers_count: - type: integer - watchers_count: - type: integer - language: - type: - - string - - 'null' - has_issues: - type: boolean - has_projects: - type: boolean - has_downloads: - type: boolean - has_wiki: - type: boolean - has_pages: - type: boolean - has_discussions: - type: boolean - forks_count: - type: integer - mirror_url: - type: - - string - - 'null' - archived: - type: boolean - disabled: - type: boolean - open_issues_count: - type: integer - license: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/license-simple" - allow_forking: - type: boolean - is_template: - type: boolean - web_commit_signoff_required: - type: boolean - topics: - type: array - items: - type: string - visibility: - type: string - forks: - type: integer - open_issues: - type: integer - watchers: - type: integer - default_branch: - type: string - public: - type: boolean - required: - - action - - forkee - gollum-event: - title: GollumEvent - type: object - properties: - pages: - type: array - items: - type: object - properties: - page_name: - type: - - string - - 'null' - title: - type: - - string - - 'null' - summary: - type: - - string - - 'null' - action: - type: string - sha: - type: string - html_url: - type: string - required: - - pages - member-event: - title: MemberEvent - type: object - properties: - action: - type: string - member: - "$ref": "#/components/schemas/simple-user" - required: - - action - - member - public-event: - title: PublicEvent - type: object - push-event: - title: PushEvent - type: object - properties: - repository_id: - type: integer - push_id: - type: integer - ref: - type: string - head: - type: string - before: - type: string - required: - - repository_id - - push_id - - ref - - head - - before - pull-request-event: - title: PullRequestEvent - type: object - properties: - action: - type: string - number: - type: integer - pull_request: - "$ref": "#/components/schemas/pull-request-minimal" - assignee: - "$ref": "#/components/schemas/simple-user" - assignees: - type: array - items: - "$ref": "#/components/schemas/simple-user" - label: - "$ref": "#/components/schemas/label" - labels: - type: array - items: - "$ref": "#/components/schemas/label" - required: - - action - - number - - pull_request - pull-request-review-comment-event: - title: PullRequestReviewCommentEvent - type: object - properties: - action: - type: string - pull_request: - "$ref": "#/components/schemas/pull-request-minimal" - comment: - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - format: uri - pull_request_review_id: - type: - - integer - - 'null' - diff_hunk: - type: string - path: - type: string - position: - type: - - integer - - 'null' - original_position: - type: integer - subject_type: - type: - - string - - 'null' - commit_id: - type: string - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - body: - type: string - created_at: - type: string - format: date-time + required: + - login + - id updated_at: type: string format: date-time - html_url: + url: type: string format: uri - pull_request_url: + workflow_id: + type: integer + workflow_url: type: string format: uri - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - original_commit_id: + display_title: type: string - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - in_reply_to_id: - type: integer required: - - url - - pull_request_review_id + - artifacts_url + - cancel_url + - check_suite_url + - check_suite_id + - check_suite_node_id + - conclusion + - created_at + - event + - head_branch + - head_commit + - head_repository + - head_sha + - html_url - id + - jobs_url + - logs_url - node_id - - diff_hunk + - name - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at + - pull_requests + - repository + - rerun_url + - run_number + - status - updated_at - - html_url - - pull_request_url - - _links - - reactions - required: - - action - - comment - - pull_request - pull-request-review-event: - title: PullRequestReviewEvent - type: object - properties: - action: - type: string - review: - type: object - properties: - id: - type: integer - node_id: - type: string - user: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - body: - type: string - commit_id: - type: string - submitted_at: - type: - - string - - 'null' - state: - type: string - html_url: - type: string - format: uri - pull_request_url: - type: string - format: uri - _links: - type: object - properties: - html: - type: object - properties: - href: - type: string - required: - - href - pull_request: - type: object - properties: - href: - type: string - required: - - href - required: - - html - - pull_request - updated_at: - type: string - pull_request: - "$ref": "#/components/schemas/pull-request-minimal" - required: - - action - - review - - pull_request - commit-comment-event: - title: CommitCommentEvent - type: object - properties: - action: - type: string - comment: - type: object - properties: - html_url: - type: string - format: uri - url: - type: string - format: uri - id: - type: integer - node_id: - type: string - body: - type: string - path: - type: - - string - - 'null' - position: - type: - - integer - - 'null' - line: - type: - - integer - - 'null' - commit_id: - type: string - user: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - reactions: - "$ref": "#/components/schemas/reaction-rollup" - required: - - action - - comment - release-event: - title: ReleaseEvent - type: object - properties: - action: - type: string - release: - allOf: - - "$ref": "#/components/schemas/release" - - type: object - properties: - is_short_description_html_truncated: - type: boolean - short_description_html: - type: string - required: - - action - - release - watch-event: - title: WatchEvent - type: object - properties: - action: - type: string + - url + - workflow_id + - workflow_url + - run_attempt + - run_started_at + - previous_attempt_url + - actor + - triggering_actor + - display_title required: - action + - repository + - sender + - workflow + - workflow_run examples: root: value: @@ -212583,181 +212537,6 @@ components: 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} - organization-secret-scanning-alert-list: - 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 - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://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 - has_more_locations: true - assigned_to: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false enterprise-teams-items: value: - id: 1 @@ -212810,6 +212589,34 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false + organization-simple: + value: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + organization-simple-items: + value: + - login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization public-events-items: value: - id: '22249084947' @@ -214185,20 +213992,6 @@ components: ~~~~~~==~==~~~==~==~~~~~~ ~~~~~~==~==~==~==~~~~~~ :~==~==~==~==~~ - organization-simple-items: - value: - - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization dependabot-repository-access-details: value: default_level: public @@ -214271,6 +214064,23 @@ components: 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 + custom-property-values: + value: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + create-or-update-custom-properties-values: + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat billing-premium-request-usage-report-org: value: timePeriod: @@ -214452,6 +214262,34 @@ components: prefix: 20.80.208.150 length: 31 last_active_on: '2022-10-09T23:39:01Z' + actions-hosted-runner-custom-image-versions: + value: + total_count: 2 + image_versions: + - version: 1.1.0 + size_gb: 75 + state: Ready + created_on: '2024-11-09T23:39:01Z' + - version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + actions-hosted-runner-custom-image: + value: + id: 1 + platform: linux-x64 + name: CustomImage + source: custom + versions_count: 4 + total_versions_size: 200 + latest_version: 1.3.0 + state: Ready + actions-hosted-runner-custom-image-version: + value: + version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' actions-hosted-runner-curated-image: value: id: ubuntu-20.04 @@ -215296,6 +215134,12 @@ components: signatures: - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== repository_id: 1 + list-attestation-repositories: + value: + - id: 123 + name: foo + - id: 456 + name: bar list-attestations: value: attestations: @@ -219518,6 +219362,181 @@ components: parameters: operator: contains pattern: github + organization-secret-scanning-alert-list: + 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 + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://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 + has_more_locations: true + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false secret-scanning-pattern-configuration: value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K @@ -229287,23 +229306,6 @@ components: site_admin: false created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' - custom-property-values: - value: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat - create-or-update-custom-properties-values: - value: - properties: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat pull-request: value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 @@ -237798,109 +237800,6 @@ components: - updated - epss_percentage default: created - pagination-first: - name: first - description: |- - **Deprecated**. The number of results per page (max 100), starting from the first matching result. - This parameter must not be used in combination with `last`. - Instead, 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 - pagination-last: - name: last - description: |- - **Deprecated**. The number of results per page (max 100), starting from the last matching result. - This parameter must not be used in combination with `first`. - Instead, 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 - secret-scanning-alert-state: - 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 - secret-scanning-alert-secret-type: - 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 - secret-scanning-alert-resolution: - 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 - secret-scanning-alert-sort: - 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 - secret-scanning-alert-validity: - 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 - secret-scanning-alert-publicly-leaked: - 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 - secret-scanning-alert-multi-repo: - 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 - secret-scanning-alert-hide-secret: - 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 enterprise-team: name: enterprise-team description: The slug version of the enterprise team name. You can also substitute @@ -237916,6 +237815,13 @@ components: required: true schema: type: string + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string team-slug: name: team_slug description: The slug of the team name. @@ -238037,13 +237943,6 @@ components: required: false schema: type: integer - org: - name: org - description: The organization name. The name is not case sensitive. - in: path - required: true - schema: - type: string billing-usage-report-year: name: year description: If specified, only return results for a single year. The value @@ -238110,6 +238009,21 @@ components: required: false schema: type: integer + actions-custom-image-definition-id: + name: image_definition_id + description: Image definition ID of custom image + in: path + required: true + schema: + type: integer + actions-custom-image-version: + name: version + description: Version of a custom image + in: path + required: true + schema: + type: string + pattern: "^\\d+\\.\\d+\\.\\d+$" hosted-runner-id: name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. @@ -238622,6 +238536,48 @@ components: required: true schema: type: integer + secret-scanning-alert-state: + 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 + secret-scanning-alert-secret-type: + 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-sca{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}