diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 729ba38e5..1a3134d9e 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -104,10 +104,6 @@ "name": "packages", "description": "Manage packages for authenticated users and organizations." }, - { - "name": "projects-classic", - "description": "Interact with GitHub Projects (classic)." - }, { "name": "pulls", "description": "Interact with GitHub Pull Requests." @@ -7885,10 +7881,7 @@ }, "examples": { "update-budget": { - "value": { - "message": "Budget successfully updated.", - "id": "550e8400-e29b-41d4-a716-446655440000" - } + "$ref": "#/components/examples/update-budget" } } } @@ -26651,6 +26644,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -29639,252 +29635,6 @@ } } }, - "/orgs/{org}/teams/{team_slug}/projects": { - "get": { - "summary": "List team projects", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/list-projects-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-projects" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/team-project" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/team-project-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/team-project" - }, - "examples": { - "default": { - "$ref": "#/components/examples/team-project" - } - } - } - } - }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - }, - "nullable": true - }, - "examples": { - "default": { - "summary": "Updates the permissions for the team to write for the project", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/orgs/{org}/teams/{team_slug}/repos": { "get": { "summary": "List team repositories", @@ -30225,555 +29975,6 @@ "deprecated": true } }, - "/projects/columns/{column_id}": { - "get": { - "summary": "Get a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#get-a-project-column" - }, - "parameters": [ - { - "$ref": "#/components/parameters/column-id" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-column" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-column" - } - } - } - } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update an existing project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/update-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column" - }, - "parameters": [ - { - "$ref": "#/components/parameters/column-id" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Rename the project column", - "value": { - "name": "To Do" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-column" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-column" - } - } - } - } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/delete-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#delete-a-project-column" - }, - "parameters": [ - { - "$ref": "#/components/parameters/column-id" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/{column_id}/moves": { - "post": { - "summary": "Move a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/move-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#move-a-project-column" - }, - "parameters": [ - { - "$ref": "#/components/parameters/column-id" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "example": "last", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$" - } - }, - "required": [ - "position" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Move the column to the end of the board", - "value": { - "position": "last" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators": { - "get": { - "summary": "List project collaborators", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/list-collaborators", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "name": "affiliation", - "description": "Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "outside", - "direct", - "all" - ], - "default": "all" - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/simple-user" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/simple-user-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}": { - "put": { - "summary": "Add project collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/add-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "$ref": "#/components/parameters/username" - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "example": "write", - "type": "string" - } - }, - "nullable": true - }, - "examples": { - "default": { - "summary": "Applying write permissions for the new collaborator", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove user as a collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/remove-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "$ref": "#/components/parameters/username" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}/permission": { - "get": { - "summary": "Get project permission for a user", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-permission-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "$ref": "#/components/parameters/username" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-collaborator-permission" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-collaborator-permission" - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", @@ -61772,6 +60973,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -61898,7 +61102,7 @@ }, "patch": { "summary": "Update a secret scanning alert", - "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "operationId": "secret-scanning/update-alert", "tags": [ "secret-scanning" @@ -61933,6 +61137,9 @@ }, "resolution_comment": { "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + }, + "assignee": { + "$ref": "#/components/schemas/secret-scanning-alert-assignee" } }, "anyOf": [ @@ -61940,6 +61147,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -61949,6 +61161,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -61977,7 +61201,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment" + "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" }, "503": { "$ref": "#/components/responses/service_unavailable" @@ -66886,254 +66110,6 @@ "deprecated": true } }, - "/teams/{team_id}/projects": { - "get": { - "summary": "List team projects (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/list-projects-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-projects-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/team-project" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/team-project-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, - "/teams/{team_id}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-project-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/team-project" - }, - "examples": { - "default": { - "$ref": "#/components/examples/team-project" - } - } - } - } - }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - } - }, - "examples": { - "default": { - "summary": "Example of setting permission to read", - "value": { - "permission": "read" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, "/teams/{team_id}/repos": { "get": { "summary": "List team repositories (Legacy)", @@ -75394,120 +74370,312 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "projects" + } + } + }, + "/users/{username}/projectsV2/{project_number}": { + "get": { + "summary": "Get project for user", + "description": "Get a specific user-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/get-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/projects#get-project-for-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2" + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "projects" + } + } + }, + "/users/{username}/projectsV2/{project_number}/fields": { + "get": { + "summary": "List project fields for user", + "description": "List all fields for a specific user-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/list-fields-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/fields#list-project-fields-for-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/projects-v2-field" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2-field-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" } - } - }, - "/users/{username}/projectsV2/{project_number}": { - "get": { - "summary": "Get project for user", - "description": "Get a specific user-owned project.", + }, + "post": { + "summary": "Add field to user owned project", + "description": "Add a field to a specified user owned project.", "tags": [ "projects" ], - "operationId": "projects/get-for-user", + "operationId": "projects/add-field-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/projects#get-project-for-user" + "url": "https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project" }, "parameters": [ { - "$ref": "#/components/parameters/project-number" + "$ref": "#/components/parameters/username" }, { - "$ref": "#/components/parameters/username" + "$ref": "#/components/parameters/project-number" } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/projects-v2" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date", + "single_select", + "iteration" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "description": "The color associated with the option.", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + "description": { + "type": "string", + "description": "The description of the option." + } + } + } + }, + "iteration_configuration": { + "type": "object", + "description": "The configuration for iteration fields.", + "properties": { + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the first iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "description": "Zero or more iterations for the field.", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title for the iteration." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + } + } + } + } + } + } }, - "examples": { - "default": { - "$ref": "#/components/examples/projects-v2" + "required": [ + "name", + "data_type" + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select-request" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration-request" } } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" } }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects", - "subcategory": "projects" - } - } - }, - "/users/{username}/projectsV2/{project_number}/fields": { - "get": { - "summary": "List project fields for user", - "description": "List all fields for a specific user-owned project.", - "tags": [ - "projects" - ], - "operationId": "projects/list-fields-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/fields#list-project-fields-for-user" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-number" - }, - { - "$ref": "#/components/parameters/username" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/pagination-before" - }, - { - "$ref": "#/components/parameters/pagination-after" - } - ], "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/projects-v2-field" - } + "$ref": "#/components/schemas/projects-v2-field" }, "examples": { - "default": { - "$ref": "#/components/examples/projects-v2-field-items" + "text_field": { + "$ref": "#/components/examples/projects-v2-field-text" + }, + "number_field": { + "$ref": "#/components/examples/projects-v2-field-number" + }, + "date_field": { + "$ref": "#/components/examples/projects-v2-field-date" + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration" } } } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } } }, "304": { @@ -75518,6 +74686,9 @@ }, "401": { "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -96043,7 +95214,100 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-repository-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-import": { + "post": { + "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports).", + "operationId": "repository-import", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-import" } } } @@ -96056,22 +95320,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_import", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-import": { + "repository-privatized": { "post": { - "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports).", - "operationId": "repository-import", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The visibility of a repository was changed to `private`.", + "operationId": "repository/privatized", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -96136,7 +95399,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-import" + "$ref": "#/components/schemas/webhook-repository-privatized" } } } @@ -96149,19 +95412,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_import", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-privatized": { + "repository-publicized": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `private`.", - "operationId": "repository/privatized", + "description": "The visibility of a repository was changed to `public`.", + "operationId": "repository/publicized", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -96228,7 +95493,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-repository-publicized" } } } @@ -96251,11 +95516,11 @@ } } }, - "repository-publicized": { + "repository-renamed": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `public`.", - "operationId": "repository/publicized", + "description": "The name of a repository was changed.", + "operationId": "repository/renamed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -96322,7 +95587,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-repository-renamed" } } } @@ -96345,13 +95610,13 @@ } } }, - "repository-renamed": { + "repository-ruleset-created": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The name of a repository was changed.", - "operationId": "repository/renamed", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was created.", + "operationId": "repository-ruleset/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -96416,7 +95681,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" } } } @@ -96429,9 +95694,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -96439,11 +95703,11 @@ } } }, - "repository-ruleset-created": { + "repository-ruleset-deleted": { "post": { "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was created.", - "operationId": "repository-ruleset/created", + "description": "A repository ruleset was deleted.", + "operationId": "repository-ruleset/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, @@ -96510,7 +95774,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-created" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" } } } @@ -96532,11 +95796,11 @@ } } }, - "repository-ruleset-deleted": { + "repository-ruleset-edited": { "post": { "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was deleted.", - "operationId": "repository-ruleset/deleted", + "description": "A repository ruleset was edited.", + "operationId": "repository-ruleset/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, @@ -96603,7 +95867,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" } } } @@ -96625,13 +95889,13 @@ } } }, - "repository-ruleset-edited": { + "repository-transferred": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was edited.", - "operationId": "repository-ruleset/edited", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", + "operationId": "repository/transferred", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -96696,7 +95960,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-edited" + "$ref": "#/components/schemas/webhook-repository-transferred" } } } @@ -96709,8 +95973,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -96718,11 +95983,11 @@ } } }, - "repository-transferred": { + "repository-unarchived": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", - "operationId": "repository/transferred", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -96789,7 +96054,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-repository-unarchived" } } } @@ -96812,13 +96077,13 @@ } } }, - "repository-unarchived": { + "repository-vulnerability-alert-create": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -96883,7 +96148,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" } } } @@ -96896,21 +96161,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-vulnerability-alert-create": { + "repository-vulnerability-alert-dismiss": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was created.", - "operationId": "repository-vulnerability-alert/create", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -96977,7 +96240,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" } } } @@ -96998,11 +96261,11 @@ } } }, - "repository-vulnerability-alert-dismiss": { + "repository-vulnerability-alert-reopen": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was dismissed.", - "operationId": "repository-vulnerability-alert/dismiss", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -97069,7 +96332,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" } } } @@ -97090,11 +96353,11 @@ } } }, - "repository-vulnerability-alert-reopen": { + "repository-vulnerability-alert-resolve": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -97161,7 +96424,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" } } } @@ -97182,13 +96445,13 @@ } } }, - "repository-vulnerability-alert-resolve": { + "secret-scanning-alert-assigned": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was marked as resolved.", - "operationId": "repository-vulnerability-alert/resolve", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -97253,7 +96516,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" } } } @@ -97266,10 +96529,11 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } @@ -97438,22 +96702,116 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" - }, - "examples": { - "default": { - "$ref": "#/components/examples/secret-scanning-alert-location-created" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" - } + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "secret_scanning_alert_location", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "secret-scanning-alert-publicly-leaked": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" } } } @@ -97465,9 +96823,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -97476,11 +96833,11 @@ } } }, - "secret-scanning-alert-publicly-leaked": { + "secret-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was detected in a public repo.", - "operationId": "secret-scanning-alert/publicly-leaked", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -97547,7 +96904,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" } } } @@ -97569,11 +96926,11 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-resolved": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -97640,7 +96997,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -97662,11 +97019,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-unassigned": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -97733,7 +97090,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } @@ -102256,6 +101613,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -120153,96 +119518,6 @@ "url" ] }, - "team-project": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": "string", - "nullable": true - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "$ref": "#/components/schemas/simple-user" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - }, "team-repository": { "title": "Team Repository", "description": "A team's access to a repository.", @@ -120750,79 +120025,6 @@ "updated_at" ] }, - "project-column": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - }, - "cards_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" - }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" - }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:22:28Z" - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - }, - "project-collaborator-permission": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", - "type": "object", - "properties": { - "permission": { - "type": "string" - }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" - } - }, - "required": [ - "permission", - "user" - ] - }, "rate-limit": { "title": "Rate Limit", "type": "object", @@ -123062,6 +122264,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -133385,6 +132588,11 @@ "type": "string", "nullable": true }, + "secret-scanning-alert-assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true + }, "secret-scanning-location": { "type": "object", "properties": { @@ -152099,6 +151307,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -152902,6 +152117,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -266659,6 +265881,44 @@ "sender" ] }, + "webhook-secret-scanning-alert-assigned": { + "title": "secret_scanning_alert assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, "webhook-secret-scanning-alert-created": { "title": "secret_scanning_alert created event", "type": "object", @@ -266813,19 +266073,57 @@ "repository" ] }, - "webhook-secret-scanning-alert-resolved": { - "title": "secret_scanning_alert resolved event", + "webhook-secret-scanning-alert-resolved": { + "title": "secret_scanning_alert resolved event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "resolved" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, + "webhook-secret-scanning-alert-unassigned": { + "title": "secret_scanning_alert unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolved" + "unassigned" ] }, "alert": { "$ref": "#/components/schemas/secret-scanning-alert-webhook" }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, @@ -281834,6 +281132,27 @@ } } }, + "update-budget": { + "value": { + "message": "Budget successfully updated.", + "budget": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "org-name/example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } + } + }, "delete-budget": { "value": { "message": "Budget successfully deleted.", @@ -286560,21 +285879,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -289331,94 +288668,6 @@ "state": "pending" } }, - "team-project-items": { - "value": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ] - }, - "team-project": { - "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - }, "team-repository-alternative-response-with-repository-permissions": { "value": { "id": 1296269, @@ -289578,43 +288827,6 @@ } ] }, - "project-column": { - "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - }, - "project-collaborator-permission": { - "value": { - "permission": "admin", - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - }, "rate-limit-overview": { "value": { "resources": { @@ -302541,7 +301753,27 @@ "resolution_comment": "Example comment", "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://alambic.github.com/avatars/u/1?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "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-location-list": { @@ -307305,6 +306537,194 @@ } } }, + "projects-v2-field-single-select-request": { + "summary": "Create a single select field", + "value": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + } + }, + "projects-v2-field-iteration-request": { + "summary": "Create an iteration field", + "value": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + } + }, + "projects-v2-field-text": { + "value": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + } + }, + "projects-v2-field-number": { + "value": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + } + }, + "projects-v2-field-date": { + "value": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + } + }, + "projects-v2-field-single-select": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + }, + "projects-v2-field-iteration": { + "value": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + }, "user-received-events-items": { "value": [ { @@ -310249,6 +309669,29 @@ "type": "string" } }, + "secret-scanning-alert-assignee": { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, "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.", @@ -310365,15 +309808,6 @@ "type": "integer" } }, - "project-id": { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, "security-product": { "name": "security_product", "in": "path", @@ -310405,15 +309839,6 @@ ] } }, - "column-id": { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, "artifact-name": { "name": "name", "description": "The name field of an artifact. When specified, only artifacts with this name will be returned.", diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index ba0ae443b..f66acdcf4 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -57,8 +57,6 @@ tags: description: Interact with organizations. - name: packages description: Manage packages for authenticated users and organizations. -- name: projects-classic - description: Interact with GitHub Projects (classic). - name: pulls description: Interact with GitHub Pull Requests. - name: rate-limit @@ -5581,9 +5579,7 @@ paths: in the budget examples: update-budget: - value: - message: Budget successfully updated. - id: 550e8400-e29b-41d4-a716-446655440000 + "$ref": "#/components/examples/update-budget" '400': "$ref": "#/components/responses/bad_request" '401': @@ -19274,6 +19270,7 @@ paths: - "$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-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" @@ -21445,179 +21442,6 @@ paths: enabledForGitHubApps: true category: teams subcategory: members - "/orgs/{org}/teams/{team_slug}/projects": - get: - summary: List team projects - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/list-projects-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-projects - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": - get: - summary: Check team permissions for a project - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/check-permissions-for-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/project-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project" - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - put: - summary: Add or update team project permissions - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/add-or-update-project-permissions-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/project-id" - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - nullable: true - examples: - default: - summary: Updates the permissions for the team to write for the project - value: - permission: write - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Remove a project from a team - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/remove-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/project-id" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/orgs/{org}/teams/{team_slug}/repos": get: summary: List team repositories @@ -21872,402 +21696,6 @@ paths: deprecationDate: '2024-07-22' removalDate: '2025-07-22' deprecated: true - "/projects/columns/{column_id}": - get: - summary: Get a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#get-a-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-column" - examples: - default: - "$ref": "#/components/examples/project-column" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update an existing project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/update-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project column - example: Remaining tasks - type: string - required: - - name - type: object - examples: - default: - summary: Rename the project column - value: - name: To Do - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-column" - examples: - default: - "$ref": "#/components/examples/project-column" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/delete-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#delete-a-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - responses: - '204': - description: Response - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/columns/{column_id}/moves": - post: - summary: Move a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/move-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#move-a-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - requestBody: - required: true - content: - application/json: - schema: - properties: - position: - description: 'The position of the column in a project. Can be one - of: `first`, `last`, or `after:` to place after the - specified column.' - example: last - type: string - pattern: "^(?:first|last|after:\\d+)$" - required: - - position - type: object - examples: - default: - summary: Move the column to the end of the board - value: - position: last - responses: - '201': - description: Response - content: - application/json: - schema: - type: object - properties: {} - additionalProperties: false - examples: - default: - value: - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '422': - "$ref": "#/components/responses/validation_failed_simple" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators": - get: - summary: List project collaborators - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/list-collaborators - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators - parameters: - - "$ref": "#/components/parameters/project-id" - - name: affiliation - description: Filters the collaborators by their affiliation. `outside` means - outside collaborators of a project that are not a member of the project's - organization. `direct` means collaborators with permissions to a project, - regardless of organization membership status. `all` means all collaborators - the authenticated user can see. - in: query - required: false - schema: - type: string - enum: - - outside - - direct - - all - default: all - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/simple-user" - examples: - default: - "$ref": "#/components/examples/simple-user-items" - headers: - Link: - "$ref": "#/components/headers/link" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators/{username}": - put: - summary: Add project collaborator - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/add-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator - parameters: - - "$ref": "#/components/parameters/project-id" - - "$ref": "#/components/parameters/username" - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - description: The permission to grant the collaborator. - enum: - - read - - write - - admin - default: write - example: write - type: string - nullable: true - examples: - default: - summary: Applying write permissions for the new collaborator - value: - permission: write - responses: - '204': - description: Response - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Remove user as a collaborator - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/remove-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator - parameters: - - "$ref": "#/components/parameters/project-id" - - "$ref": "#/components/parameters/username" - responses: - '204': - description: Response - '304': - "$ref": "#/components/responses/not_modified" - '404': - "$ref": "#/components/responses/not_found" - '403': - "$ref": "#/components/responses/forbidden" - '422': - "$ref": "#/components/responses/validation_failed" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators/{username}/permission": - get: - summary: Get project permission for a user - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-permission-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user - parameters: - - "$ref": "#/components/parameters/project-id" - - "$ref": "#/components/parameters/username" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-collaborator-permission" - examples: - default: - "$ref": "#/components/examples/project-collaborator-permission" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/rate_limit": get: summary: Get rate limit status for the authenticated user @@ -44849,6 +44277,7 @@ paths: - "$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-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" @@ -44928,6 +44357,8 @@ paths: description: |- Updates the status of a secret scanning alert in an eligible repository. + You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. 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. @@ -44954,14 +44385,26 @@ paths: "$ref": "#/components/schemas/secret-scanning-alert-resolution" resolution_comment: "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + assignee: + "$ref": "#/components/schemas/secret-scanning-alert-assignee" anyOf: - required: - state + - required: + - assignee examples: default: value: state: resolved resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: responses: '200': description: Response @@ -44979,7 +44422,8 @@ paths: description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': - description: State does not match the resolution or resolution comment + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository '503': "$ref": "#/components/responses/service_unavailable" x-github: @@ -48621,184 +48065,6 @@ paths: category: teams subcategory: members deprecated: true - "/teams/{team_id}/projects": - get: - summary: List team projects (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/list-projects-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project-items" - headers: - Link: - "$ref": "#/components/headers/link" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - "/teams/{team_id}/projects/{project_id}": - get: - summary: Check team permissions for a project (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/check-permissions-for-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/project-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project" - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - put: - summary: Add or update team project permissions (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/add-or-update-project-permissions-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/project-id" - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - examples: - default: - summary: Example of setting permission to read - value: - permission: read - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - delete: - summary: Remove a project from a team (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/remove-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/project-id" - responses: - '204': - description: Response - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true "/teams/{team_id}/repos": get: summary: List team repositories (Legacy) @@ -54766,6 +54032,144 @@ paths: enabledForGitHubApps: true category: projects subcategory: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project + parameters: + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/project-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + - single_select + - iteration + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + iteration_configuration: + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: The duration of the iteration in days. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + properties: + title: + type: string + description: The title for the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + required: + - name + - data_type + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select-request" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration-request" + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-field" + examples: + text_field: + "$ref": "#/components/examples/projects-v2-field-text" + number_field: + "$ref": "#/components/examples/projects-v2-field-number" + date_field: + "$ref": "#/components/examples/projects-v2-field-date" + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields "/users/{username}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for user @@ -64656,7 +64060,279 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-card-moved" + "$ref": "#/components/schemas/webhook-project-card-moved" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: project_card + supported-webhook-types: + - repository + - organization + - app + project-closed: + post: + summary: |- + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: A project (classic) was closed. + operationId: project/closed + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-project-closed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: project + supported-webhook-types: + - repository + - organization + - app + project-column-created: + post: + summary: |- + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: A column was added to a project (classic). + operationId: project-column/created + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-project-column-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: project_column + supported-webhook-types: + - repository + - organization + - app + project-column-deleted: + post: + summary: |- + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: A column was deleted from a project (classic). + operationId: project-column/deleted + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-project-column-deleted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: project_column + supported-webhook-types: + - repository + - organization + - app + project-column-edited: + post: + summary: |- + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: The name of a column on a project (classic) was changed. + operationId: project-column/edited + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-project-column-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64664,25 +64340,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_card + subcategory: project_column supported-webhook-types: - repository - organization - app - project-closed: + project-column-moved: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A project (classic) was closed. - operationId: project/closed + description: A column was moved to a new position on a project (classic). + operationId: project-column/moved externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header @@ -64724,7 +64400,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-closed" + "$ref": "#/components/schemas/webhook-project-column-moved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64732,25 +64408,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project + subcategory: project_column supported-webhook-types: - repository - organization - app - project-column-created: + project-created: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A column was added to a project (classic). - operationId: project-column/created + description: A project (classic) was created. + operationId: project/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -64792,7 +64468,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-column-created" + "$ref": "#/components/schemas/webhook-project-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64800,25 +64476,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_column + subcategory: project supported-webhook-types: - repository - organization - app - project-column-deleted: + project-deleted: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A column was deleted from a project (classic). - operationId: project-column/deleted + description: A project (classic) was deleted. + operationId: project/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -64860,7 +64536,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-column-deleted" + "$ref": "#/components/schemas/webhook-project-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64868,25 +64544,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_column + subcategory: project supported-webhook-types: - repository - organization - app - project-column-edited: + project-edited: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: The name of a column on a project (classic) was changed. - operationId: project-column/edited + description: The name or description of a project (classic) was changed. + operationId: project/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -64928,7 +64604,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-column-edited" + "$ref": "#/components/schemas/webhook-project-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64936,25 +64612,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_column + subcategory: project supported-webhook-types: - repository - organization - app - project-column-moved: + project-reopened: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A column was moved to a new position on a project (classic). - operationId: project-column/moved + description: A project (classic) was closed. + operationId: project/reopened externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -64996,7 +64672,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-column-moved" + "$ref": "#/components/schemas/webhook-project-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65004,25 +64680,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_column + subcategory: project supported-webhook-types: - repository - organization - app - project-created: + projects-v2-closed: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A project (classic) was created. - operationId: project/created + > [!NOTE] + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A project in the organization was closed. + operationId: projects-v2/closed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -65036,7 +64713,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65064,33 +64741,33 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-created" + "$ref": "#/components/schemas/webhook-projects-v2-project-closed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: project + subcategory: projects_v2 supported-webhook-types: - - repository - organization - - app - project-deleted: + projects-v2-created: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A project (classic) was deleted. - operationId: project/deleted + > [!NOTE] + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A project in the organization was created. + operationId: projects-v2/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -65104,7 +64781,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65132,33 +64809,33 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-project-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: project + subcategory: projects_v2 supported-webhook-types: - - repository - organization - - app - project-edited: + projects-v2-deleted: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: The name or description of a project (classic) was changed. - operationId: project/edited + > [!NOTE] + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A project in the organization was deleted. + operationId: projects-v2/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -65172,7 +64849,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65200,33 +64877,34 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-edited" + "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: project + subcategory: projects_v2 supported-webhook-types: - - repository - organization - - app - project-reopened: + projects-v2-edited: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A project (classic) was closed. - operationId: project/reopened + > [!NOTE] + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: The title, description, or README of a project in the organization + was changed. + operationId: projects-v2/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -65240,7 +64918,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65268,34 +64946,34 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-reopened" + "$ref": "#/components/schemas/webhook-projects-v2-project-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: project + subcategory: projects_v2 supported-webhook-types: - - repository - organization - - app - projects-v2-closed: + projects-v2-item-archived: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A project in the organization was closed. - operationId: projects-v2/closed + description: An item on an organization project was archived. For more information, + see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." + operationId: projects-v2-item/archived externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -65309,7 +64987,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65337,7 +65015,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-closed" + "$ref": "#/components/schemas/webhook-projects-v2-item-archived" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65346,24 +65024,24 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-created: + projects-v2-item-converted: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A project in the organization was created. - operationId: projects-v2/created + description: A draft issue in an organization project was converted to an issue. + operationId: projects-v2-item/converted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -65377,7 +65055,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65405,7 +65083,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-created" + "$ref": "#/components/schemas/webhook-projects-v2-item-converted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65414,24 +65092,24 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-deleted: + projects-v2-item-created: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A project in the organization was deleted. - operationId: projects-v2/deleted + description: An item was added to a project in the organization. + operationId: projects-v2-item/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -65445,7 +65123,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65473,7 +65151,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-item-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65482,25 +65160,24 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-edited: + projects-v2-item-deleted: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: The title, description, or README of a project in the organization - was changed. - operationId: projects-v2/edited + description: An item was deleted from a project in the organization. + operationId: projects-v2-item/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -65514,7 +65191,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65542,7 +65219,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65551,10 +65228,10 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-archived: + projects-v2-item-edited: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). @@ -65565,9 +65242,10 @@ x-webhooks: > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: An item on an organization project was archived. For more information, - see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." - operationId: projects-v2-item/archived + description: The values or state of an item in an organization project were + changed. For example, the value of a field was updated, the body of a draft + issue was changed, or a draft issue was converted to an issue. + operationId: projects-v2-item/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: @@ -65611,7 +65289,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-archived" + "$ref": "#/components/schemas/webhook-projects-v2-item-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65623,7 +65301,7 @@ x-webhooks: subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-converted: + projects-v2-item-reordered: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). @@ -65634,8 +65312,10 @@ x-webhooks: > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A draft issue in an organization project was converted to an issue. - operationId: projects-v2-item/converted + description: The position of an item in an organization project was changed. + For example, an item was moved above or below another item in the table or + board layout. + operationId: projects-v2-item/reordered externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: @@ -65679,7 +65359,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-converted" + "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65691,7 +65371,7 @@ x-webhooks: subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-created: + projects-v2-item-restored: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). @@ -65702,8 +65382,9 @@ x-webhooks: > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: An item was added to a project in the organization. - operationId: projects-v2-item/created + description: An archived item on an organization project was restored from the + archive. For more information, see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." + operationId: projects-v2-item/restored externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: @@ -65747,7 +65428,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-created" + "$ref": "#/components/schemas/webhook-projects-v2-item-restored" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65759,21 +65440,21 @@ x-webhooks: subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-deleted: + projects-v2-reopened: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: An item was deleted from a project in the organization. - operationId: projects-v2-item/deleted + description: A project in the organization was reopened. + operationId: projects-v2/reopened externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -65787,7 +65468,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65815,7 +65496,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65824,26 +65505,24 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: projects_v2 supported-webhook-types: - organization - projects-v2-item-edited: + projects-v2-status-update-created: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project, use the `projects_v2` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: The values or state of an item in an organization project were - changed. For example, the value of a field was updated, the body of a draft - issue was changed, or a draft issue was converted to an issue. - operationId: projects-v2-item/edited + > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A status update was added to a project in the organization. + operationId: projects-v2-status-update/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header @@ -65857,7 +65536,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: project-v2-status-update schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65885,7 +65564,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-edited" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65894,26 +65573,24 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: projects_v2_status_update supported-webhook-types: - organization - projects-v2-item-reordered: + projects-v2-status-update-deleted: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project, use the `projects_v2` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: The position of an item in an organization project was changed. - For example, an item was moved above or below another item in the table or - board layout. - operationId: projects-v2-item/reordered + > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A status update was removed from a project in the organization. + operationId: projects-v2-status-update/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header @@ -65927,7 +65604,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: project-v2-status-update schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65955,7 +65632,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65964,25 +65641,24 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: projects_v2_status_update supported-webhook-types: - organization - projects-v2-item-restored: + projects-v2-status-update-edited: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project, use the `projects_v2` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: An archived item on an organization project was restored from the - archive. For more information, see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." - operationId: projects-v2-item/restored + > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A status update was edited on a project in the organization. + operationId: projects-v2-status-update/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header @@ -65996,7 +65672,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: project-v2-status-update schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -66024,7 +65700,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-restored" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66033,24 +65709,18 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: projects_v2_status_update supported-webhook-types: - organization - projects-v2-reopened: + public: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + This event occurs when repository visibility changes from private to public. For more information, see "[Setting repository visibility](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." - > [!NOTE] - > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A project in the organization was reopened. - operationId: projects-v2/reopened + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + operationId: public externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#public parameters: - name: User-Agent in: header @@ -66064,7 +65734,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -66092,33 +65762,31 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" + "$ref": "#/components/schemas/webhook-public" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: public supported-webhook-types: + - repository - organization - projects-v2-status-update-created: + - app + pull-request-assigned: post: summary: |- - This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - - For activity relating to a project, use the `projects_v2` event. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - > [!NOTE] - > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A status update was added to a project in the organization. - operationId: projects-v2-status-update/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A pull request was assigned to a user. + operationId: pull-request/assigned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -66132,7 +65800,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-status-update + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -66160,33 +65828,32 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" + "$ref": "#/components/schemas/webhook-pull-request-assigned" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_status_update + subcategory: pull_request supported-webhook-types: + - repository - organization - projects-v2-status-update-deleted: + - app + pull-request-auto-merge-disabled: post: summary: |- - This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - - For activity relating to a project, use the `projects_v2` event. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - > [!NOTE] - > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A status update was removed from a project in the organization. - operationId: projects-v2-status-update/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: Auto merge was disabled for a pull request. For more information, + see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." + operationId: pull-request/auto-merge-disabled externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -66200,7 +65867,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-status-update + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -66228,33 +65895,32 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_status_update + subcategory: pull_request supported-webhook-types: + - repository - organization - projects-v2-status-update-edited: + - app + pull-request-auto-merge-enabled: post: summary: |- - This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - - For activity relating to a project, use the `projects_v2` event. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - > [!NOTE] - > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A status update was edited on a project in the organization. - operationId: projects-v2-status-update/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: Auto merge was enabled for a pull request. For more information, + see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." + operationId: pull-request/auto-merge-enabled externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -66268,7 +65934,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-status-update + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -66296,27 +65962,33 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_status_update + subcategory: pull_request supported-webhook-types: + - repository - organization - public: + - app + pull-request-closed: post: summary: |- - This event occurs when repository visibility changes from private to public. For more information, see "[Setting repository visibility](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - operationId: public + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A pull request was closed. If `merged` is false in the webhook + payload, the pull request was closed with unmerged commits. If `merged` is + true in the webhook payload, the pull request was merged. + operationId: pull-request/closed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#public + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -66358,7 +66030,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-public" + "$ref": "#/components/schemas/webhook-pull-request-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66366,12 +66038,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: public + subcategory: pull_request supported-webhook-types: - repository - organization - app - pull-request-assigned: + pull-request-converted-to-draft: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -66379,8 +66051,9 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was assigned to a user. - operationId: pull-request/assigned + description: A pull request was converted to a draft. For more information, + see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." + operationId: pull-request/converted-to-draft externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -66424,7 +66097,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-assigned" + "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66437,7 +66110,7 @@ x-webhooks: - repository - organization - app - pull-request-auto-merge-disabled: + pull-request-demilestoned: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -66445,9 +66118,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Auto merge was disabled for a pull request. For more information, - see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." - operationId: pull-request/auto-merge-disabled + description: A pull request was removed from a milestone. + operationId: pull-request/demilestoned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -66491,74 +66163,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-auto-merge-enabled: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Auto merge was enabled for a pull request. For more information, - see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." - operationId: pull-request/auto-merge-enabled - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" + "$ref": "#/components/schemas/webhook-pull-request-demilestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66571,7 +66176,7 @@ x-webhooks: - repository - organization - app - pull-request-closed: + pull-request-dequeued: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -66579,10 +66184,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was closed. If `merged` is false in the webhook - payload, the pull request was closed with unmerged commits. If `merged` is - true in the webhook payload, the pull request was merged. - operationId: pull-request/closed + description: A pull request was removed from the merge queue. + operationId: pull-request/dequeued externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -66626,7 +66229,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-closed" + "$ref": "#/components/schemas/webhook-pull-request-dequeued" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66639,7 +66242,7 @@ x-webhooks: - repository - organization - app - pull-request-converted-to-draft: + pull-request-edited: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -66647,9 +66250,9 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was converted to a draft. For more information, - see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." - operationId: pull-request/converted-to-draft + description: The title or body of a pull request was edited, or the base branch + of a pull request was changed. + operationId: pull-request/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -66693,7 +66296,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" + "$ref": "#/components/schemas/webhook-pull-request-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66706,7 +66309,7 @@ x-webhooks: - repository - organization - app - pull-request-demilestoned: + pull-request-enqueued: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -66714,8 +66317,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was removed from a milestone. - operationId: pull-request/demilestoned + description: A pull request was added to the merge queue. + operationId: pull-request/enqueued externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -66759,7 +66362,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-demilestoned" + "$ref": "#/components/schemas/webhook-pull-request-enqueued" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66772,7 +66375,7 @@ x-webhooks: - repository - organization - app - pull-request-dequeued: + pull-request-labeled: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -66780,8 +66383,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was removed from the merge queue. - operationId: pull-request/dequeued + description: A label was added to a pull request. + operationId: pull-request/labeled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -66825,7 +66428,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-dequeued" + "$ref": "#/components/schemas/webhook-pull-request-labeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66838,7 +66441,7 @@ x-webhooks: - repository - organization - app - pull-request-edited: + pull-request-locked: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -66846,9 +66449,9 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: The title or body of a pull request was edited, or the base branch - of a pull request was changed. - operationId: pull-request/edited + description: Conversation on a pull request was locked. For more information, + see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: pull-request/locked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -66892,7 +66495,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-edited" + "$ref": "#/components/schemas/webhook-pull-request-locked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66905,7 +66508,7 @@ x-webhooks: - repository - organization - app - pull-request-enqueued: + pull-request-milestoned: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -66913,8 +66516,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was added to the merge queue. - operationId: pull-request/enqueued + description: A pull request was added to a milestone. + operationId: pull-request/milestoned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -66958,7 +66561,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-enqueued" + "$ref": "#/components/schemas/webhook-pull-request-milestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66971,7 +66574,7 @@ x-webhooks: - repository - organization - app - pull-request-labeled: + pull-request-opened: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -66979,8 +66582,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A label was added to a pull request. - operationId: pull-request/labeled + description: A pull request was created + operationId: pull-request/opened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -67024,7 +66627,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-labeled" + "$ref": "#/components/schemas/webhook-pull-request-opened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67037,7 +66640,7 @@ x-webhooks: - repository - organization - app - pull-request-locked: + pull-request-ready-for-review: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -67045,9 +66648,9 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Conversation on a pull request was locked. For more information, - see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: pull-request/locked + description: A draft pull request was marked as ready for review. For more information, + see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." + operationId: pull-request/ready-for-review externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -67091,7 +66694,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-locked" + "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67104,7 +66707,7 @@ x-webhooks: - repository - organization - app - pull-request-milestoned: + pull-request-reopened: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -67112,8 +66715,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was added to a milestone. - operationId: pull-request/milestoned + description: A previously closed pull request was reopened. + operationId: pull-request/reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -67157,7 +66760,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-milestoned" + "$ref": "#/components/schemas/webhook-pull-request-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67170,18 +66773,18 @@ x-webhooks: - repository - organization - app - pull-request-opened: + pull-request-review-comment-created: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was created - operationId: pull-request/opened + description: A comment on a pull request diff was created. + operationId: pull-request-review-comment/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header @@ -67223,7 +66826,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-opened" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67231,24 +66834,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: pull_request_review_comment supported-webhook-types: - repository - organization - app - pull-request-ready-for-review: + pull-request-review-comment-deleted: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A draft pull request was marked as ready for review. For more information, - see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." - operationId: pull-request/ready-for-review + description: A comment on a pull request diff was deleted. + operationId: pull-request-review-comment/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header @@ -67290,7 +66892,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67298,23 +66900,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: pull_request_review_comment supported-webhook-types: - repository - organization - app - pull-request-reopened: + pull-request-review-comment-edited: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A previously closed pull request was reopened. - operationId: pull-request/reopened + description: The content of a comment on a pull request diff was changed. + operationId: pull-request-review-comment/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header @@ -67356,7 +66958,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-reopened" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67364,23 +66966,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: pull_request_review_comment supported-webhook-types: - repository - organization - app - pull-request-review-comment-created: + pull-request-review-dismissed: post: summary: |- - This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. - For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A comment on a pull request diff was created. - operationId: pull-request-review-comment/created + description: A review on a pull request was dismissed. + operationId: pull-request-review/dismissed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header @@ -67422,7 +67024,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" + "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67430,23 +67032,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review_comment + subcategory: pull_request_review supported-webhook-types: - repository - organization - app - pull-request-review-comment-deleted: + pull-request-review-edited: post: summary: |- - This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. - For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A comment on a pull request diff was deleted. - operationId: pull-request-review-comment/deleted + description: The body comment on a pull request review was edited. + operationId: pull-request-review/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header @@ -67488,7 +67090,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" + "$ref": "#/components/schemas/webhook-pull-request-review-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67496,23 +67098,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review_comment + subcategory: pull_request_review supported-webhook-types: - repository - organization - app - pull-request-review-comment-edited: + pull-request-review-request-removed: post: summary: |- - This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: The content of a comment on a pull request diff was changed. - operationId: pull-request-review-comment/edited + description: A request for review by a person or team was removed from a pull + request. + operationId: pull-request/review-request-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -67554,7 +67157,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67562,23 +67165,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review_comment + subcategory: pull_request supported-webhook-types: - repository - organization - app - pull-request-review-dismissed: + pull-request-review-requested: post: summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A review on a pull request was dismissed. - operationId: pull-request-review/dismissed + description: Review by a person or team was requested for a pull request. For + more information, see "[Requesting a pull request review](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." + operationId: pull-request/review-requested externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -67620,7 +67224,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" + "$ref": "#/components/schemas/webhook-pull-request-review-requested" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67628,12 +67232,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review + subcategory: pull_request supported-webhook-types: - repository - organization - app - pull-request-review-edited: + pull-request-review-submitted: post: summary: |- This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. @@ -67641,8 +67245,8 @@ x-webhooks: For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: The body comment on a pull request review was edited. - operationId: pull-request-review/edited + description: A review on a pull request was submitted. + operationId: pull-request-review/submitted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review parameters: @@ -67686,7 +67290,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-submitted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67699,152 +67303,18 @@ x-webhooks: - repository - organization - app - pull-request-review-request-removed: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A request for review by a person or team was removed from a pull - request. - operationId: pull-request/review-request-removed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-review-requested: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Review by a person or team was requested for a pull request. For - more information, see "[Requesting a pull request review](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." - operationId: pull-request/review-requested - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-pull-request-review-requested" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-review-submitted: + pull-request-review-thread-resolved: post: summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A review on a pull request was submitted. - operationId: pull-request-review/submitted + description: A comment thread on a pull request was marked as resolved. + operationId: pull-request-review-thread/resolved externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: - name: User-Agent in: header @@ -67886,7 +67356,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-submitted" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67894,12 +67364,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review + subcategory: pull_request_review_thread supported-webhook-types: - repository - organization - app - pull-request-review-thread-resolved: + pull-request-review-thread-unresolved: post: summary: |- This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. @@ -67907,8 +67377,9 @@ x-webhooks: For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A comment thread on a pull request was marked as resolved. - operationId: pull-request-review-thread/resolved + description: A previously resolved comment thread on a pull request was marked + as unresolved. + operationId: pull-request-review-thread/unresolved externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: @@ -67952,7 +67423,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67965,19 +67436,20 @@ x-webhooks: - repository - organization - app - pull-request-review-thread-unresolved: + pull-request-synchronize: post: summary: |- - This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A previously resolved comment thread on a pull request was marked - as unresolved. - operationId: pull-request-review-thread/unresolved + description: A pull request's head branch was updated. For example, the head + branch was updated from the base branch or new commits were pushed to the + head branch. + operationId: pull-request/synchronize externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -68019,7 +67491,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" + "$ref": "#/components/schemas/webhook-pull-request-synchronize" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68027,12 +67499,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review_thread + subcategory: pull_request supported-webhook-types: - repository - organization - app - pull-request-synchronize: + pull-request-unassigned: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -68040,10 +67512,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request's head branch was updated. For example, the head - branch was updated from the base branch or new commits were pushed to the - head branch. - operationId: pull-request/synchronize + description: A user was unassigned from a pull request. + operationId: pull-request/unassigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -68087,7 +67557,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-synchronize" + "$ref": "#/components/schemas/webhook-pull-request-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68100,7 +67570,7 @@ x-webhooks: - repository - organization - app - pull-request-unassigned: + pull-request-unlabeled: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -68108,8 +67578,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A user was unassigned from a pull request. - operationId: pull-request/unassigned + description: A label was removed from a pull request. + operationId: pull-request/unlabeled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -68153,7 +67623,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-unassigned" + "$ref": "#/components/schemas/webhook-pull-request-unlabeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68166,7 +67636,7 @@ x-webhooks: - repository - organization - app - pull-request-unlabeled: + pull-request-unlocked: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -68174,8 +67644,9 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A label was removed from a pull request. - operationId: pull-request/unlabeled + description: Conversation on a pull request was unlocked. For more information, + see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: pull-request/unlocked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -68219,7 +67690,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-unlabeled" + "$ref": "#/components/schemas/webhook-pull-request-unlocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68232,19 +67703,20 @@ x-webhooks: - repository - organization - app - pull-request-unlocked: + push: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, + when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch + and tag deletions, use the [`delete`](#delete) webhook event. - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Conversation on a pull request was unlocked. For more information, - see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: pull-request/unlocked + > [!NOTE] + > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. + operationId: push externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#push parameters: - name: User-Agent in: header @@ -68286,7 +67758,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-unlocked" + "$ref": "#/components/schemas/webhook-push" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68294,25 +67766,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: push supported-webhook-types: - repository - organization - app - push: + registry-package-published: post: summary: |- - This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, - when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch - and tag deletions, use the [`delete`](#delete) webhook event. + This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. > [!NOTE] - > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. - operationId: push + > GitHub recommends that you use the newer `package` event instead. + description: A package was published to a registry. + operationId: registry-package/published externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#push + url: https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package parameters: - name: User-Agent in: header @@ -68354,7 +67825,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-push" + "$ref": "#/components/schemas/webhook-registry-package-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68362,12 +67833,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: push + subcategory: registry_package supported-webhook-types: - repository - organization - app - registry-package-published: + registry-package-updated: post: summary: |- This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. @@ -68376,8 +67847,8 @@ x-webhooks: > [!NOTE] > GitHub recommends that you use the newer `package` event instead. - description: A package was published to a registry. - operationId: registry-package/published + description: A package that was previously published to a registry was updated. + operationId: registry-package/updated externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package parameters: @@ -68421,7 +67892,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-registry-package-published" + "$ref": "#/components/schemas/webhook-registry-package-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68434,19 +67905,17 @@ x-webhooks: - repository - organization - app - registry-package-updated: + release-created: post: summary: |- - This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. - - To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. - > [!NOTE] - > GitHub recommends that you use the newer `package` event instead. - description: A package that was previously published to a registry was updated. - operationId: registry-package/updated + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + description: A draft was saved, or a release or pre-release was published without + previously being saved as a draft. + operationId: release/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package + url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -68488,7 +67957,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-registry-package-updated" + "$ref": "#/components/schemas/webhook-release-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68496,20 +67965,19 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: registry_package + subcategory: release supported-webhook-types: - repository - organization - app - release-created: + release-deleted: post: summary: |- This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A draft was saved, or a release or pre-release was published without - previously being saved as a draft. - operationId: release/created + description: A release, pre-release, or draft release was deleted. + operationId: release/deleted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: @@ -68553,7 +68021,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-created" + "$ref": "#/components/schemas/webhook-release-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68566,14 +68034,15 @@ x-webhooks: - repository - organization - app - release-deleted: + release-edited: post: summary: |- This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release, pre-release, or draft release was deleted. - operationId: release/deleted + description: The details of a release, pre-release, or draft release were edited. + For more information, see "[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)." + operationId: release/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: @@ -68617,7 +68086,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-deleted" + "$ref": "#/components/schemas/webhook-release-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68630,15 +68099,15 @@ x-webhooks: - repository - organization - app - release-edited: + release-prereleased: post: summary: |- This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: The details of a release, pre-release, or draft release were edited. - For more information, see "[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)." - operationId: release/edited + description: A release was created and identified as a pre-release. A pre-release + is a release that is not ready for production and may be unstable. + operationId: release/prereleased externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: @@ -68682,7 +68151,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-edited" + "$ref": "#/components/schemas/webhook-release-prereleased" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68695,15 +68164,14 @@ x-webhooks: - repository - organization - app - release-prereleased: + release-published: post: summary: |- This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release was created and identified as a pre-release. A pre-release - is a release that is not ready for production and may be unstable. - operationId: release/prereleased + description: A release, pre-release, or draft of a release was published. + operationId: release/published externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: @@ -68747,7 +68215,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-prereleased" + "$ref": "#/components/schemas/webhook-release-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68760,14 +68228,14 @@ x-webhooks: - repository - organization - app - release-published: + release-released: post: summary: |- This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release, pre-release, or draft of a release was published. - operationId: release/published + description: A release was published, or a pre-release was changed to a release. + operationId: release/released externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: @@ -68811,7 +68279,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-published" + "$ref": "#/components/schemas/webhook-release-released" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68824,14 +68292,14 @@ x-webhooks: - repository - organization - app - release-released: + release-unpublished: post: summary: |- This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release was published, or a pre-release was changed to a release. - operationId: release/released + description: A release or pre-release was unpublished. + operationId: release/unpublished externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: @@ -68875,7 +68343,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-released" + "$ref": "#/components/schemas/webhook-release-unpublished" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68888,16 +68356,16 @@ x-webhooks: - repository - organization - app - release-unpublished: + repository-advisory-published: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release or pre-release was unpublished. - operationId: release/unpublished + To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. + description: A repository security advisory was published. + operationId: repository-advisory/published externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory parameters: - name: User-Agent in: header @@ -68939,7 +68407,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-unpublished" + "$ref": "#/components/schemas/webhook-repository-advisory-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68947,19 +68415,19 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: release + subcategory: repository_advisory supported-webhook-types: - repository - organization - app - repository-advisory-published: + repository-advisory-reported: post: summary: |- This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. - description: A repository security advisory was published. - operationId: repository-advisory/published + description: A private vulnerability report was submitted. + operationId: repository-advisory/reported externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory parameters: @@ -69003,7 +68471,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-advisory-published" + "$ref": "#/components/schemas/webhook-repository-advisory-reported" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69016,16 +68484,16 @@ x-webhooks: - repository - organization - app - repository-advisory-reported: + repository-archived: post: summary: |- - This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. - description: A private vulnerability report was submitted. - operationId: repository-advisory/reported + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A repository was archived. + operationId: repository/archived externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -69067,7 +68535,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-advisory-reported" + "$ref": "#/components/schemas/webhook-repository-archived" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69075,19 +68543,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_advisory + subcategory: repository supported-webhook-types: + - business - repository - organization - app - repository-archived: + repository-created: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A repository was archived. - operationId: repository/archived + description: A repository was created. + operationId: repository/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: @@ -69131,7 +68600,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-archived" + "$ref": "#/components/schemas/webhook-repository-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69145,14 +68614,142 @@ x-webhooks: - repository - organization - app - repository-created: + repository-deleted: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A repository was created. - operationId: repository/created + description: A repository was deleted. GitHub Apps and repository webhooks will + not receive this event. + operationId: repository/deleted + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-repository-deleted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: repository + supported-webhook-types: + - business + - repository + - organization + - app + repository-dispatch-sample.collected: + post: + summary: |- + This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + operationId: repository-dispatch/sample.collected + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: repository_dispatch + supported-webhook-types: + - app + repository-edited: + post: + summary: |- + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: The topics, default branch, description, or homepage of a repository + was changed. + operationId: repository/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: @@ -69196,7 +68793,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-created" + "$ref": "#/components/schemas/webhook-repository-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69210,17 +68807,14 @@ x-webhooks: - repository - organization - app - repository-deleted: + repository-import: post: - summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A repository was deleted. GitHub Apps and repository webhooks will - not receive this event. - operationId: repository/deleted + summary: This event occurs when a repository is imported to GitHub. For more + information, see "[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer)." + For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports). + operationId: repository-import externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import parameters: - name: User-Agent in: header @@ -69262,7 +68856,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-deleted" + "$ref": "#/components/schemas/webhook-repository-import" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69270,21 +68864,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: repository_import supported-webhook-types: - - business - repository - organization - - app - repository-dispatch-sample.collected: + repository-privatized: post: summary: |- - This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - operationId: repository-dispatch/sample.collected + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: The visibility of a repository was changed to `private`. + operationId: repository/privatized externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -69326,7 +68919,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + "$ref": "#/components/schemas/webhook-repository-privatized" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69334,18 +68927,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_dispatch + subcategory: repository supported-webhook-types: + - business + - repository + - organization - app - repository-edited: + repository-publicized: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: The topics, default branch, description, or homepage of a repository - was changed. - operationId: repository/edited + description: The visibility of a repository was changed to `public`. + operationId: repository/publicized externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: @@ -69389,7 +68984,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-repository-publicized" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69403,75 +68998,14 @@ x-webhooks: - repository - organization - app - repository-import: - post: - summary: This event occurs when a repository is imported to GitHub. For more - information, see "[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer)." - For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports). - operationId: repository-import - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-repository-import" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository_import - supported-webhook-types: - - repository - - organization - repository-privatized: + repository-renamed: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: The visibility of a repository was changed to `private`. - operationId: repository/privatized + description: The name of a repository was changed. + operationId: repository/renamed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: @@ -69515,7 +69049,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-repository-renamed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69529,16 +69063,18 @@ x-webhooks: - repository - organization - app - repository-publicized: + repository-ruleset-created: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repository rulesets. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: The visibility of a repository was changed to `public`. - operationId: repository/publicized + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. + description: A repository ruleset was created. + operationId: repository-ruleset/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset parameters: - name: User-Agent in: header @@ -69580,7 +69116,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69588,22 +69124,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: repository_ruleset supported-webhook-types: - - business - repository - organization - app - repository-renamed: + repository-ruleset-deleted: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repository rulesets. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: The name of a repository was changed. - operationId: repository/renamed + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. + description: A repository ruleset was deleted. + operationId: repository-ruleset/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset parameters: - name: User-Agent in: header @@ -69645,7 +69182,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69653,13 +69190,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: repository_ruleset supported-webhook-types: - - business - repository - organization - app - repository-ruleset-created: + repository-ruleset-edited: post: summary: |- This event occurs when there is activity relating to repository rulesets. @@ -69667,8 +69203,8 @@ x-webhooks: For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. - description: A repository ruleset was created. - operationId: repository-ruleset/created + description: A repository ruleset was edited. + operationId: repository-ruleset/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset parameters: @@ -69712,7 +69248,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-ruleset-created" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69725,18 +69261,20 @@ x-webhooks: - repository - organization - app - repository-ruleset-deleted: + repository-transferred: post: summary: |- - This event occurs when there is activity relating to repository rulesets. - For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." - For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. - description: A repository ruleset was deleted. - operationId: repository-ruleset/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Ownership of the repository was transferred to a user or organization + account. This event is only sent to the account where the ownership is transferred. + To receive the `repository.transferred` event, the new owner account must + have the GitHub App installed, and the App must be subscribed to "Repository" + events. + operationId: repository/transferred externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -69778,7 +69316,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" + "$ref": "#/components/schemas/webhook-repository-transferred" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69786,23 +69324,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_ruleset + subcategory: repository supported-webhook-types: + - business - repository - organization - app - repository-ruleset-edited: + repository-unarchived: post: summary: |- - This event occurs when there is activity relating to repository rulesets. - For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." - For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. - description: A repository ruleset was edited. - operationId: repository-ruleset/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A previously archived repository was unarchived. + operationId: repository/unarchived externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -69844,7 +69381,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-ruleset-edited" + "$ref": "#/components/schemas/webhook-repository-unarchived" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69852,25 +69389,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_ruleset + subcategory: repository supported-webhook-types: + - business - repository - organization - app - repository-transferred: + repository-vulnerability-alert-create: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to a security vulnerability alert in a repository. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Ownership of the repository was transferred to a user or organization - account. This event is only sent to the account where the ownership is transferred. - To receive the `repository.transferred` event, the new owner account must - have the GitHub App installed, and the App must be subscribed to "Repository" - events. - operationId: repository/transferred + > [!WARNING] + > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. + description: A repository vulnerability alert was created. + operationId: repository-vulnerability-alert/create externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -69912,7 +69447,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69920,22 +69455,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: repository_vulnerability_alert supported-webhook-types: - - business - repository - organization - - app - repository-unarchived: + repository-vulnerability-alert-dismiss: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to a security vulnerability alert in a repository. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A previously archived repository was unarchived. - operationId: repository/unarchived + > [!WARNING] + > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. + description: A repository vulnerability alert was dismissed. + operationId: repository-vulnerability-alert/dismiss externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -69977,7 +69511,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69985,21 +69519,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: repository_vulnerability_alert supported-webhook-types: - - business - repository - organization - - app - repository-vulnerability-alert-create: + repository-vulnerability-alert-reopen: post: summary: |- This event occurs when there is activity relating to a security vulnerability alert in a repository. > [!WARNING] > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. - description: A repository vulnerability alert was created. - operationId: repository-vulnerability-alert/create + description: A previously dismissed or resolved repository vulnerability alert + was reopened. + operationId: repository-vulnerability-alert/reopen externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: @@ -70043,7 +69576,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70055,15 +69588,15 @@ x-webhooks: supported-webhook-types: - repository - organization - repository-vulnerability-alert-dismiss: + repository-vulnerability-alert-resolve: post: summary: |- This event occurs when there is activity relating to a security vulnerability alert in a repository. > [!WARNING] > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. - description: A repository vulnerability alert was dismissed. - operationId: repository-vulnerability-alert/dismiss + description: A repository vulnerability alert was marked as resolved. + operationId: repository-vulnerability-alert/resolve externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: @@ -70107,7 +69640,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70119,18 +69652,18 @@ x-webhooks: supported-webhook-types: - repository - organization - repository-vulnerability-alert-reopen: + secret-scanning-alert-assigned: post: summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - > [!WARNING] - > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. - description: A previously dismissed or resolved repository vulnerability alert - was reopened. - operationId: repository-vulnerability-alert/reopen + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was assigned. + operationId: secret-scanning-alert/assigned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -70172,7 +69705,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70180,21 +69713,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_vulnerability_alert + subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - repository-vulnerability-alert-resolve: + - app + secret-scanning-alert-created: post: summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - > [!WARNING] - > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. - description: A repository vulnerability alert was marked as resolved. - operationId: repository-vulnerability-alert/resolve + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was created. + operationId: secret-scanning-alert/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -70236,7 +69771,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70244,22 +69779,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_vulnerability_alert + subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - secret-scanning-alert-created: + - app + secret-scanning-alert-location-created: post: summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to the locations of a secret in a secret scanning alert. - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alerts, use the `secret_scanning_alert` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was created. - operationId: secret-scanning-alert/created + description: A new instance of a previously detected secret was detected in + a repository, and the location of the secret was added to the existing alert. + operationId: secret-scanning-alert-location/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location parameters: - name: User-Agent in: header @@ -70301,34 +69840,41 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" + examples: + default: + "$ref": "#/components/examples/secret-scanning-alert-location-created" + application/x-www-form-urlencoded: + schema: + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" + examples: + default: + "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: secret_scanning_alert + subcategory: secret_scanning_alert_location supported-webhook-types: - repository - organization - app - secret-scanning-alert-location-created: + secret-scanning-alert-publicly-leaked: post: summary: |- - This event occurs when there is activity relating to the locations of a secret in a secret scanning alert. - - For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - For activity relating to secret scanning alerts, use the `secret_scanning_alert` event. + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A new instance of a previously detected secret was detected in - a repository, and the location of the secret was added to the existing alert. - operationId: secret-scanning-alert-location/created + description: A secret scanning alert was detected in a public repo. + operationId: secret-scanning-alert/publicly-leaked externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -70370,30 +69916,20 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" - examples: - default: - "$ref": "#/components/examples/secret-scanning-alert-location-created" - application/x-www-form-urlencoded: - schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" - examples: - default: - "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: secret_scanning_alert_location + subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app - secret-scanning-alert-publicly-leaked: + secret-scanning-alert-reopened: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -70401,8 +69937,8 @@ x-webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was detected in a public repo. - operationId: secret-scanning-alert/publicly-leaked + description: A previously closed secret scanning alert was reopened. + operationId: secret-scanning-alert/reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -70446,7 +69982,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70459,7 +69995,7 @@ x-webhooks: - repository - organization - app - secret-scanning-alert-reopened: + secret-scanning-alert-resolved: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -70467,8 +70003,8 @@ x-webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A previously closed secret scanning alert was reopened. - operationId: secret-scanning-alert/reopened + description: A secret scanning alert was closed. + operationId: secret-scanning-alert/resolved externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -70512,7 +70048,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70525,7 +70061,7 @@ x-webhooks: - repository - organization - app - secret-scanning-alert-resolved: + secret-scanning-alert-unassigned: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -70533,8 +70069,8 @@ x-webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was closed. - operationId: secret-scanning-alert/resolved + description: A secret scanning alert was unassigned. + operationId: secret-scanning-alert/unassigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -70578,7 +70114,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73879,6 +73415,13 @@ components: enum: - read - write + artifact_metadata: + type: string + description: The level of permission to grant the access token to create + and retrieve build artifact metadata records. + enum: + - read + - write attestations: type: string description: The level of permission to create and retrieve the access token @@ -88213,74 +87756,6 @@ components: - role - state - url - team-project: - title: Team Project - description: A team's access to a project. - type: object - properties: - owner_url: - type: string - url: - type: string - html_url: - type: string - columns_url: - type: string - id: - type: integer - node_id: - type: string - name: - type: string - body: - type: string - nullable: true - number: - type: integer - state: - type: string - creator: - "$ref": "#/components/schemas/simple-user" - created_at: - type: string - updated_at: - type: string - organization_permission: - description: The organization permission for this project. Only present - when owner is an organization. - type: string - private: - description: Whether the project is private or not. Only present when owner - is an organization. - type: boolean - permissions: - type: object - properties: - read: - type: boolean - write: - type: boolean - admin: - type: boolean - required: - - read - - write - - admin - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at - - permissions team-repository: title: Team Repository description: A team's access to a repository. @@ -88689,63 +88164,6 @@ components: - watchers_count - created_at - updated_at - project-column: - title: Project Column - description: Project columns contain cards of work. - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/projects/columns/367 - project_url: - type: string - format: uri - example: https://api.github.com/projects/120 - cards_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367/cards - id: - description: The unique identifier of the project column - example: 42 - type: integer - node_id: - type: string - example: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: - description: Name of the project column - example: Remaining tasks - type: string - created_at: - type: string - format: date-time - example: '2016-09-05T14:18:44Z' - updated_at: - type: string - format: date-time - example: '2016-09-05T14:22:28Z' - required: - - id - - node_id - - url - - project_url - - cards_url - - name - - created_at - - updated_at - project-collaborator-permission: - title: Project Collaborator Permission - description: Project Collaborator Permission - type: object - properties: - permission: - type: string - user: - "$ref": "#/components/schemas/nullable-simple-user" - required: - - permission - - user rate-limit: title: Rate Limit type: object @@ -90452,6 +89870,7 @@ components: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true verification: @@ -98269,6 +97688,11 @@ components: be updated or deleted. type: string nullable: true + secret-scanning-alert-assignee: + description: The username of the user to assign to the alert. Set to `null` + to unassign the alert. + type: string + nullable: true secret-scanning-location: type: object properties: @@ -112551,6 +111975,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -113164,6 +112593,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -198804,6 +198238,32 @@ components: - alert - repository - sender + webhook-secret-scanning-alert-assigned: + title: secret_scanning_alert assigned event + type: object + properties: + action: + type: string + enum: + - assigned + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + assignee: + "$ref": "#/components/schemas/simple-user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository webhook-secret-scanning-alert-created: title: secret_scanning_alert created event type: object @@ -198935,6 +198395,32 @@ components: - action - alert - repository + webhook-secret-scanning-alert-unassigned: + title: secret_scanning_alert unassigned event + type: object + properties: + action: + type: string + enum: + - unassigned + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + assignee: + "$ref": "#/components/schemas/simple-user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository webhook-secret-scanning-alert-validated: title: secret_scanning_alert validated event type: object @@ -211134,6 +210620,22 @@ components: alert_recipients: - mona - lisa + update-budget: + value: + message: Budget successfully updated. + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa delete-budget: value: message: Budget successfully deleted. @@ -215080,17 +214582,29 @@ components: project_url: https://api.github.com/projects/67890 options: - id: option_1 - name: Low + name: + html: Low + raw: Low color: GREEN - description: Low priority items + description: + html: Low priority items + raw: Low priority items - id: option_2 - name: Medium + name: + html: Medium + raw: Medium color: YELLOW - description: Medium priority items + description: + html: Medium priority items + raw: Medium priority items - id: option_3 - name: High + name: + html: High + raw: High color: RED - description: High priority items + description: + html: High priority items + raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' projects-v2-item-with-content: @@ -217472,84 +216986,6 @@ components: url: https://api.github.com/teams/1/memberships/octocat role: member state: pending - team-project-items: - value: - - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false - team-project: - value: - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false team-repository-alternative-response-with-repository-permissions: value: id: 1296269 @@ -217698,38 +217134,6 @@ components: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core - project-column: - value: - url: https://api.github.com/projects/columns/367 - project_url: https://api.github.com/projects/120 - cards_url: https://api.github.com/projects/columns/367/cards - id: 367 - node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: To Do - created_at: '2016-09-05T14:18:44Z' - updated_at: '2016-09-05T14:22:28Z' - project-collaborator-permission: - value: - permission: admin - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false rate-limit-overview: value: resources: @@ -228856,6 +228260,25 @@ components: validity: unknown publicly_leaked: false multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: 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-location-list: value: - type: commit @@ -232967,6 +232390,138 @@ components: html_url: https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0 metadata: package_type: rubygems + projects-v2-field-single-select-request: + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + projects-v2-field-iteration-request: + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + projects-v2-field-text: + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + projects-v2-field-number: + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + projects-v2-field-date: + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + projects-v2-field-single-select: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + projects-v2-field-iteration: + value: + id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' user-received-events-items: value: - id: '22249084964' @@ -235567,6 +235122,25 @@ components: required: false schema: type: string + secret-scanning-alert-assignee: + name: assignee + in: query + description: Filters alerts by assignee. Use `*` to get all assigned alerts, + `none` to get all unassigned alerts, or a GitHub username to get alerts assigned + to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: "*" + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts secret-scanning-alert-sort: name: sort description: The property to sort the results by. `created` means when the alert @@ -235668,13 +235242,6 @@ components: required: true schema: type: integer - project-id: - name: project_id - description: The unique identifier of the project. - in: path - required: true - schema: - type: integer security-product: name: security_product in: path @@ -235704,13 +235271,6 @@ components: enum: - enable_all - disable_all - column-id: - name: column_id - description: The unique identifier of the column. - in: path - required: true - schema: - type: integer artifact-name: name: name description: The name field of an artifact. When specified, only artifacts with diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 729ba38e5..1a3134d9e 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -104,10 +104,6 @@ "name": "packages", "description": "Manage packages for authenticated users and organizations." }, - { - "name": "projects-classic", - "description": "Interact with GitHub Projects (classic)." - }, { "name": "pulls", "description": "Interact with GitHub Pull Requests." @@ -7885,10 +7881,7 @@ }, "examples": { "update-budget": { - "value": { - "message": "Budget successfully updated.", - "id": "550e8400-e29b-41d4-a716-446655440000" - } + "$ref": "#/components/examples/update-budget" } } } @@ -26651,6 +26644,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -29639,252 +29635,6 @@ } } }, - "/orgs/{org}/teams/{team_slug}/projects": { - "get": { - "summary": "List team projects", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/list-projects-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-projects" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/team-project" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/team-project-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/team-project" - }, - "examples": { - "default": { - "$ref": "#/components/examples/team-project" - } - } - } - } - }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - }, - "nullable": true - }, - "examples": { - "default": { - "summary": "Updates the permissions for the team to write for the project", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/orgs/{org}/teams/{team_slug}/repos": { "get": { "summary": "List team repositories", @@ -30225,555 +29975,6 @@ "deprecated": true } }, - "/projects/columns/{column_id}": { - "get": { - "summary": "Get a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#get-a-project-column" - }, - "parameters": [ - { - "$ref": "#/components/parameters/column-id" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-column" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-column" - } - } - } - } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update an existing project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/update-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column" - }, - "parameters": [ - { - "$ref": "#/components/parameters/column-id" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Rename the project column", - "value": { - "name": "To Do" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-column" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-column" - } - } - } - } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/delete-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#delete-a-project-column" - }, - "parameters": [ - { - "$ref": "#/components/parameters/column-id" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/{column_id}/moves": { - "post": { - "summary": "Move a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/move-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#move-a-project-column" - }, - "parameters": [ - { - "$ref": "#/components/parameters/column-id" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "example": "last", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$" - } - }, - "required": [ - "position" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Move the column to the end of the board", - "value": { - "position": "last" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators": { - "get": { - "summary": "List project collaborators", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/list-collaborators", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "name": "affiliation", - "description": "Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "outside", - "direct", - "all" - ], - "default": "all" - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/simple-user" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/simple-user-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}": { - "put": { - "summary": "Add project collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/add-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "$ref": "#/components/parameters/username" - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "example": "write", - "type": "string" - } - }, - "nullable": true - }, - "examples": { - "default": { - "summary": "Applying write permissions for the new collaborator", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove user as a collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/remove-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "$ref": "#/components/parameters/username" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}/permission": { - "get": { - "summary": "Get project permission for a user", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-permission-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "$ref": "#/components/parameters/username" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-collaborator-permission" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-collaborator-permission" - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", @@ -61772,6 +60973,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -61898,7 +61102,7 @@ }, "patch": { "summary": "Update a secret scanning alert", - "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "operationId": "secret-scanning/update-alert", "tags": [ "secret-scanning" @@ -61933,6 +61137,9 @@ }, "resolution_comment": { "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + }, + "assignee": { + "$ref": "#/components/schemas/secret-scanning-alert-assignee" } }, "anyOf": [ @@ -61940,6 +61147,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -61949,6 +61161,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -61977,7 +61201,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment" + "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" }, "503": { "$ref": "#/components/responses/service_unavailable" @@ -66886,254 +66110,6 @@ "deprecated": true } }, - "/teams/{team_id}/projects": { - "get": { - "summary": "List team projects (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/list-projects-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-projects-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/team-project" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/team-project-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, - "/teams/{team_id}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-project-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/team-project" - }, - "examples": { - "default": { - "$ref": "#/components/examples/team-project" - } - } - } - } - }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - } - }, - "examples": { - "default": { - "summary": "Example of setting permission to read", - "value": { - "permission": "read" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, "/teams/{team_id}/repos": { "get": { "summary": "List team repositories (Legacy)", @@ -75394,120 +74370,312 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "projects" + } + } + }, + "/users/{username}/projectsV2/{project_number}": { + "get": { + "summary": "Get project for user", + "description": "Get a specific user-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/get-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/projects#get-project-for-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2" + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "projects" + } + } + }, + "/users/{username}/projectsV2/{project_number}/fields": { + "get": { + "summary": "List project fields for user", + "description": "List all fields for a specific user-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/list-fields-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/fields#list-project-fields-for-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/projects-v2-field" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2-field-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" } - } - }, - "/users/{username}/projectsV2/{project_number}": { - "get": { - "summary": "Get project for user", - "description": "Get a specific user-owned project.", + }, + "post": { + "summary": "Add field to user owned project", + "description": "Add a field to a specified user owned project.", "tags": [ "projects" ], - "operationId": "projects/get-for-user", + "operationId": "projects/add-field-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/projects#get-project-for-user" + "url": "https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project" }, "parameters": [ { - "$ref": "#/components/parameters/project-number" + "$ref": "#/components/parameters/username" }, { - "$ref": "#/components/parameters/username" + "$ref": "#/components/parameters/project-number" } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/projects-v2" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date", + "single_select", + "iteration" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "description": "The color associated with the option.", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + "description": { + "type": "string", + "description": "The description of the option." + } + } + } + }, + "iteration_configuration": { + "type": "object", + "description": "The configuration for iteration fields.", + "properties": { + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the first iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "description": "Zero or more iterations for the field.", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title for the iteration." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + } + } + } + } + } + } }, - "examples": { - "default": { - "$ref": "#/components/examples/projects-v2" + "required": [ + "name", + "data_type" + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select-request" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration-request" } } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" } }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects", - "subcategory": "projects" - } - } - }, - "/users/{username}/projectsV2/{project_number}/fields": { - "get": { - "summary": "List project fields for user", - "description": "List all fields for a specific user-owned project.", - "tags": [ - "projects" - ], - "operationId": "projects/list-fields-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/fields#list-project-fields-for-user" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-number" - }, - { - "$ref": "#/components/parameters/username" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/pagination-before" - }, - { - "$ref": "#/components/parameters/pagination-after" - } - ], "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/projects-v2-field" - } + "$ref": "#/components/schemas/projects-v2-field" }, "examples": { - "default": { - "$ref": "#/components/examples/projects-v2-field-items" + "text_field": { + "$ref": "#/components/examples/projects-v2-field-text" + }, + "number_field": { + "$ref": "#/components/examples/projects-v2-field-number" + }, + "date_field": { + "$ref": "#/components/examples/projects-v2-field-date" + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration" } } } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } } }, "304": { @@ -75518,6 +74686,9 @@ }, "401": { "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -96043,7 +95214,100 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-repository-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-import": { + "post": { + "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports).", + "operationId": "repository-import", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-import" } } } @@ -96056,22 +95320,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_import", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-import": { + "repository-privatized": { "post": { - "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports).", - "operationId": "repository-import", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The visibility of a repository was changed to `private`.", + "operationId": "repository/privatized", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -96136,7 +95399,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-import" + "$ref": "#/components/schemas/webhook-repository-privatized" } } } @@ -96149,19 +95412,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_import", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-privatized": { + "repository-publicized": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `private`.", - "operationId": "repository/privatized", + "description": "The visibility of a repository was changed to `public`.", + "operationId": "repository/publicized", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -96228,7 +95493,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-repository-publicized" } } } @@ -96251,11 +95516,11 @@ } } }, - "repository-publicized": { + "repository-renamed": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `public`.", - "operationId": "repository/publicized", + "description": "The name of a repository was changed.", + "operationId": "repository/renamed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -96322,7 +95587,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-repository-renamed" } } } @@ -96345,13 +95610,13 @@ } } }, - "repository-renamed": { + "repository-ruleset-created": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The name of a repository was changed.", - "operationId": "repository/renamed", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was created.", + "operationId": "repository-ruleset/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -96416,7 +95681,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" } } } @@ -96429,9 +95694,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -96439,11 +95703,11 @@ } } }, - "repository-ruleset-created": { + "repository-ruleset-deleted": { "post": { "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was created.", - "operationId": "repository-ruleset/created", + "description": "A repository ruleset was deleted.", + "operationId": "repository-ruleset/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, @@ -96510,7 +95774,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-created" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" } } } @@ -96532,11 +95796,11 @@ } } }, - "repository-ruleset-deleted": { + "repository-ruleset-edited": { "post": { "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was deleted.", - "operationId": "repository-ruleset/deleted", + "description": "A repository ruleset was edited.", + "operationId": "repository-ruleset/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, @@ -96603,7 +95867,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" } } } @@ -96625,13 +95889,13 @@ } } }, - "repository-ruleset-edited": { + "repository-transferred": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was edited.", - "operationId": "repository-ruleset/edited", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", + "operationId": "repository/transferred", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -96696,7 +95960,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-edited" + "$ref": "#/components/schemas/webhook-repository-transferred" } } } @@ -96709,8 +95973,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -96718,11 +95983,11 @@ } } }, - "repository-transferred": { + "repository-unarchived": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", - "operationId": "repository/transferred", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -96789,7 +96054,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-repository-unarchived" } } } @@ -96812,13 +96077,13 @@ } } }, - "repository-unarchived": { + "repository-vulnerability-alert-create": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -96883,7 +96148,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" } } } @@ -96896,21 +96161,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-vulnerability-alert-create": { + "repository-vulnerability-alert-dismiss": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was created.", - "operationId": "repository-vulnerability-alert/create", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -96977,7 +96240,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" } } } @@ -96998,11 +96261,11 @@ } } }, - "repository-vulnerability-alert-dismiss": { + "repository-vulnerability-alert-reopen": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was dismissed.", - "operationId": "repository-vulnerability-alert/dismiss", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -97069,7 +96332,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" } } } @@ -97090,11 +96353,11 @@ } } }, - "repository-vulnerability-alert-reopen": { + "repository-vulnerability-alert-resolve": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -97161,7 +96424,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" } } } @@ -97182,13 +96445,13 @@ } } }, - "repository-vulnerability-alert-resolve": { + "secret-scanning-alert-assigned": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was marked as resolved.", - "operationId": "repository-vulnerability-alert/resolve", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -97253,7 +96516,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" } } } @@ -97266,10 +96529,11 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } @@ -97438,22 +96702,116 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" - }, - "examples": { - "default": { - "$ref": "#/components/examples/secret-scanning-alert-location-created" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" - } + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "secret_scanning_alert_location", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "secret-scanning-alert-publicly-leaked": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" } } } @@ -97465,9 +96823,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -97476,11 +96833,11 @@ } } }, - "secret-scanning-alert-publicly-leaked": { + "secret-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was detected in a public repo.", - "operationId": "secret-scanning-alert/publicly-leaked", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -97547,7 +96904,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" } } } @@ -97569,11 +96926,11 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-resolved": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -97640,7 +96997,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -97662,11 +97019,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-unassigned": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -97733,7 +97090,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } @@ -102256,6 +101613,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -120153,96 +119518,6 @@ "url" ] }, - "team-project": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": "string", - "nullable": true - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "$ref": "#/components/schemas/simple-user" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - }, "team-repository": { "title": "Team Repository", "description": "A team's access to a repository.", @@ -120750,79 +120025,6 @@ "updated_at" ] }, - "project-column": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - }, - "cards_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" - }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" - }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:22:28Z" - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - }, - "project-collaborator-permission": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", - "type": "object", - "properties": { - "permission": { - "type": "string" - }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" - } - }, - "required": [ - "permission", - "user" - ] - }, "rate-limit": { "title": "Rate Limit", "type": "object", @@ -123062,6 +122264,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -133385,6 +132588,11 @@ "type": "string", "nullable": true }, + "secret-scanning-alert-assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true + }, "secret-scanning-location": { "type": "object", "properties": { @@ -152099,6 +151307,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -152902,6 +152117,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -266659,6 +265881,44 @@ "sender" ] }, + "webhook-secret-scanning-alert-assigned": { + "title": "secret_scanning_alert assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, "webhook-secret-scanning-alert-created": { "title": "secret_scanning_alert created event", "type": "object", @@ -266813,19 +266073,57 @@ "repository" ] }, - "webhook-secret-scanning-alert-resolved": { - "title": "secret_scanning_alert resolved event", + "webhook-secret-scanning-alert-resolved": { + "title": "secret_scanning_alert resolved event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "resolved" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, + "webhook-secret-scanning-alert-unassigned": { + "title": "secret_scanning_alert unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolved" + "unassigned" ] }, "alert": { "$ref": "#/components/schemas/secret-scanning-alert-webhook" }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, @@ -281834,6 +281132,27 @@ } } }, + "update-budget": { + "value": { + "message": "Budget successfully updated.", + "budget": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "org-name/example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } + } + }, "delete-budget": { "value": { "message": "Budget successfully deleted.", @@ -286560,21 +285879,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -289331,94 +288668,6 @@ "state": "pending" } }, - "team-project-items": { - "value": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ] - }, - "team-project": { - "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - }, "team-repository-alternative-response-with-repository-permissions": { "value": { "id": 1296269, @@ -289578,43 +288827,6 @@ } ] }, - "project-column": { - "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - }, - "project-collaborator-permission": { - "value": { - "permission": "admin", - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - }, "rate-limit-overview": { "value": { "resources": { @@ -302541,7 +301753,27 @@ "resolution_comment": "Example comment", "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://alambic.github.com/avatars/u/1?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "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-location-list": { @@ -307305,6 +306537,194 @@ } } }, + "projects-v2-field-single-select-request": { + "summary": "Create a single select field", + "value": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + } + }, + "projects-v2-field-iteration-request": { + "summary": "Create an iteration field", + "value": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + } + }, + "projects-v2-field-text": { + "value": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + } + }, + "projects-v2-field-number": { + "value": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + } + }, + "projects-v2-field-date": { + "value": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + } + }, + "projects-v2-field-single-select": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + }, + "projects-v2-field-iteration": { + "value": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + }, "user-received-events-items": { "value": [ { @@ -310249,6 +309669,29 @@ "type": "string" } }, + "secret-scanning-alert-assignee": { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, "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.", @@ -310365,15 +309808,6 @@ "type": "integer" } }, - "project-id": { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, "security-product": { "name": "security_product", "in": "path", @@ -310405,15 +309839,6 @@ ] } }, - "column-id": { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, "artifact-name": { "name": "name", "description": "The name field of an artifact. When specified, only artifacts with this name will be returned.", diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index ba0ae443b..f66acdcf4 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -57,8 +57,6 @@ tags: description: Interact with organizations. - name: packages description: Manage packages for authenticated users and organizations. -- name: projects-classic - description: Interact with GitHub Projects (classic). - name: pulls description: Interact with GitHub Pull Requests. - name: rate-limit @@ -5581,9 +5579,7 @@ paths: in the budget examples: update-budget: - value: - message: Budget successfully updated. - id: 550e8400-e29b-41d4-a716-446655440000 + "$ref": "#/components/examples/update-budget" '400': "$ref": "#/components/responses/bad_request" '401': @@ -19274,6 +19270,7 @@ paths: - "$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-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" @@ -21445,179 +21442,6 @@ paths: enabledForGitHubApps: true category: teams subcategory: members - "/orgs/{org}/teams/{team_slug}/projects": - get: - summary: List team projects - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/list-projects-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-projects - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": - get: - summary: Check team permissions for a project - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/check-permissions-for-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/project-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project" - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - put: - summary: Add or update team project permissions - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/add-or-update-project-permissions-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/project-id" - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - nullable: true - examples: - default: - summary: Updates the permissions for the team to write for the project - value: - permission: write - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Remove a project from a team - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/remove-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/project-id" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/orgs/{org}/teams/{team_slug}/repos": get: summary: List team repositories @@ -21872,402 +21696,6 @@ paths: deprecationDate: '2024-07-22' removalDate: '2025-07-22' deprecated: true - "/projects/columns/{column_id}": - get: - summary: Get a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#get-a-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-column" - examples: - default: - "$ref": "#/components/examples/project-column" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update an existing project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/update-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project column - example: Remaining tasks - type: string - required: - - name - type: object - examples: - default: - summary: Rename the project column - value: - name: To Do - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-column" - examples: - default: - "$ref": "#/components/examples/project-column" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/delete-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#delete-a-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - responses: - '204': - description: Response - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/columns/{column_id}/moves": - post: - summary: Move a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/move-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#move-a-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - requestBody: - required: true - content: - application/json: - schema: - properties: - position: - description: 'The position of the column in a project. Can be one - of: `first`, `last`, or `after:` to place after the - specified column.' - example: last - type: string - pattern: "^(?:first|last|after:\\d+)$" - required: - - position - type: object - examples: - default: - summary: Move the column to the end of the board - value: - position: last - responses: - '201': - description: Response - content: - application/json: - schema: - type: object - properties: {} - additionalProperties: false - examples: - default: - value: - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '422': - "$ref": "#/components/responses/validation_failed_simple" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators": - get: - summary: List project collaborators - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/list-collaborators - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators - parameters: - - "$ref": "#/components/parameters/project-id" - - name: affiliation - description: Filters the collaborators by their affiliation. `outside` means - outside collaborators of a project that are not a member of the project's - organization. `direct` means collaborators with permissions to a project, - regardless of organization membership status. `all` means all collaborators - the authenticated user can see. - in: query - required: false - schema: - type: string - enum: - - outside - - direct - - all - default: all - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/simple-user" - examples: - default: - "$ref": "#/components/examples/simple-user-items" - headers: - Link: - "$ref": "#/components/headers/link" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators/{username}": - put: - summary: Add project collaborator - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/add-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator - parameters: - - "$ref": "#/components/parameters/project-id" - - "$ref": "#/components/parameters/username" - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - description: The permission to grant the collaborator. - enum: - - read - - write - - admin - default: write - example: write - type: string - nullable: true - examples: - default: - summary: Applying write permissions for the new collaborator - value: - permission: write - responses: - '204': - description: Response - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Remove user as a collaborator - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/remove-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator - parameters: - - "$ref": "#/components/parameters/project-id" - - "$ref": "#/components/parameters/username" - responses: - '204': - description: Response - '304': - "$ref": "#/components/responses/not_modified" - '404': - "$ref": "#/components/responses/not_found" - '403': - "$ref": "#/components/responses/forbidden" - '422': - "$ref": "#/components/responses/validation_failed" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators/{username}/permission": - get: - summary: Get project permission for a user - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-permission-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user - parameters: - - "$ref": "#/components/parameters/project-id" - - "$ref": "#/components/parameters/username" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-collaborator-permission" - examples: - default: - "$ref": "#/components/examples/project-collaborator-permission" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/rate_limit": get: summary: Get rate limit status for the authenticated user @@ -44849,6 +44277,7 @@ paths: - "$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-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" @@ -44928,6 +44357,8 @@ paths: description: |- Updates the status of a secret scanning alert in an eligible repository. + You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. 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. @@ -44954,14 +44385,26 @@ paths: "$ref": "#/components/schemas/secret-scanning-alert-resolution" resolution_comment: "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + assignee: + "$ref": "#/components/schemas/secret-scanning-alert-assignee" anyOf: - required: - state + - required: + - assignee examples: default: value: state: resolved resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: responses: '200': description: Response @@ -44979,7 +44422,8 @@ paths: description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': - description: State does not match the resolution or resolution comment + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository '503': "$ref": "#/components/responses/service_unavailable" x-github: @@ -48621,184 +48065,6 @@ paths: category: teams subcategory: members deprecated: true - "/teams/{team_id}/projects": - get: - summary: List team projects (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/list-projects-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project-items" - headers: - Link: - "$ref": "#/components/headers/link" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - "/teams/{team_id}/projects/{project_id}": - get: - summary: Check team permissions for a project (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/check-permissions-for-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/project-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project" - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - put: - summary: Add or update team project permissions (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/add-or-update-project-permissions-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/project-id" - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - examples: - default: - summary: Example of setting permission to read - value: - permission: read - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - delete: - summary: Remove a project from a team (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/remove-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/project-id" - responses: - '204': - description: Response - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true "/teams/{team_id}/repos": get: summary: List team repositories (Legacy) @@ -54766,6 +54032,144 @@ paths: enabledForGitHubApps: true category: projects subcategory: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project + parameters: + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/project-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + - single_select + - iteration + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + iteration_configuration: + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: The duration of the iteration in days. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + properties: + title: + type: string + description: The title for the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + required: + - name + - data_type + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select-request" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration-request" + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-field" + examples: + text_field: + "$ref": "#/components/examples/projects-v2-field-text" + number_field: + "$ref": "#/components/examples/projects-v2-field-number" + date_field: + "$ref": "#/components/examples/projects-v2-field-date" + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields "/users/{username}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for user @@ -64656,7 +64060,279 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-card-moved" + "$ref": "#/components/schemas/webhook-project-card-moved" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: project_card + supported-webhook-types: + - repository + - organization + - app + project-closed: + post: + summary: |- + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: A project (classic) was closed. + operationId: project/closed + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-project-closed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: project + supported-webhook-types: + - repository + - organization + - app + project-column-created: + post: + summary: |- + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: A column was added to a project (classic). + operationId: project-column/created + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-project-column-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: project_column + supported-webhook-types: + - repository + - organization + - app + project-column-deleted: + post: + summary: |- + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: A column was deleted from a project (classic). + operationId: project-column/deleted + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-project-column-deleted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: project_column + supported-webhook-types: + - repository + - organization + - app + project-column-edited: + post: + summary: |- + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: The name of a column on a project (classic) was changed. + operationId: project-column/edited + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-project-column-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64664,25 +64340,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_card + subcategory: project_column supported-webhook-types: - repository - organization - app - project-closed: + project-column-moved: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A project (classic) was closed. - operationId: project/closed + description: A column was moved to a new position on a project (classic). + operationId: project-column/moved externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header @@ -64724,7 +64400,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-closed" + "$ref": "#/components/schemas/webhook-project-column-moved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64732,25 +64408,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project + subcategory: project_column supported-webhook-types: - repository - organization - app - project-column-created: + project-created: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A column was added to a project (classic). - operationId: project-column/created + description: A project (classic) was created. + operationId: project/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -64792,7 +64468,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-column-created" + "$ref": "#/components/schemas/webhook-project-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64800,25 +64476,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_column + subcategory: project supported-webhook-types: - repository - organization - app - project-column-deleted: + project-deleted: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A column was deleted from a project (classic). - operationId: project-column/deleted + description: A project (classic) was deleted. + operationId: project/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -64860,7 +64536,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-column-deleted" + "$ref": "#/components/schemas/webhook-project-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64868,25 +64544,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_column + subcategory: project supported-webhook-types: - repository - organization - app - project-column-edited: + project-edited: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: The name of a column on a project (classic) was changed. - operationId: project-column/edited + description: The name or description of a project (classic) was changed. + operationId: project/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -64928,7 +64604,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-column-edited" + "$ref": "#/components/schemas/webhook-project-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64936,25 +64612,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_column + subcategory: project supported-webhook-types: - repository - organization - app - project-column-moved: + project-reopened: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A column was moved to a new position on a project (classic). - operationId: project-column/moved + description: A project (classic) was closed. + operationId: project/reopened externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -64996,7 +64672,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-column-moved" + "$ref": "#/components/schemas/webhook-project-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65004,25 +64680,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_column + subcategory: project supported-webhook-types: - repository - organization - app - project-created: + projects-v2-closed: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A project (classic) was created. - operationId: project/created + > [!NOTE] + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A project in the organization was closed. + operationId: projects-v2/closed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -65036,7 +64713,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65064,33 +64741,33 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-created" + "$ref": "#/components/schemas/webhook-projects-v2-project-closed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: project + subcategory: projects_v2 supported-webhook-types: - - repository - organization - - app - project-deleted: + projects-v2-created: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A project (classic) was deleted. - operationId: project/deleted + > [!NOTE] + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A project in the organization was created. + operationId: projects-v2/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -65104,7 +64781,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65132,33 +64809,33 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-project-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: project + subcategory: projects_v2 supported-webhook-types: - - repository - organization - - app - project-edited: + projects-v2-deleted: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: The name or description of a project (classic) was changed. - operationId: project/edited + > [!NOTE] + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A project in the organization was deleted. + operationId: projects-v2/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -65172,7 +64849,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65200,33 +64877,34 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-edited" + "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: project + subcategory: projects_v2 supported-webhook-types: - - repository - organization - - app - project-reopened: + projects-v2-edited: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A project (classic) was closed. - operationId: project/reopened + > [!NOTE] + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: The title, description, or README of a project in the organization + was changed. + operationId: projects-v2/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -65240,7 +64918,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65268,34 +64946,34 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-reopened" + "$ref": "#/components/schemas/webhook-projects-v2-project-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: project + subcategory: projects_v2 supported-webhook-types: - - repository - organization - - app - projects-v2-closed: + projects-v2-item-archived: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A project in the organization was closed. - operationId: projects-v2/closed + description: An item on an organization project was archived. For more information, + see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." + operationId: projects-v2-item/archived externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -65309,7 +64987,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65337,7 +65015,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-closed" + "$ref": "#/components/schemas/webhook-projects-v2-item-archived" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65346,24 +65024,24 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-created: + projects-v2-item-converted: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A project in the organization was created. - operationId: projects-v2/created + description: A draft issue in an organization project was converted to an issue. + operationId: projects-v2-item/converted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -65377,7 +65055,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65405,7 +65083,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-created" + "$ref": "#/components/schemas/webhook-projects-v2-item-converted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65414,24 +65092,24 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-deleted: + projects-v2-item-created: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A project in the organization was deleted. - operationId: projects-v2/deleted + description: An item was added to a project in the organization. + operationId: projects-v2-item/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -65445,7 +65123,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65473,7 +65151,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-item-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65482,25 +65160,24 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-edited: + projects-v2-item-deleted: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: The title, description, or README of a project in the organization - was changed. - operationId: projects-v2/edited + description: An item was deleted from a project in the organization. + operationId: projects-v2-item/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -65514,7 +65191,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65542,7 +65219,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65551,10 +65228,10 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-archived: + projects-v2-item-edited: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). @@ -65565,9 +65242,10 @@ x-webhooks: > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: An item on an organization project was archived. For more information, - see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." - operationId: projects-v2-item/archived + description: The values or state of an item in an organization project were + changed. For example, the value of a field was updated, the body of a draft + issue was changed, or a draft issue was converted to an issue. + operationId: projects-v2-item/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: @@ -65611,7 +65289,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-archived" + "$ref": "#/components/schemas/webhook-projects-v2-item-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65623,7 +65301,7 @@ x-webhooks: subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-converted: + projects-v2-item-reordered: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). @@ -65634,8 +65312,10 @@ x-webhooks: > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A draft issue in an organization project was converted to an issue. - operationId: projects-v2-item/converted + description: The position of an item in an organization project was changed. + For example, an item was moved above or below another item in the table or + board layout. + operationId: projects-v2-item/reordered externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: @@ -65679,7 +65359,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-converted" + "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65691,7 +65371,7 @@ x-webhooks: subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-created: + projects-v2-item-restored: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). @@ -65702,8 +65382,9 @@ x-webhooks: > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: An item was added to a project in the organization. - operationId: projects-v2-item/created + description: An archived item on an organization project was restored from the + archive. For more information, see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." + operationId: projects-v2-item/restored externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: @@ -65747,7 +65428,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-created" + "$ref": "#/components/schemas/webhook-projects-v2-item-restored" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65759,21 +65440,21 @@ x-webhooks: subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-deleted: + projects-v2-reopened: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: An item was deleted from a project in the organization. - operationId: projects-v2-item/deleted + description: A project in the organization was reopened. + operationId: projects-v2/reopened externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -65787,7 +65468,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65815,7 +65496,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65824,26 +65505,24 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: projects_v2 supported-webhook-types: - organization - projects-v2-item-edited: + projects-v2-status-update-created: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project, use the `projects_v2` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: The values or state of an item in an organization project were - changed. For example, the value of a field was updated, the body of a draft - issue was changed, or a draft issue was converted to an issue. - operationId: projects-v2-item/edited + > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A status update was added to a project in the organization. + operationId: projects-v2-status-update/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header @@ -65857,7 +65536,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: project-v2-status-update schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65885,7 +65564,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-edited" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65894,26 +65573,24 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: projects_v2_status_update supported-webhook-types: - organization - projects-v2-item-reordered: + projects-v2-status-update-deleted: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project, use the `projects_v2` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: The position of an item in an organization project was changed. - For example, an item was moved above or below another item in the table or - board layout. - operationId: projects-v2-item/reordered + > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A status update was removed from a project in the organization. + operationId: projects-v2-status-update/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header @@ -65927,7 +65604,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: project-v2-status-update schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -65955,7 +65632,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65964,25 +65641,24 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: projects_v2_status_update supported-webhook-types: - organization - projects-v2-item-restored: + projects-v2-status-update-edited: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project, use the `projects_v2` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: An archived item on an organization project was restored from the - archive. For more information, see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." - operationId: projects-v2-item/restored + > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A status update was edited on a project in the organization. + operationId: projects-v2-status-update/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header @@ -65996,7 +65672,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: project-v2-status-update schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -66024,7 +65700,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-restored" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66033,24 +65709,18 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: projects_v2_status_update supported-webhook-types: - organization - projects-v2-reopened: + public: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + This event occurs when repository visibility changes from private to public. For more information, see "[Setting repository visibility](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." - > [!NOTE] - > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A project in the organization was reopened. - operationId: projects-v2/reopened + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + operationId: public externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#public parameters: - name: User-Agent in: header @@ -66064,7 +65734,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -66092,33 +65762,31 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" + "$ref": "#/components/schemas/webhook-public" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: public supported-webhook-types: + - repository - organization - projects-v2-status-update-created: + - app + pull-request-assigned: post: summary: |- - This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - - For activity relating to a project, use the `projects_v2` event. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - > [!NOTE] - > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A status update was added to a project in the organization. - operationId: projects-v2-status-update/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A pull request was assigned to a user. + operationId: pull-request/assigned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -66132,7 +65800,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-status-update + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -66160,33 +65828,32 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" + "$ref": "#/components/schemas/webhook-pull-request-assigned" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_status_update + subcategory: pull_request supported-webhook-types: + - repository - organization - projects-v2-status-update-deleted: + - app + pull-request-auto-merge-disabled: post: summary: |- - This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - - For activity relating to a project, use the `projects_v2` event. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - > [!NOTE] - > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A status update was removed from a project in the organization. - operationId: projects-v2-status-update/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: Auto merge was disabled for a pull request. For more information, + see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." + operationId: pull-request/auto-merge-disabled externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -66200,7 +65867,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-status-update + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -66228,33 +65895,32 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_status_update + subcategory: pull_request supported-webhook-types: + - repository - organization - projects-v2-status-update-edited: + - app + pull-request-auto-merge-enabled: post: summary: |- - This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - - For activity relating to a project, use the `projects_v2` event. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - > [!NOTE] - > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A status update was edited on a project in the organization. - operationId: projects-v2-status-update/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: Auto merge was enabled for a pull request. For more information, + see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." + operationId: pull-request/auto-merge-enabled externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -66268,7 +65934,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-status-update + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -66296,27 +65962,33 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_status_update + subcategory: pull_request supported-webhook-types: + - repository - organization - public: + - app + pull-request-closed: post: summary: |- - This event occurs when repository visibility changes from private to public. For more information, see "[Setting repository visibility](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - operationId: public + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A pull request was closed. If `merged` is false in the webhook + payload, the pull request was closed with unmerged commits. If `merged` is + true in the webhook payload, the pull request was merged. + operationId: pull-request/closed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#public + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -66358,7 +66030,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-public" + "$ref": "#/components/schemas/webhook-pull-request-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66366,12 +66038,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: public + subcategory: pull_request supported-webhook-types: - repository - organization - app - pull-request-assigned: + pull-request-converted-to-draft: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -66379,8 +66051,9 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was assigned to a user. - operationId: pull-request/assigned + description: A pull request was converted to a draft. For more information, + see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." + operationId: pull-request/converted-to-draft externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -66424,7 +66097,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-assigned" + "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66437,7 +66110,7 @@ x-webhooks: - repository - organization - app - pull-request-auto-merge-disabled: + pull-request-demilestoned: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -66445,9 +66118,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Auto merge was disabled for a pull request. For more information, - see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." - operationId: pull-request/auto-merge-disabled + description: A pull request was removed from a milestone. + operationId: pull-request/demilestoned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -66491,74 +66163,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-auto-merge-enabled: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Auto merge was enabled for a pull request. For more information, - see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." - operationId: pull-request/auto-merge-enabled - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" + "$ref": "#/components/schemas/webhook-pull-request-demilestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66571,7 +66176,7 @@ x-webhooks: - repository - organization - app - pull-request-closed: + pull-request-dequeued: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -66579,10 +66184,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was closed. If `merged` is false in the webhook - payload, the pull request was closed with unmerged commits. If `merged` is - true in the webhook payload, the pull request was merged. - operationId: pull-request/closed + description: A pull request was removed from the merge queue. + operationId: pull-request/dequeued externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -66626,7 +66229,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-closed" + "$ref": "#/components/schemas/webhook-pull-request-dequeued" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66639,7 +66242,7 @@ x-webhooks: - repository - organization - app - pull-request-converted-to-draft: + pull-request-edited: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -66647,9 +66250,9 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was converted to a draft. For more information, - see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." - operationId: pull-request/converted-to-draft + description: The title or body of a pull request was edited, or the base branch + of a pull request was changed. + operationId: pull-request/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -66693,7 +66296,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" + "$ref": "#/components/schemas/webhook-pull-request-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66706,7 +66309,7 @@ x-webhooks: - repository - organization - app - pull-request-demilestoned: + pull-request-enqueued: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -66714,8 +66317,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was removed from a milestone. - operationId: pull-request/demilestoned + description: A pull request was added to the merge queue. + operationId: pull-request/enqueued externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -66759,7 +66362,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-demilestoned" + "$ref": "#/components/schemas/webhook-pull-request-enqueued" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66772,7 +66375,7 @@ x-webhooks: - repository - organization - app - pull-request-dequeued: + pull-request-labeled: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -66780,8 +66383,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was removed from the merge queue. - operationId: pull-request/dequeued + description: A label was added to a pull request. + operationId: pull-request/labeled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -66825,7 +66428,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-dequeued" + "$ref": "#/components/schemas/webhook-pull-request-labeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66838,7 +66441,7 @@ x-webhooks: - repository - organization - app - pull-request-edited: + pull-request-locked: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -66846,9 +66449,9 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: The title or body of a pull request was edited, or the base branch - of a pull request was changed. - operationId: pull-request/edited + description: Conversation on a pull request was locked. For more information, + see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: pull-request/locked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -66892,7 +66495,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-edited" + "$ref": "#/components/schemas/webhook-pull-request-locked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66905,7 +66508,7 @@ x-webhooks: - repository - organization - app - pull-request-enqueued: + pull-request-milestoned: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -66913,8 +66516,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was added to the merge queue. - operationId: pull-request/enqueued + description: A pull request was added to a milestone. + operationId: pull-request/milestoned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -66958,7 +66561,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-enqueued" + "$ref": "#/components/schemas/webhook-pull-request-milestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66971,7 +66574,7 @@ x-webhooks: - repository - organization - app - pull-request-labeled: + pull-request-opened: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -66979,8 +66582,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A label was added to a pull request. - operationId: pull-request/labeled + description: A pull request was created + operationId: pull-request/opened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -67024,7 +66627,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-labeled" + "$ref": "#/components/schemas/webhook-pull-request-opened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67037,7 +66640,7 @@ x-webhooks: - repository - organization - app - pull-request-locked: + pull-request-ready-for-review: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -67045,9 +66648,9 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Conversation on a pull request was locked. For more information, - see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: pull-request/locked + description: A draft pull request was marked as ready for review. For more information, + see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." + operationId: pull-request/ready-for-review externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -67091,7 +66694,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-locked" + "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67104,7 +66707,7 @@ x-webhooks: - repository - organization - app - pull-request-milestoned: + pull-request-reopened: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -67112,8 +66715,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was added to a milestone. - operationId: pull-request/milestoned + description: A previously closed pull request was reopened. + operationId: pull-request/reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -67157,7 +66760,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-milestoned" + "$ref": "#/components/schemas/webhook-pull-request-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67170,18 +66773,18 @@ x-webhooks: - repository - organization - app - pull-request-opened: + pull-request-review-comment-created: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was created - operationId: pull-request/opened + description: A comment on a pull request diff was created. + operationId: pull-request-review-comment/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header @@ -67223,7 +66826,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-opened" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67231,24 +66834,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: pull_request_review_comment supported-webhook-types: - repository - organization - app - pull-request-ready-for-review: + pull-request-review-comment-deleted: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A draft pull request was marked as ready for review. For more information, - see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." - operationId: pull-request/ready-for-review + description: A comment on a pull request diff was deleted. + operationId: pull-request-review-comment/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header @@ -67290,7 +66892,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67298,23 +66900,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: pull_request_review_comment supported-webhook-types: - repository - organization - app - pull-request-reopened: + pull-request-review-comment-edited: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A previously closed pull request was reopened. - operationId: pull-request/reopened + description: The content of a comment on a pull request diff was changed. + operationId: pull-request-review-comment/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header @@ -67356,7 +66958,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-reopened" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67364,23 +66966,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: pull_request_review_comment supported-webhook-types: - repository - organization - app - pull-request-review-comment-created: + pull-request-review-dismissed: post: summary: |- - This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. - For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A comment on a pull request diff was created. - operationId: pull-request-review-comment/created + description: A review on a pull request was dismissed. + operationId: pull-request-review/dismissed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header @@ -67422,7 +67024,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" + "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67430,23 +67032,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review_comment + subcategory: pull_request_review supported-webhook-types: - repository - organization - app - pull-request-review-comment-deleted: + pull-request-review-edited: post: summary: |- - This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. - For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A comment on a pull request diff was deleted. - operationId: pull-request-review-comment/deleted + description: The body comment on a pull request review was edited. + operationId: pull-request-review/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header @@ -67488,7 +67090,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" + "$ref": "#/components/schemas/webhook-pull-request-review-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67496,23 +67098,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review_comment + subcategory: pull_request_review supported-webhook-types: - repository - organization - app - pull-request-review-comment-edited: + pull-request-review-request-removed: post: summary: |- - This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: The content of a comment on a pull request diff was changed. - operationId: pull-request-review-comment/edited + description: A request for review by a person or team was removed from a pull + request. + operationId: pull-request/review-request-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -67554,7 +67157,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67562,23 +67165,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review_comment + subcategory: pull_request supported-webhook-types: - repository - organization - app - pull-request-review-dismissed: + pull-request-review-requested: post: summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A review on a pull request was dismissed. - operationId: pull-request-review/dismissed + description: Review by a person or team was requested for a pull request. For + more information, see "[Requesting a pull request review](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." + operationId: pull-request/review-requested externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -67620,7 +67224,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" + "$ref": "#/components/schemas/webhook-pull-request-review-requested" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67628,12 +67232,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review + subcategory: pull_request supported-webhook-types: - repository - organization - app - pull-request-review-edited: + pull-request-review-submitted: post: summary: |- This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. @@ -67641,8 +67245,8 @@ x-webhooks: For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: The body comment on a pull request review was edited. - operationId: pull-request-review/edited + description: A review on a pull request was submitted. + operationId: pull-request-review/submitted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review parameters: @@ -67686,7 +67290,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-submitted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67699,152 +67303,18 @@ x-webhooks: - repository - organization - app - pull-request-review-request-removed: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A request for review by a person or team was removed from a pull - request. - operationId: pull-request/review-request-removed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-review-requested: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Review by a person or team was requested for a pull request. For - more information, see "[Requesting a pull request review](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." - operationId: pull-request/review-requested - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-pull-request-review-requested" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-review-submitted: + pull-request-review-thread-resolved: post: summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A review on a pull request was submitted. - operationId: pull-request-review/submitted + description: A comment thread on a pull request was marked as resolved. + operationId: pull-request-review-thread/resolved externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: - name: User-Agent in: header @@ -67886,7 +67356,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-submitted" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67894,12 +67364,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review + subcategory: pull_request_review_thread supported-webhook-types: - repository - organization - app - pull-request-review-thread-resolved: + pull-request-review-thread-unresolved: post: summary: |- This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. @@ -67907,8 +67377,9 @@ x-webhooks: For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A comment thread on a pull request was marked as resolved. - operationId: pull-request-review-thread/resolved + description: A previously resolved comment thread on a pull request was marked + as unresolved. + operationId: pull-request-review-thread/unresolved externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: @@ -67952,7 +67423,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67965,19 +67436,20 @@ x-webhooks: - repository - organization - app - pull-request-review-thread-unresolved: + pull-request-synchronize: post: summary: |- - This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A previously resolved comment thread on a pull request was marked - as unresolved. - operationId: pull-request-review-thread/unresolved + description: A pull request's head branch was updated. For example, the head + branch was updated from the base branch or new commits were pushed to the + head branch. + operationId: pull-request/synchronize externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -68019,7 +67491,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" + "$ref": "#/components/schemas/webhook-pull-request-synchronize" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68027,12 +67499,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review_thread + subcategory: pull_request supported-webhook-types: - repository - organization - app - pull-request-synchronize: + pull-request-unassigned: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -68040,10 +67512,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request's head branch was updated. For example, the head - branch was updated from the base branch or new commits were pushed to the - head branch. - operationId: pull-request/synchronize + description: A user was unassigned from a pull request. + operationId: pull-request/unassigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -68087,7 +67557,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-synchronize" + "$ref": "#/components/schemas/webhook-pull-request-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68100,7 +67570,7 @@ x-webhooks: - repository - organization - app - pull-request-unassigned: + pull-request-unlabeled: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -68108,8 +67578,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A user was unassigned from a pull request. - operationId: pull-request/unassigned + description: A label was removed from a pull request. + operationId: pull-request/unlabeled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -68153,7 +67623,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-unassigned" + "$ref": "#/components/schemas/webhook-pull-request-unlabeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68166,7 +67636,7 @@ x-webhooks: - repository - organization - app - pull-request-unlabeled: + pull-request-unlocked: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -68174,8 +67644,9 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A label was removed from a pull request. - operationId: pull-request/unlabeled + description: Conversation on a pull request was unlocked. For more information, + see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: pull-request/unlocked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -68219,7 +67690,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-unlabeled" + "$ref": "#/components/schemas/webhook-pull-request-unlocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68232,19 +67703,20 @@ x-webhooks: - repository - organization - app - pull-request-unlocked: + push: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, + when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch + and tag deletions, use the [`delete`](#delete) webhook event. - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Conversation on a pull request was unlocked. For more information, - see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: pull-request/unlocked + > [!NOTE] + > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. + operationId: push externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#push parameters: - name: User-Agent in: header @@ -68286,7 +67758,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-unlocked" + "$ref": "#/components/schemas/webhook-push" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68294,25 +67766,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: push supported-webhook-types: - repository - organization - app - push: + registry-package-published: post: summary: |- - This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, - when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch - and tag deletions, use the [`delete`](#delete) webhook event. + This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. > [!NOTE] - > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. - operationId: push + > GitHub recommends that you use the newer `package` event instead. + description: A package was published to a registry. + operationId: registry-package/published externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#push + url: https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package parameters: - name: User-Agent in: header @@ -68354,7 +67825,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-push" + "$ref": "#/components/schemas/webhook-registry-package-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68362,12 +67833,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: push + subcategory: registry_package supported-webhook-types: - repository - organization - app - registry-package-published: + registry-package-updated: post: summary: |- This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. @@ -68376,8 +67847,8 @@ x-webhooks: > [!NOTE] > GitHub recommends that you use the newer `package` event instead. - description: A package was published to a registry. - operationId: registry-package/published + description: A package that was previously published to a registry was updated. + operationId: registry-package/updated externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package parameters: @@ -68421,7 +67892,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-registry-package-published" + "$ref": "#/components/schemas/webhook-registry-package-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68434,19 +67905,17 @@ x-webhooks: - repository - organization - app - registry-package-updated: + release-created: post: summary: |- - This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. - - To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. - > [!NOTE] - > GitHub recommends that you use the newer `package` event instead. - description: A package that was previously published to a registry was updated. - operationId: registry-package/updated + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + description: A draft was saved, or a release or pre-release was published without + previously being saved as a draft. + operationId: release/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package + url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -68488,7 +67957,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-registry-package-updated" + "$ref": "#/components/schemas/webhook-release-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68496,20 +67965,19 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: registry_package + subcategory: release supported-webhook-types: - repository - organization - app - release-created: + release-deleted: post: summary: |- This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A draft was saved, or a release or pre-release was published without - previously being saved as a draft. - operationId: release/created + description: A release, pre-release, or draft release was deleted. + operationId: release/deleted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: @@ -68553,7 +68021,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-created" + "$ref": "#/components/schemas/webhook-release-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68566,14 +68034,15 @@ x-webhooks: - repository - organization - app - release-deleted: + release-edited: post: summary: |- This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release, pre-release, or draft release was deleted. - operationId: release/deleted + description: The details of a release, pre-release, or draft release were edited. + For more information, see "[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)." + operationId: release/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: @@ -68617,7 +68086,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-deleted" + "$ref": "#/components/schemas/webhook-release-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68630,15 +68099,15 @@ x-webhooks: - repository - organization - app - release-edited: + release-prereleased: post: summary: |- This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: The details of a release, pre-release, or draft release were edited. - For more information, see "[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)." - operationId: release/edited + description: A release was created and identified as a pre-release. A pre-release + is a release that is not ready for production and may be unstable. + operationId: release/prereleased externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: @@ -68682,7 +68151,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-edited" + "$ref": "#/components/schemas/webhook-release-prereleased" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68695,15 +68164,14 @@ x-webhooks: - repository - organization - app - release-prereleased: + release-published: post: summary: |- This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release was created and identified as a pre-release. A pre-release - is a release that is not ready for production and may be unstable. - operationId: release/prereleased + description: A release, pre-release, or draft of a release was published. + operationId: release/published externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: @@ -68747,7 +68215,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-prereleased" + "$ref": "#/components/schemas/webhook-release-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68760,14 +68228,14 @@ x-webhooks: - repository - organization - app - release-published: + release-released: post: summary: |- This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release, pre-release, or draft of a release was published. - operationId: release/published + description: A release was published, or a pre-release was changed to a release. + operationId: release/released externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: @@ -68811,7 +68279,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-published" + "$ref": "#/components/schemas/webhook-release-released" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68824,14 +68292,14 @@ x-webhooks: - repository - organization - app - release-released: + release-unpublished: post: summary: |- This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release was published, or a pre-release was changed to a release. - operationId: release/released + description: A release or pre-release was unpublished. + operationId: release/unpublished externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: @@ -68875,7 +68343,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-released" + "$ref": "#/components/schemas/webhook-release-unpublished" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68888,16 +68356,16 @@ x-webhooks: - repository - organization - app - release-unpublished: + repository-advisory-published: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release or pre-release was unpublished. - operationId: release/unpublished + To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. + description: A repository security advisory was published. + operationId: repository-advisory/published externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory parameters: - name: User-Agent in: header @@ -68939,7 +68407,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-unpublished" + "$ref": "#/components/schemas/webhook-repository-advisory-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68947,19 +68415,19 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: release + subcategory: repository_advisory supported-webhook-types: - repository - organization - app - repository-advisory-published: + repository-advisory-reported: post: summary: |- This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. - description: A repository security advisory was published. - operationId: repository-advisory/published + description: A private vulnerability report was submitted. + operationId: repository-advisory/reported externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory parameters: @@ -69003,7 +68471,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-advisory-published" + "$ref": "#/components/schemas/webhook-repository-advisory-reported" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69016,16 +68484,16 @@ x-webhooks: - repository - organization - app - repository-advisory-reported: + repository-archived: post: summary: |- - This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. - description: A private vulnerability report was submitted. - operationId: repository-advisory/reported + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A repository was archived. + operationId: repository/archived externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -69067,7 +68535,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-advisory-reported" + "$ref": "#/components/schemas/webhook-repository-archived" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69075,19 +68543,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_advisory + subcategory: repository supported-webhook-types: + - business - repository - organization - app - repository-archived: + repository-created: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A repository was archived. - operationId: repository/archived + description: A repository was created. + operationId: repository/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: @@ -69131,7 +68600,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-archived" + "$ref": "#/components/schemas/webhook-repository-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69145,14 +68614,142 @@ x-webhooks: - repository - organization - app - repository-created: + repository-deleted: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A repository was created. - operationId: repository/created + description: A repository was deleted. GitHub Apps and repository webhooks will + not receive this event. + operationId: repository/deleted + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-repository-deleted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: repository + supported-webhook-types: + - business + - repository + - organization + - app + repository-dispatch-sample.collected: + post: + summary: |- + This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + operationId: repository-dispatch/sample.collected + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: repository_dispatch + supported-webhook-types: + - app + repository-edited: + post: + summary: |- + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: The topics, default branch, description, or homepage of a repository + was changed. + operationId: repository/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: @@ -69196,7 +68793,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-created" + "$ref": "#/components/schemas/webhook-repository-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69210,17 +68807,14 @@ x-webhooks: - repository - organization - app - repository-deleted: + repository-import: post: - summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A repository was deleted. GitHub Apps and repository webhooks will - not receive this event. - operationId: repository/deleted + summary: This event occurs when a repository is imported to GitHub. For more + information, see "[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer)." + For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports). + operationId: repository-import externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import parameters: - name: User-Agent in: header @@ -69262,7 +68856,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-deleted" + "$ref": "#/components/schemas/webhook-repository-import" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69270,21 +68864,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: repository_import supported-webhook-types: - - business - repository - organization - - app - repository-dispatch-sample.collected: + repository-privatized: post: summary: |- - This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - operationId: repository-dispatch/sample.collected + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: The visibility of a repository was changed to `private`. + operationId: repository/privatized externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -69326,7 +68919,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + "$ref": "#/components/schemas/webhook-repository-privatized" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69334,18 +68927,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_dispatch + subcategory: repository supported-webhook-types: + - business + - repository + - organization - app - repository-edited: + repository-publicized: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: The topics, default branch, description, or homepage of a repository - was changed. - operationId: repository/edited + description: The visibility of a repository was changed to `public`. + operationId: repository/publicized externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: @@ -69389,7 +68984,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-repository-publicized" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69403,75 +68998,14 @@ x-webhooks: - repository - organization - app - repository-import: - post: - summary: This event occurs when a repository is imported to GitHub. For more - information, see "[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer)." - For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports). - operationId: repository-import - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-repository-import" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository_import - supported-webhook-types: - - repository - - organization - repository-privatized: + repository-renamed: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: The visibility of a repository was changed to `private`. - operationId: repository/privatized + description: The name of a repository was changed. + operationId: repository/renamed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: @@ -69515,7 +69049,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-repository-renamed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69529,16 +69063,18 @@ x-webhooks: - repository - organization - app - repository-publicized: + repository-ruleset-created: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repository rulesets. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: The visibility of a repository was changed to `public`. - operationId: repository/publicized + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. + description: A repository ruleset was created. + operationId: repository-ruleset/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset parameters: - name: User-Agent in: header @@ -69580,7 +69116,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69588,22 +69124,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: repository_ruleset supported-webhook-types: - - business - repository - organization - app - repository-renamed: + repository-ruleset-deleted: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repository rulesets. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: The name of a repository was changed. - operationId: repository/renamed + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. + description: A repository ruleset was deleted. + operationId: repository-ruleset/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset parameters: - name: User-Agent in: header @@ -69645,7 +69182,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69653,13 +69190,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: repository_ruleset supported-webhook-types: - - business - repository - organization - app - repository-ruleset-created: + repository-ruleset-edited: post: summary: |- This event occurs when there is activity relating to repository rulesets. @@ -69667,8 +69203,8 @@ x-webhooks: For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. - description: A repository ruleset was created. - operationId: repository-ruleset/created + description: A repository ruleset was edited. + operationId: repository-ruleset/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset parameters: @@ -69712,7 +69248,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-ruleset-created" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69725,18 +69261,20 @@ x-webhooks: - repository - organization - app - repository-ruleset-deleted: + repository-transferred: post: summary: |- - This event occurs when there is activity relating to repository rulesets. - For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." - For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. - description: A repository ruleset was deleted. - operationId: repository-ruleset/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Ownership of the repository was transferred to a user or organization + account. This event is only sent to the account where the ownership is transferred. + To receive the `repository.transferred` event, the new owner account must + have the GitHub App installed, and the App must be subscribed to "Repository" + events. + operationId: repository/transferred externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -69778,7 +69316,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" + "$ref": "#/components/schemas/webhook-repository-transferred" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69786,23 +69324,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_ruleset + subcategory: repository supported-webhook-types: + - business - repository - organization - app - repository-ruleset-edited: + repository-unarchived: post: summary: |- - This event occurs when there is activity relating to repository rulesets. - For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." - For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. - description: A repository ruleset was edited. - operationId: repository-ruleset/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A previously archived repository was unarchived. + operationId: repository/unarchived externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -69844,7 +69381,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-ruleset-edited" + "$ref": "#/components/schemas/webhook-repository-unarchived" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69852,25 +69389,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_ruleset + subcategory: repository supported-webhook-types: + - business - repository - organization - app - repository-transferred: + repository-vulnerability-alert-create: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to a security vulnerability alert in a repository. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Ownership of the repository was transferred to a user or organization - account. This event is only sent to the account where the ownership is transferred. - To receive the `repository.transferred` event, the new owner account must - have the GitHub App installed, and the App must be subscribed to "Repository" - events. - operationId: repository/transferred + > [!WARNING] + > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. + description: A repository vulnerability alert was created. + operationId: repository-vulnerability-alert/create externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -69912,7 +69447,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69920,22 +69455,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: repository_vulnerability_alert supported-webhook-types: - - business - repository - organization - - app - repository-unarchived: + repository-vulnerability-alert-dismiss: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to a security vulnerability alert in a repository. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A previously archived repository was unarchived. - operationId: repository/unarchived + > [!WARNING] + > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. + description: A repository vulnerability alert was dismissed. + operationId: repository-vulnerability-alert/dismiss externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -69977,7 +69511,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69985,21 +69519,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: repository_vulnerability_alert supported-webhook-types: - - business - repository - organization - - app - repository-vulnerability-alert-create: + repository-vulnerability-alert-reopen: post: summary: |- This event occurs when there is activity relating to a security vulnerability alert in a repository. > [!WARNING] > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. - description: A repository vulnerability alert was created. - operationId: repository-vulnerability-alert/create + description: A previously dismissed or resolved repository vulnerability alert + was reopened. + operationId: repository-vulnerability-alert/reopen externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: @@ -70043,7 +69576,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70055,15 +69588,15 @@ x-webhooks: supported-webhook-types: - repository - organization - repository-vulnerability-alert-dismiss: + repository-vulnerability-alert-resolve: post: summary: |- This event occurs when there is activity relating to a security vulnerability alert in a repository. > [!WARNING] > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. - description: A repository vulnerability alert was dismissed. - operationId: repository-vulnerability-alert/dismiss + description: A repository vulnerability alert was marked as resolved. + operationId: repository-vulnerability-alert/resolve externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: @@ -70107,7 +69640,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70119,18 +69652,18 @@ x-webhooks: supported-webhook-types: - repository - organization - repository-vulnerability-alert-reopen: + secret-scanning-alert-assigned: post: summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - > [!WARNING] - > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. - description: A previously dismissed or resolved repository vulnerability alert - was reopened. - operationId: repository-vulnerability-alert/reopen + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was assigned. + operationId: secret-scanning-alert/assigned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -70172,7 +69705,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70180,21 +69713,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_vulnerability_alert + subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - repository-vulnerability-alert-resolve: + - app + secret-scanning-alert-created: post: summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - > [!WARNING] - > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. - description: A repository vulnerability alert was marked as resolved. - operationId: repository-vulnerability-alert/resolve + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was created. + operationId: secret-scanning-alert/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -70236,7 +69771,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70244,22 +69779,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_vulnerability_alert + subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - secret-scanning-alert-created: + - app + secret-scanning-alert-location-created: post: summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to the locations of a secret in a secret scanning alert. - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alerts, use the `secret_scanning_alert` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was created. - operationId: secret-scanning-alert/created + description: A new instance of a previously detected secret was detected in + a repository, and the location of the secret was added to the existing alert. + operationId: secret-scanning-alert-location/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location parameters: - name: User-Agent in: header @@ -70301,34 +69840,41 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" + examples: + default: + "$ref": "#/components/examples/secret-scanning-alert-location-created" + application/x-www-form-urlencoded: + schema: + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" + examples: + default: + "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: secret_scanning_alert + subcategory: secret_scanning_alert_location supported-webhook-types: - repository - organization - app - secret-scanning-alert-location-created: + secret-scanning-alert-publicly-leaked: post: summary: |- - This event occurs when there is activity relating to the locations of a secret in a secret scanning alert. - - For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - For activity relating to secret scanning alerts, use the `secret_scanning_alert` event. + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A new instance of a previously detected secret was detected in - a repository, and the location of the secret was added to the existing alert. - operationId: secret-scanning-alert-location/created + description: A secret scanning alert was detected in a public repo. + operationId: secret-scanning-alert/publicly-leaked externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -70370,30 +69916,20 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" - examples: - default: - "$ref": "#/components/examples/secret-scanning-alert-location-created" - application/x-www-form-urlencoded: - schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" - examples: - default: - "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: secret_scanning_alert_location + subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app - secret-scanning-alert-publicly-leaked: + secret-scanning-alert-reopened: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -70401,8 +69937,8 @@ x-webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was detected in a public repo. - operationId: secret-scanning-alert/publicly-leaked + description: A previously closed secret scanning alert was reopened. + operationId: secret-scanning-alert/reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -70446,7 +69982,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70459,7 +69995,7 @@ x-webhooks: - repository - organization - app - secret-scanning-alert-reopened: + secret-scanning-alert-resolved: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -70467,8 +70003,8 @@ x-webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A previously closed secret scanning alert was reopened. - operationId: secret-scanning-alert/reopened + description: A secret scanning alert was closed. + operationId: secret-scanning-alert/resolved externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -70512,7 +70048,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70525,7 +70061,7 @@ x-webhooks: - repository - organization - app - secret-scanning-alert-resolved: + secret-scanning-alert-unassigned: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -70533,8 +70069,8 @@ x-webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was closed. - operationId: secret-scanning-alert/resolved + description: A secret scanning alert was unassigned. + operationId: secret-scanning-alert/unassigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -70578,7 +70114,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73879,6 +73415,13 @@ components: enum: - read - write + artifact_metadata: + type: string + description: The level of permission to grant the access token to create + and retrieve build artifact metadata records. + enum: + - read + - write attestations: type: string description: The level of permission to create and retrieve the access token @@ -88213,74 +87756,6 @@ components: - role - state - url - team-project: - title: Team Project - description: A team's access to a project. - type: object - properties: - owner_url: - type: string - url: - type: string - html_url: - type: string - columns_url: - type: string - id: - type: integer - node_id: - type: string - name: - type: string - body: - type: string - nullable: true - number: - type: integer - state: - type: string - creator: - "$ref": "#/components/schemas/simple-user" - created_at: - type: string - updated_at: - type: string - organization_permission: - description: The organization permission for this project. Only present - when owner is an organization. - type: string - private: - description: Whether the project is private or not. Only present when owner - is an organization. - type: boolean - permissions: - type: object - properties: - read: - type: boolean - write: - type: boolean - admin: - type: boolean - required: - - read - - write - - admin - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at - - permissions team-repository: title: Team Repository description: A team's access to a repository. @@ -88689,63 +88164,6 @@ components: - watchers_count - created_at - updated_at - project-column: - title: Project Column - description: Project columns contain cards of work. - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/projects/columns/367 - project_url: - type: string - format: uri - example: https://api.github.com/projects/120 - cards_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367/cards - id: - description: The unique identifier of the project column - example: 42 - type: integer - node_id: - type: string - example: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: - description: Name of the project column - example: Remaining tasks - type: string - created_at: - type: string - format: date-time - example: '2016-09-05T14:18:44Z' - updated_at: - type: string - format: date-time - example: '2016-09-05T14:22:28Z' - required: - - id - - node_id - - url - - project_url - - cards_url - - name - - created_at - - updated_at - project-collaborator-permission: - title: Project Collaborator Permission - description: Project Collaborator Permission - type: object - properties: - permission: - type: string - user: - "$ref": "#/components/schemas/nullable-simple-user" - required: - - permission - - user rate-limit: title: Rate Limit type: object @@ -90452,6 +89870,7 @@ components: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true verification: @@ -98269,6 +97688,11 @@ components: be updated or deleted. type: string nullable: true + secret-scanning-alert-assignee: + description: The username of the user to assign to the alert. Set to `null` + to unassign the alert. + type: string + nullable: true secret-scanning-location: type: object properties: @@ -112551,6 +111975,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -113164,6 +112593,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -198804,6 +198238,32 @@ components: - alert - repository - sender + webhook-secret-scanning-alert-assigned: + title: secret_scanning_alert assigned event + type: object + properties: + action: + type: string + enum: + - assigned + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + assignee: + "$ref": "#/components/schemas/simple-user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository webhook-secret-scanning-alert-created: title: secret_scanning_alert created event type: object @@ -198935,6 +198395,32 @@ components: - action - alert - repository + webhook-secret-scanning-alert-unassigned: + title: secret_scanning_alert unassigned event + type: object + properties: + action: + type: string + enum: + - unassigned + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + assignee: + "$ref": "#/components/schemas/simple-user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository webhook-secret-scanning-alert-validated: title: secret_scanning_alert validated event type: object @@ -211134,6 +210620,22 @@ components: alert_recipients: - mona - lisa + update-budget: + value: + message: Budget successfully updated. + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa delete-budget: value: message: Budget successfully deleted. @@ -215080,17 +214582,29 @@ components: project_url: https://api.github.com/projects/67890 options: - id: option_1 - name: Low + name: + html: Low + raw: Low color: GREEN - description: Low priority items + description: + html: Low priority items + raw: Low priority items - id: option_2 - name: Medium + name: + html: Medium + raw: Medium color: YELLOW - description: Medium priority items + description: + html: Medium priority items + raw: Medium priority items - id: option_3 - name: High + name: + html: High + raw: High color: RED - description: High priority items + description: + html: High priority items + raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' projects-v2-item-with-content: @@ -217472,84 +216986,6 @@ components: url: https://api.github.com/teams/1/memberships/octocat role: member state: pending - team-project-items: - value: - - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false - team-project: - value: - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false team-repository-alternative-response-with-repository-permissions: value: id: 1296269 @@ -217698,38 +217134,6 @@ components: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core - project-column: - value: - url: https://api.github.com/projects/columns/367 - project_url: https://api.github.com/projects/120 - cards_url: https://api.github.com/projects/columns/367/cards - id: 367 - node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: To Do - created_at: '2016-09-05T14:18:44Z' - updated_at: '2016-09-05T14:22:28Z' - project-collaborator-permission: - value: - permission: admin - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false rate-limit-overview: value: resources: @@ -228856,6 +228260,25 @@ components: validity: unknown publicly_leaked: false multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: 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-location-list: value: - type: commit @@ -232967,6 +232390,138 @@ components: html_url: https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0 metadata: package_type: rubygems + projects-v2-field-single-select-request: + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + projects-v2-field-iteration-request: + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + projects-v2-field-text: + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + projects-v2-field-number: + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + projects-v2-field-date: + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + projects-v2-field-single-select: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + projects-v2-field-iteration: + value: + id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' user-received-events-items: value: - id: '22249084964' @@ -235567,6 +235122,25 @@ components: required: false schema: type: string + secret-scanning-alert-assignee: + name: assignee + in: query + description: Filters alerts by assignee. Use `*` to get all assigned alerts, + `none` to get all unassigned alerts, or a GitHub username to get alerts assigned + to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: "*" + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts secret-scanning-alert-sort: name: sort description: The property to sort the results by. `created` means when the alert @@ -235668,13 +235242,6 @@ components: required: true schema: type: integer - project-id: - name: project_id - description: The unique identifier of the project. - in: path - required: true - schema: - type: integer security-product: name: security_product in: path @@ -235704,13 +235271,6 @@ components: enum: - enable_all - disable_all - column-id: - name: column_id - description: The unique identifier of the column. - in: path - required: true - schema: - type: integer artifact-name: name: name description: The name field of an artifact. When specified, only artifacts with diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 5a35ecf80..50d0a9d48 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -104,10 +104,6 @@ "name": "packages", "description": "Manage packages for authenticated users and organizations." }, - { - "name": "projects-classic", - "description": "Interact with GitHub Projects (classic)." - }, { "name": "pulls", "description": "Interact with GitHub Pull Requests." @@ -4718,6 +4714,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -5703,6 +5707,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -6542,6 +6554,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -7012,6 +7032,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -9037,6 +9065,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -10073,6 +10109,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -11026,6 +11070,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -11690,6 +11742,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -54329,226 +54389,20 @@ "update-budget": { "value": { "message": "Budget successfully updated.", - "id": "550e8400-e29b-41d4-a716-446655440000" - } - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Budget not found or feature not enabled", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - }, - "examples": { - "budget-not-found": { - "value": { - "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - }, - "feature-not-enabled": { - "value": { - "message": "Not Found", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } + "budget": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "org-name/example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] } } } @@ -54557,112 +54411,333 @@ } } }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - }, - "examples": { - "server-error": { - "value": { - "message": "Unable to update budget.", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "billing", - "subcategory": "budgets" - } - }, - "delete": { - "summary": "Delete a budget for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDeletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.", - "tags": [ - "billing" - ], - "operationId": "billing/delete-budget-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/billing/budgets#delete-a-budget-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "budget_id", - "description": "The ID corresponding to the budget.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response when deleting a budget", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "A message indicating the result of the deletion operation" - }, - "id": { - "type": "string", - "description": "The ID of the deleted budget" - } - }, - "required": [ - "message", - "id" - ] - }, - "examples": { - "default": { - "value": { - "message": "Budget successfully deleted.", - "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" - } - } - } - } - } - }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Budget not found or feature not enabled", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "budget-not-found": { + "value": { + "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + }, + "feature-not-enabled": { + "value": { + "message": "Not Found", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to update budget.", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "budgets" + } + }, + "delete": { + "summary": "Delete a budget for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDeletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/delete-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/budgets#delete-a-budget-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "budget_id", + "description": "The ID corresponding to the budget.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response when deleting a budget", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the result of the deletion operation" + }, + "id": { + "type": "string", + "description": "The ID of the deleted budget" + } + }, + "required": [ + "message", + "id" + ] + }, + "examples": { + "default": { + "value": { + "message": "Budget successfully deleted.", + "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" + } + } + } + } + } + }, "400": { "description": "Bad Request", "content": { @@ -102968,6 +103043,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -103968,6 +104051,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -139240,21 +139331,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -168149,6 +168258,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "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.", @@ -184462,17 +184594,17 @@ } } }, - "/orgs/{org}/teams/{team_slug}/projects": { + "/orgs/{org}/teams/{team_slug}/repos": { "get": { - "summary": "List team projects", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "List team repositories", + "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", "tags": [ "teams" ], - "operationId": "teams/list-projects-in-org", + "operationId": "teams/list-repos-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-projects" + "url": "https://docs.github.com/rest/teams/teams#list-team-repositories" }, "parameters": [ { @@ -184520,42 +184652,28 @@ "schema": { "type": "array", "items": { - "title": "Team Project", - "description": "A team's access to a project.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, "id": { - "type": "integer" + "type": "integer", + "format": "int64", + "example": 1296269 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { - "type": "string" - }, - "body": { "type": "string", - "nullable": true - }, - "number": { - "type": "integer" + "example": "Hello-World" }, - "state": { - "type": "string" + "full_name": { + "type": "string", + "example": "octocat/Hello-World" }, - "creator": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -184679,55 +184797,538 @@ "url" ] }, - "created_at": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, - "updated_at": { + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { "type": "string" }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { "type": "string" }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { "type": "boolean" }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, "permissions": { "type": "object", "properties": { - "read": { + "admin": { "type": "boolean" }, - "write": { + "maintain": { "type": "boolean" }, - "admin": { + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { "type": "boolean" } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + } }, "required": [ - "read", - "write", - "admin" + "url", + "html_url", + "key", + "name" ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ - "owner_url", - "url", + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", - "columns_url", "id", "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] } }, @@ -184735,17 +185336,11 @@ "default": { "value": [ { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -184765,1385 +185360,97 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": "string", - "nullable": true - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - } - } - } - } - }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - }, - "nullable": true - }, - "examples": { - "default": { - "summary": "Updates the permissions for the team to write for the project", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/teams/{team_slug}/repos": { - "get": { - "summary": "List team repositories", - "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", - "tags": [ - "teams" - ], - "operationId": "teams/list-repos-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-repositories" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + } } } ] @@ -187605,164 +186912,465 @@ "deprecated": true } }, - "/projects/columns/{column_id}": { + "/rate_limit": { "get": { - "summary": "Get a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "Get rate limit status for the authenticated user", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ - "projects-classic" + "rate-limit" ], - "operationId": "projects-classic/get-column", + "operationId": "rate-limit/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#get-a-project-column" + "url": "https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], + "parameters": [], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", + "title": "Rate Limit Overview", + "description": "Rate Limit Overview", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - }, - "cards_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" - }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" - }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" + "resources": { + "type": "object", + "properties": { + "core": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "graphql": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "source_import": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "integration_manifest": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_scanning_upload": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "actions_runner_registration": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "scim": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "dependency_snapshots": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "dependency_sbom": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_scanning_autofix": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + } + }, + "required": [ + "core", + "search" + ] }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:22:28Z" + "rate": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] } }, "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" + "rate", + "resources" ] }, "examples": { "default": { "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" + "resources": { + "core": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691591363 + }, + "search": { + "limit": 30, + "used": 12, + "remaining": 18, + "reset": 1691591091 + }, + "graphql": { + "limit": 5000, + "used": 7, + "remaining": 4993, + "reset": 1691593228 + }, + "integration_manifest": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691594631 + }, + "source_import": { + "limit": 100, + "used": 1, + "remaining": 99, + "reset": 1691591091 + }, + "code_scanning_upload": { + "limit": 500, + "used": 1, + "remaining": 499, + "reset": 1691594631 + }, + "actions_runner_registration": { + "limit": 10000, + "used": 0, + "remaining": 10000, + "reset": 1691594631 + }, + "scim": { + "limit": 15000, + "used": 0, + "remaining": 15000, + "reset": 1691594631 + }, + "dependency_snapshots": { + "limit": 100, + "used": 0, + "remaining": 100, + "reset": 1691591091 + }, + "code_search": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + } + }, + "rate": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1372700873 + } } } } } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { + }, + "headers": { + "X-RateLimit-Limit": { + "example": 5000, "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } + "type": "integer" } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { + }, + "X-RateLimit-Remaining": { + "example": 4999, "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } + "type": "integer" + } + }, + "X-RateLimit-Reset": { + "example": 1590701888, + "schema": { + "type": "integer", + "format": "timestamp" } } } }, - "401": { - "description": "Requires authentication", + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -187791,2870 +187399,741 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update an existing project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "category": "rate-limit", + "subcategory": "rate-limit" + } + } + }, + "/repos/{owner}/{repo}": { + "get": { + "summary": "Get a repository", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.", "tags": [ - "projects-classic" + "repos" ], - "operationId": "projects-classic/update-column", + "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column" + "url": "https://docs.github.com/rest/repos/repos#get-a-repository" }, "parameters": [ { - "name": "column_id", - "description": "The unique identifier of the column.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Rename the project column", - "value": { - "name": "To Do" - } - } - } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", + "title": "Full Repository", + "description": "Full Repository", "type": "object", "properties": { - "url": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "project_url": { + "name": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" + "example": "Hello-World" }, - "cards_url": { + "full_name": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" + "example": "octocat/Hello-World" }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "node_id": { + "private": { + "type": "boolean" + }, + "html_url": { "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true }, - "created_at": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "updated_at": { + "archive_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:22:28Z" - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "url": { - "type": "string" + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - "documentation_url": { - "type": "string" + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - "url": { - "type": "string" + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/delete-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#delete-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, - "documentation_url": { - "type": "string" + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, - "url": { - "type": "string" + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, - "documentation_url": { - "type": "string" + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "url": { - "type": "string" + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/{column_id}/moves": { - "post": { - "summary": "Move a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/move-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#move-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "example": "last", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$" - } - }, - "required": [ - "position" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Move the column to the end of the board", - "value": { - "position": "last" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, - "documentation_url": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - "url": { - "type": "string" + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - "documentation_url": { - "type": "string" + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, - "documentation_url": { - "type": "string" + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" }, - "url": { - "type": "string" + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators": { - "get": { - "summary": "List project collaborators", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/list-collaborators", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "affiliation", - "description": "Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "outside", - "direct", - "all" - ], - "default": "all" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, - "documentation_url": { - "type": "string" + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, - "url": { - "type": "string" + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, - "documentation_url": { - "type": "string" + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, - "documentation_url": { - "type": "string" + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, - "url": { - "type": "string" + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, - "documentation_url": { - "type": "string" + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" }, - "url": { - "type": "string" + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}": { - "put": { - "summary": "Add project collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/add-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "example": "write", - "type": "string" - } - }, - "nullable": true - }, - "examples": { - "default": { - "summary": "Applying write permissions for the new collaborator", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, - "documentation_url": { - "type": "string" + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, - "url": { - "type": "string" + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, - "documentation_url": { - "type": "string" + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, - "documentation_url": { - "type": "string" + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" }, - "url": { - "type": "string" + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, - "documentation_url": { - "type": "string" + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" }, - "url": { - "type": "string" + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove user as a collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/remove-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "language": { + "type": "string", + "nullable": true }, - "documentation_url": { - "type": "string" + "forks_count": { + "type": "integer", + "example": 9 }, - "url": { - "type": "string" + "stargazers_count": { + "type": "integer", + "example": 80 }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "watchers_count": { + "type": "integer", + "example": 80 }, - "documentation_url": { - "type": "string" + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 }, - "url": { - "type": "string" + "default_branch": { + "type": "string", + "example": "master" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "open_issues_count": { + "type": "integer", + "example": 0 }, - "documentation_url": { - "type": "string" + "is_template": { + "type": "boolean", + "example": true }, - "errors": { + "topics": { "type": "array", "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "type": "string" + }, + "example": [ + "octocat", + "atom", + "electron", + "API" + ] }, - "documentation_url": { - "type": "string" + "has_issues": { + "type": "boolean", + "example": true }, - "url": { - "type": "string" + "has_projects": { + "type": "boolean", + "example": true }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}/permission": { - "get": { - "summary": "Get project permission for a user", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-permission-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", - "type": "object", - "properties": { - "permission": { - "type": "string" + "has_wiki": { + "type": "boolean", + "example": true }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean", + "example": true + }, + "has_discussions": { + "type": "boolean", + "example": true + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "type": "string", + "example": "public" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z" + }, + "permissions": { "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" + "admin": { + "type": "boolean" }, - "email": { - "nullable": true, - "type": "string" + "maintain": { + "type": "boolean" }, - "login": { - "type": "string", - "example": "octocat" + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" }, + "pull": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "allow_rebase_merge": { + "type": "boolean", + "example": true + }, + "template_repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer", - "format": "int64", - "example": 1 + "format": "int64" }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "type": { + "name": { + "description": "The name of the repository.", "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "example": "Team Environment" }, - "starred_at": { + "full_name": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "example": "octocat/Hello-World" }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - }, - "required": [ - "permission", - "user" - ] - }, - "examples": { - "default": { - "value": { - "permission": "admin", - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/rate_limit": { - "get": { - "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", - "tags": [ - "rate-limit" - ], - "operationId": "rate-limit/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" - }, - "parameters": [], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Rate Limit Overview", - "description": "Rate Limit Overview", - "type": "object", - "properties": { - "resources": { - "type": "object", - "properties": { - "core": { - "title": "Rate Limit", + "license": { + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" + "key": { + "type": "string", + "example": "mit" }, - "reset": { - "type": "integer" + "name": { + "type": "string", + "example": "MIT License" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "graphql": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" }, - "remaining": { - "type": "integer" + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" }, - "reset": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" }, - "used": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "limit", - "remaining", - "reset", - "used" - ] + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true }, - "search": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] + "forks": { + "type": "integer" }, - "code_search": { - "title": "Rate Limit", + "permissions": { "type": "object", "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" + "admin": { + "type": "boolean" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "source_import": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "pull": { + "type": "boolean" }, - "remaining": { - "type": "integer" + "triage": { + "type": "boolean" }, - "reset": { - "type": "integer" + "push": { + "type": "boolean" }, - "used": { - "type": "integer" + "maintain": { + "type": "boolean" } }, "required": [ - "limit", - "remaining", - "reset", - "used" + "admin", + "pull", + "push" ] }, - "integration_manifest": { - "title": "Rate Limit", + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "limit": { - "type": "integer" + "name": { + "nullable": true, + "type": "string" }, - "remaining": { - "type": "integer" + "email": { + "nullable": true, + "type": "string" }, - "reset": { - "type": "integer" + "login": { + "type": "string", + "example": "octocat" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_upload": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "remaining": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "reset": { - "type": "integer" + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "actions_runner_registration": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "remaining": { - "type": "integer" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "reset": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "scim": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "remaining": { - "type": "integer" + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "reset": { - "type": "integer" + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_snapshots": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "remaining": { - "type": "integer" + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "reset": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_sbom": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" }, - "remaining": { - "type": "integer" + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "reset": { - "type": "integer" + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_autofix": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "type": { + "type": "string", + "example": "User" }, - "remaining": { - "type": "integer" + "site_admin": { + "type": "boolean" }, - "reset": { - "type": "integer" + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" }, - "used": { - "type": "integer" + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ - "limit", - "remaining", - "reset", - "used" - ] - } - }, - "required": [ - "core", - "search" - ] - }, - "rate": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - } - }, - "required": [ - "rate", - "resources" - ] - }, - "examples": { - "default": { - "value": { - "resources": { - "core": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691591363 - }, - "search": { - "limit": 30, - "used": 12, - "remaining": 18, - "reset": 1691591091 - }, - "graphql": { - "limit": 5000, - "used": 7, - "remaining": 4993, - "reset": 1691593228 - }, - "integration_manifest": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691594631 - }, - "source_import": { - "limit": 100, - "used": 1, - "remaining": 99, - "reset": 1691591091 - }, - "code_scanning_upload": { - "limit": 500, - "used": 1, - "remaining": 499, - "reset": 1691594631 - }, - "actions_runner_registration": { - "limit": 10000, - "used": 0, - "remaining": 10000, - "reset": 1691594631 - }, - "scim": { - "limit": 15000, - "used": 0, - "remaining": 15000, - "reset": 1691594631 - }, - "dependency_snapshots": { - "limit": 100, - "used": 0, - "remaining": 100, - "reset": 1691591091 - }, - "code_search": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - }, - "code_scanning_autofix": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - } - }, - "rate": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1372700873 - } - } - } - } - } - }, - "headers": { - "X-RateLimit-Limit": { - "example": 5000, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Remaining": { - "example": 4999, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Reset": { - "example": 1590701888, - "schema": { - "type": "integer", - "format": "timestamp" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "rate-limit", - "subcategory": "rate-limit" - } - } - }, - "/repos/{owner}/{repo}": { - "get": { - "summary": "Get a repository", - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.", - "tags": [ - "repos" - ], - "operationId": "repos/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#get-a-repository" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Full Repository", - "description": "Full Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "octocat", - "atom", - "electron", - "API" - ] - }, - "has_issues": { - "type": "boolean", - "example": true - }, - "has_projects": { - "type": "boolean", - "example": true - }, - "has_wiki": { - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean", - "example": true - }, - "has_discussions": { - "type": "boolean", - "example": true - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string", - "example": "public" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { - "type": "boolean", - "example": true - }, - "template_repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, "private": { @@ -224334,6 +221813,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -224354,6 +221834,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -242552,6 +240033,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -242572,6 +240054,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -278220,6 +275703,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -278240,6 +275724,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -283974,6 +281459,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -283994,6 +281480,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289303,6 +286790,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289323,6 +286811,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289849,6 +287338,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289869,6 +287359,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -290419,6 +287910,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -290439,6 +287931,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -324211,6 +321704,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -406452,6 +403953,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -406472,6 +403974,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -437285,6 +434788,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -437305,6 +434809,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -468363,6 +465868,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "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.", @@ -470603,7 +468131,7 @@ }, "patch": { "summary": "Update a secret scanning alert", - "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "operationId": "secret-scanning/update-alert", "tags": [ "secret-scanning" @@ -470673,6 +468201,11 @@ "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", "type": "string", "nullable": true + }, + "assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true } }, "anyOf": [ @@ -470680,6 +468213,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -470689,6 +468227,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -471665,7 +469215,27 @@ "resolution_comment": "Example comment", "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://alambic.github.com/avatars/u/1?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } } } @@ -471679,7 +469249,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment" + "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" }, "503": { "description": "Service unavailable", @@ -498900,6 +496470,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -499112,6 +496683,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -512070,17 +509642,17 @@ "deprecated": true } }, - "/teams/{team_id}/projects": { + "/teams/{team_id}/repos": { "get": { - "summary": "List team projects (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "List team repositories (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint.", "tags": [ "teams" ], - "operationId": "teams/list-projects-legacy", + "operationId": "teams/list-repos-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-projects-legacy" + "url": "https://docs.github.com/rest/teams/teams#list-team-repositories-legacy" }, "parameters": [ { @@ -512119,42 +509691,28 @@ "schema": { "type": "array", "items": { - "title": "Team Project", - "description": "A team's access to a project.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, "id": { - "type": "integer" + "type": "integer", + "format": "int64", + "example": 1296269 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { - "type": "string" - }, - "body": { "type": "string", - "nullable": true - }, - "number": { - "type": "integer" + "example": "Hello-World" }, - "state": { - "type": "string" + "full_name": { + "type": "string", + "example": "octocat/Hello-World" }, - "creator": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -512278,55 +509836,538 @@ "url" ] }, - "created_at": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, - "updated_at": { + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { "type": "string" }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { "type": "string" }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { "type": "boolean" }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, "permissions": { "type": "object", "properties": { - "read": { + "admin": { "type": "boolean" }, - "write": { + "maintain": { "type": "boolean" }, - "admin": { + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { "type": "boolean" } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + } }, "required": [ - "read", - "write", - "admin" + "url", + "html_url", + "key", + "name" ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ - "owner_url", - "url", + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", - "columns_url", "id", "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] } }, @@ -512334,17 +510375,11 @@ "default": { "value": [ { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -512364,1564 +510399,97 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, - "/teams/{team_id}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-project-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": "string", - "nullable": true - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - } - } - } - } - }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - } - }, - "examples": { - "default": { - "summary": "Example of setting permission to read", - "value": { - "permission": "read" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, - "/teams/{team_id}/repos": { - "get": { - "summary": "List team repositories (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/list-repos-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-repositories-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + } } } ] @@ -540360,6 +536928,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -589101,6 +585677,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -595498,6 +592082,675 @@ "category": "projects", "subcategory": "fields" } + }, + "post": { + "summary": "Add field to user owned project", + "description": "Add a field to a specified user owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/add-field-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_number", + "description": "The project's number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date", + "single_select", + "iteration" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "description": "The color associated with the option.", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + "description": { + "type": "string", + "description": "The description of the option." + } + } + } + }, + "iteration_configuration": { + "type": "object", + "description": "The configuration for iteration fields.", + "properties": { + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the first iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "description": "Zero or more iterations for the field.", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title for the iteration." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + } + } + } + } + } + } + }, + "required": [ + "name", + "data_type" + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "summary": "Create a single select field", + "value": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + } + }, + "iteration_field": { + "summary": "Create an iteration field", + "value": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "example": "https://api.github.com/projects/1" + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was last updated." + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + }, + "examples": { + "text_field": { + "value": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + } + }, + "number_field": { + "value": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + } + }, + "date_field": { + "value": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + } + }, + "single_select_field": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + }, + "iteration_field": { + "value": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" + } } }, "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { @@ -595743,21 +592996,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -647113,6 +644384,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -649494,6 +646772,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -757124,6 +754409,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -759716,6 +757009,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -762215,6 +759516,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -764714,6 +762023,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -767345,6 +764662,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -769983,6 +767308,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -774244,6 +771577,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1168125,949 +1165466,4357 @@ ] } }, - "updated": { + "updated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "rule": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "automatic_copilot_code_review_enabled": { + "type": "boolean", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + } + ] + }, + "changes": { + "type": "object", + "properties": { + "configuration": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "rule_type": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "pattern": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-transferred": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", + "operationId": "repository/transferred", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "repository transferred event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "transferred" + ] + }, + "changes": { + "type": "object", + "properties": { + "owner": { + "type": "object", + "properties": { + "from": { + "type": "object", + "properties": { + "organization": { + "title": "Organization", + "type": "object", + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issues_url": { + "type": "string", + "format": "uri" + }, + "login": { + "type": "string" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "node_id": { + "type": "string" + }, + "public_members_url": { + "type": "string", + "format": "uri-template" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id", + "node_id", + "url", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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": [ + "from" + ] + } + }, + "required": [ + "owner" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "changes", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-unarchived": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "repository unarchived event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unarchived" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { "type": "array", "items": { - "type": "object", - "properties": { - "rule": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "merge_queue" - ] - }, - "parameters": { - "type": "object", - "properties": { - "check_response_timeout_minutes": { - "type": "integer", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", - "minimum": 1, - "maximum": 360 - }, - "grouping_strategy": { - "type": "string", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - "max_entries_to_build": { - "type": "integer", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", - "minimum": 0, - "maximum": 100 - }, - "max_entries_to_merge": { - "type": "integer", - "description": "The maximum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "merge_method": { - "type": "string", - "description": "Method to use when merging changes from queued pull requests.", - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - "min_entries_to_merge": { - "type": "integer", - "description": "The minimum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "min_entries_to_merge_wait_minutes": { - "type": "integer", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", - "minimum": 0, - "maximum": 360 - } - }, - "required": [ - "check_response_timeout_minutes", - "grouping_strategy", - "max_entries_to_build", - "max_entries_to_merge", - "merge_method", - "min_entries_to_merge", - "min_entries_to_merge_wait_minutes" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "automatic_copilot_code_review_enabled": { - "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - }, - "required_reviewers": { - "type": "array", - "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", - "items": { - "title": "RequiredReviewerConfiguration", - "description": "A reviewing team, and file patterns describing which files they must approve changes to.", - "type": "object", - "properties": { - "file_patterns": { - "type": "array", - "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", - "items": { - "type": "string" - } - }, - "minimum_approvals": { - "type": "integer", - "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." - }, - "reviewer": { - "title": "Reviewer", - "description": "A required reviewing team", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "ID of the reviewer which must review changes to matching files." - }, - "type": { - "type": "string", - "description": "The type of the reviewer", - "enum": [ - "Team" - ] - } - }, - "required": [ - "id", - "type" - ] - } - }, - "required": [ - "file_patterns", - "minimum_approvals", - "reviewer" - ] - } - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } - } - ] - }, - "changes": { - "type": "object", - "properties": { - "configuration": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "rule_type": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "pattern": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - } - } - } + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" } } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" } } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } - } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] }, "sender": { "title": "Simple User", @@ -1169196,7 +1169945,7 @@ }, "required": [ "action", - "repository_ruleset", + "repository", "sender" ] } @@ -1169211,8 +1169960,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -1169220,13 +1169970,13 @@ } } }, - "repository-transferred": { + "repository-vulnerability-alert-create": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", - "operationId": "repository/transferred", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1169291,200 +1170041,180 @@ "content": { "application/json": { "schema": { - "title": "repository transferred event", + "title": "repository_vulnerability_alert create event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "transferred" + "create" ] }, - "changes": { + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], "properties": { - "owner": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "issues_url": { - "type": "string", - "format": "uri" - }, - "login": { - "type": "string" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "node_id": { - "type": "string" - }, - "public_members_url": { - "type": "string", - "format": "uri-template" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id", - "node_id", - "url", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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" - ] - } - } + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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" } - }, - "required": [ - "from" + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open" ] } - }, - "required": [ - "owner" - ] + } }, "enterprise": { "title": "Enterprise", @@ -1170992,7 +1171722,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1171008,23 +1171738,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-unarchived": { + "repository-vulnerability-alert-dismiss": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1171089,15 +1171817,191 @@ "content": { "application/json": { "schema": { - "title": "repository unarchived event", + "title": "repository_vulnerability_alert dismiss event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unarchived" + "dismiss" ] }, + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", + "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "dismiss_reason", + "dismissed_at", + "dismisser", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], + "properties": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_comment": { + "type": "string", + "nullable": true + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "dismissed" + ] + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -1172604,6 +1173508,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1172619,21 +1173524,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-vulnerability-alert-create": { + "repository-vulnerability-alert-reopen": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was created.", - "operationId": "repository-vulnerability-alert/create", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1172700,13 +1173603,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert create event", + "title": "repository_vulnerability_alert reopen event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "create" + "reopen" ] }, "alert": { @@ -1174405,11 +1175308,11 @@ } } }, - "repository-vulnerability-alert-dismiss": { + "repository-vulnerability-alert-resolve": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was dismissed.", - "operationId": "repository-vulnerability-alert/dismiss", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1174476,13 +1175379,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert dismiss event", + "title": "repository_vulnerability_alert resolve event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "dismiss" + "resolve" ] }, "alert": { @@ -1174493,9 +1175396,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1174515,10 +1175415,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": "string", - "nullable": true - }, "dismiss_reason": { "type": "string" }, @@ -1174614,9 +1175510,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1174656,7 +1175549,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1176163,279 +1177057,855 @@ "type", "url" ] - } - }, - "required": [ - "action", - "alert", - "repository", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "repository_vulnerability_alert", - "supported-webhook-types": [ - "repository", - "organization" - ] - } - } - }, - "repository-vulnerability-alert-reopen": { - "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "repository_vulnerability_alert reopen event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "reopen" - ] - }, - "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", - "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], - "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "dismiss_reason": { - "type": "string" - }, - "dismissed_at": { - "type": "string" - }, - "dismisser": { - "title": "User", - "type": "object", - "nullable": true, - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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" - } - } - }, - "external_identifier": { - "type": "string" - }, - "external_reference": { - "type": "string", - "nullable": true, - "format": "uri" - }, - "fix_reason": { - "type": "string" - }, - "fixed_at": { - "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "severity": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "open" - ] - } - } + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_vulnerability_alert", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "secret-scanning-alert-assigned": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "secret_scanning_alert assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { + "type": "string", + "description": "The reason for resolving the alert.", + "nullable": true, + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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).\"" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true + }, + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, "enterprise": { "title": "Enterprise", @@ -1177944,8 +1179414,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1177959,21 +1179428,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-resolve": { + "secret-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was marked as resolved.", - "operationId": "repository-vulnerability-alert/resolve", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was created.", + "operationId": "secret-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1178038,179 +1179508,630 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert resolve event", + "title": "secret_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolve" + "created" ] }, "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, "created_at": { - "type": "string" + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "dismiss_reason": { - "type": "string" + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", - "type": "object", + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { + "type": "string", + "description": "The reason for resolving the alert.", "nullable": true, - "required": [ - "login", - "id" - ], + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "format": "uri" + "example": "octocat" }, - "deleted": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "email": { + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "events_url": { + "url": { "type": "string", - "format": "uri-template" + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "gravatar_id": { - "type": "string" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "html_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "id": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "login": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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).\"" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { "name": { + "nullable": true, "type": "string" }, - "node_id": { + "email": { + "nullable": true, "type": "string" }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "repos_url": { + "type": { "type": "string", - "format": "uri" + "example": "User" }, "site_admin": { "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, "starred_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "example": "User" }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } - } - }, - "external_identifier": { - "type": "string" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "external_reference": { + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "nullable": true, - "format": "uri" - }, - "fix_reason": { - "type": "string" + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true }, - "fixed_at": { + "push_protection_bypass_request_comment": { "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true }, - "node_id": { - "type": "string" + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true }, - "number": { - "type": "integer" + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true }, - "severity": { - "type": "string" + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" - ] + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true } } }, @@ -1179721,8 +1181642,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1179736,21 +1181656,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "secret-scanning-alert-created": { + "secret-scanning-alert-location-created": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was created.", - "operationId": "secret-scanning-alert/created", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", + "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -1179815,7 +1181736,7 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { @@ -1180442,74 +1182363,6 @@ } } }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1180531,6 +1182384,314 @@ "node_id" ] }, + "location": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "commit", + "wiki_commit", + "issue_title", + "issue_body", + "issue_comment", + "discussion_title", + "discussion_body", + "discussion_comment", + "pull_request_title", + "pull_request_body", + "pull_request_comment", + "pull_request_review", + "pull_request_review_comment" + ], + "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", + "example": "commit" + }, + "details": { + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/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", + "example": "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", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/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", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ] + } + } + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", @@ -1181947,10 +1184108,185 @@ } }, "required": [ - "action", + "location", "alert", - "repository" + "repository", + "sender" + ] + }, + "examples": { + "default": { + "value": { + "action": "created", + "alert": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "updated_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", + "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", + "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "publicly_leaked": false, + "multi_repo": false + }, + "location": { + "type": "commit", + "details": { + "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-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + } + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "hello-world", + "full_name": "octocat-repo/hello-world", + "private": false, + "owner": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/octocat-repo/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octocat-repo/hello-world", + "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", + "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", + "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", + "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", + "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", + "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", + "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", + "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", + "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", + "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", + "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", + "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", + "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", + "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", + "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", + "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", + "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", + "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", + "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:21:03Z", + "pushed_at": "2019-05-15T15:20:57Z", + "git_url": "git://github.com/octocat-repo/hello-world.git", + "ssh_url": "git@github.com:octocat-repo/hello-world.git", + "clone_url": "https://github.com/octocat-repo/hello-world.git", + "svn_url": "https://github.com/octocat-repo/hello-world", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false + }, + "sender": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Secret Scanning Alert Location Created Event", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" ] + }, + "examples": { + "default": { + "value": { + "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" + } + } } } } @@ -1181962,8 +1184298,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1181972,13 +1184309,13 @@ } } }, - "secret-scanning-alert-location-created": { + "secret-scanning-alert-publicly-leaked": { "post": { - "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", - "operationId": "secret-scanning-alert-location/created", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1182043,13 +1184380,13 @@ "content": { "application/json": { "schema": { - "title": "Secret Scanning Alert Location Created Event", + "title": "secret_scanning_alert publicly leaked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "publicly_leaked" ] }, "alert": { @@ -1182670,6 +1185007,74 @@ } } }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1182691,314 +1185096,6 @@ "node_id" ] }, - "location": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "commit", - "wiki_commit", - "issue_title", - "issue_body", - "issue_comment", - "discussion_title", - "discussion_body", - "discussion_comment", - "pull_request_title", - "pull_request_body", - "pull_request_comment", - "pull_request_review", - "pull_request_review_comment" - ], - "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", - "example": "commit" - }, - "details": { - "oneOf": [ - { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "example": "/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", - "example": "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", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "example": "/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", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_title_url" - ] - }, - { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_body_url" - ] - }, - { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "issue_comment_url" - ] - }, - { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082" - } - }, - "required": [ - "discussion_title_url" - ] - }, - { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussion-4566270" - } - }, - "required": [ - "discussion_body_url" - ] - }, - { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - } - }, - "required": [ - "discussion_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_title_url" - ] - }, - { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_body_url" - ] - }, - { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - } - }, - "required": [ - "pull_request_review_url" - ] - }, - { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } - ] - } - } - }, "organization": { "title": "Organization Simple", "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", @@ -1184415,185 +1186512,10 @@ } }, "required": [ - "location", + "action", "alert", - "repository", - "sender" - ] - }, - "examples": { - "default": { - "value": { - "action": "created", - "alert": { - "number": 42, - "created_at": "2020-11-06T18:18:30Z", - "updated_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", - "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", - "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", - "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, - "secret_type": "mailchimp_api_key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "publicly_leaked": false, - "multi_repo": false - }, - "location": { - "type": "commit", - "details": { - "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-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - } - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "hello-world", - "full_name": "octocat-repo/hello-world", - "private": false, - "owner": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/octocat-repo/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octocat-repo/hello-world", - "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", - "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", - "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", - "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", - "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", - "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", - "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", - "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", - "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", - "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", - "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", - "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", - "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", - "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", - "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", - "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", - "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", - "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", - "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:03Z", - "pushed_at": "2019-05-15T15:20:57Z", - "git_url": "git://github.com/octocat-repo/hello-world.git", - "ssh_url": "git@github.com:octocat-repo/hello-world.git", - "clone_url": "https://github.com/octocat-repo/hello-world.git", - "svn_url": "https://github.com/octocat-repo/hello-world", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false - }, - "sender": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "title": "Secret Scanning Alert Location Created Event", - "type": "object", - "properties": { - "payload": { - "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", - "type": "string" - } - }, - "required": [ - "payload" + "repository" ] - }, - "examples": { - "default": { - "value": { - "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" - } - } } } } @@ -1184605,9 +1186527,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1184616,11 +1186537,11 @@ } } }, - "secret-scanning-alert-publicly-leaked": { + "secret-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was detected in a public repo.", - "operationId": "secret-scanning-alert/publicly-leaked", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1184687,13 +1186608,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert publicly leaked event", + "title": "secret_scanning_alert reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "publicly_leaked" + "reopened" ] }, "alert": { @@ -1186844,11 +1188765,11 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-resolved": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1186915,13 +1188836,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert reopened event", + "title": "secret_scanning_alert resolved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "resolved" ] }, "alert": { @@ -1189072,11 +1190993,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-unassigned": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1189143,13 +1191064,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert resolved event", + "title": "secret_scanning_alert unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolved" + "unassigned" ] }, "alert": { @@ -1189770,6 +1191691,130 @@ } } }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index e26d2a991..ed67ecb3f 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -57,8 +57,6 @@ tags: description: Interact with organizations. - name: packages description: Manage packages for authenticated users and organizations. -- name: projects-classic - description: Interact with GitHub Projects (classic). - name: pulls description: Interact with GitHub Pull Requests. - name: rate-limit @@ -1023,7 +1021,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &637 + - &633 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -2208,6 +2206,13 @@ paths: enum: - read - write + artifact_metadata: + type: string + description: The level of permission to grant the access + token to create and retrieve build artifact metadata records. + enum: + - read + - write attestations: type: string description: The level of permission to create and retrieve @@ -8629,7 +8634,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &475 + - &470 name: has in: query description: |- @@ -8745,7 +8750,7 @@ paths: - unknown - direct - transitive - security_advisory: &476 + security_advisory: &471 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9007,7 +9012,7 @@ paths: format: date-time readOnly: true nullable: true - auto_dismissed_at: &477 + auto_dismissed_at: &472 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -10303,7 +10308,7 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &526 + properties: &521 id: type: integer format: int64 @@ -10675,7 +10680,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &649 + sub_issues_summary: &645 title: Sub-issues Summary type: object properties: @@ -10695,7 +10700,7 @@ paths: type: string format: uri nullable: true - issue_dependencies_summary: &650 + issue_dependencies_summary: &646 title: Issue Dependencies Summary type: object properties: @@ -10714,7 +10719,7 @@ paths: - total_blocking issue_field_values: type: array - items: &651 + items: &647 title: Issue Field Value description: A value assigned to an issue field type: object @@ -10774,7 +10779,7 @@ paths: - node_id - data_type - value - required: &527 + required: &522 - assignee - closed_at - comments @@ -10795,7 +10800,7 @@ paths: - user - created_at - updated_at - comment: &524 + comment: &519 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -11365,7 +11370,7 @@ paths: url: type: string format: uri - user: &663 + user: &657 title: Public User description: Public User type: object @@ -14670,14 +14675,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &327 + - &325 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &328 + - &326 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -14739,7 +14744,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &334 + '301': &329 description: Moved permanently content: application/json: @@ -14761,7 +14766,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &556 + - &551 name: all description: If `true`, show notifications marked as read. in: query @@ -14769,7 +14774,7 @@ paths: schema: type: boolean default: false - - &557 + - &552 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -14779,7 +14784,7 @@ paths: type: boolean default: false - *72 - - &558 + - &553 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -15253,7 +15258,7 @@ paths: - url - subscription_url examples: - default: &559 + default: &554 value: - id: '1' repository: @@ -16121,7 +16126,7 @@ paths: - property_name - value examples: - default: &565 + default: &560 value: - property_name: environment value: production @@ -16171,7 +16176,7 @@ paths: required: - properties examples: - default: &566 + default: &561 value: properties: - property_name: environment @@ -16585,7 +16590,19 @@ paths: update-budget: value: message: Budget successfully updated. - id: 550e8400-e29b-41d4-a716-446655440000 + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa '400': *14 '401': *25 '403': *29 @@ -16716,7 +16733,7 @@ paths: required: false schema: type: string - - &702 + - &696 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -16862,7 +16879,7 @@ paths: parameters: - *63 - *106 - - &703 + - &697 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -16974,7 +16991,7 @@ paths: - *106 - *108 - *107 - - &704 + - &698 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -16982,7 +16999,7 @@ paths: schema: type: string - *109 - - &705 + - &699 name: sku description: The SKU to query for usage. in: query @@ -17884,7 +17901,7 @@ paths: type: integer repository_cache_usages: type: array - items: &339 + items: &334 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -19076,7 +19093,7 @@ paths: - all - local_only - selected - selected_actions_url: &345 + selected_actions_url: &340 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` @@ -19159,7 +19176,7 @@ paths: description: Response content: application/json: - schema: &349 + schema: &344 type: object properties: days: @@ -19201,7 +19218,7 @@ paths: required: true content: application/json: - schema: &350 + schema: &345 type: object properties: days: @@ -19258,7 +19275,7 @@ paths: required: - approval_policy examples: - default: &351 + default: &346 value: approval_policy: first_time_contributors '404': *6 @@ -19317,7 +19334,7 @@ paths: description: Response content: application/json: - schema: &352 + schema: &347 type: object required: - run_workflows_from_fork_pull_requests @@ -19371,7 +19388,7 @@ paths: required: true content: application/json: - schema: &353 + schema: &348 type: object required: - run_workflows_from_fork_pull_requests @@ -20006,7 +20023,7 @@ paths: description: Response content: application/json: - schema: &354 + schema: &349 type: object properties: default_workflow_permissions: &136 @@ -20057,7 +20074,7 @@ paths: required: false content: application/json: - schema: &355 + schema: &350 type: object properties: default_workflow_permissions: *136 @@ -20546,7 +20563,7 @@ paths: type: array items: *143 examples: - default: &666 + default: &660 value: total_count: 1 repositories: @@ -21188,7 +21205,7 @@ paths: application/json: schema: type: array - items: &356 + items: &351 title: Runner Application description: Runner Application type: object @@ -21213,7 +21230,7 @@ paths: - download_url - filename examples: - default: &357 + default: &352 value: - os: osx architecture: x64 @@ -21299,7 +21316,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &358 + '201': &353 description: Response content: application/json: @@ -21410,7 +21427,7 @@ paths: - token - expires_at examples: - default: &359 + default: &354 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -21449,7 +21466,7 @@ paths: application/json: schema: *147 examples: - default: &360 + default: &355 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -21483,7 +21500,7 @@ paths: application/json: schema: *145 examples: - default: &361 + default: &356 value: id: 23 name: MBP @@ -21709,7 +21726,7 @@ paths: - *63 - *144 responses: - '200': &362 + '200': &357 description: Response content: application/json: @@ -21766,7 +21783,7 @@ paths: parameters: - *63 - *144 - - &363 + - &358 name: name description: The name of a self-hosted runner's custom label. in: path @@ -21896,7 +21913,7 @@ paths: description: Response content: application/json: - schema: &375 + schema: &370 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -21925,7 +21942,7 @@ paths: - key_id - key examples: - default: &376 + default: &371 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -22338,7 +22355,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *63 - - &344 + - &339 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -23442,12 +23459,12 @@ paths: required: - subject_digests examples: - default: &694 + default: &688 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &695 + withPredicateType: &689 value: subject_digests: - sha256:abc123 @@ -23505,7 +23522,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &696 + default: &690 value: attestations_subject_digests: - sha256:abc: @@ -23854,7 +23871,7 @@ paths: initiator: type: string examples: - default: &389 + default: &384 value: attestations: - bundle: @@ -24783,7 +24800,7 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *63 - - &415 + - &410 name: tool_name description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, @@ -24793,7 +24810,7 @@ paths: schema: &168 type: string description: The name of the tool used to generate the code scanning analysis. - - &416 + - &411 name: tool_guid description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in @@ -24816,7 +24833,7 @@ paths: be returned. in: query required: false - schema: &418 + schema: &413 type: string description: State of a code scanning alert. enum: @@ -24839,7 +24856,7 @@ paths: be returned. in: query required: false - schema: &419 + schema: &414 type: string description: Severity of a code scanning alert. enum: @@ -24865,7 +24882,7 @@ paths: updated_at: *163 url: *164 html_url: *165 - instances_url: &420 + instances_url: &415 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -24888,7 +24905,7 @@ paths: required: *21 nullable: true dismissed_at: *167 - dismissed_reason: &421 + dismissed_reason: &416 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -24897,13 +24914,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &422 + dismissed_comment: &417 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &423 + rule: &418 type: object properties: id: @@ -24956,7 +24973,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &424 + tool: &419 type: object properties: name: *168 @@ -24966,15 +24983,15 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *169 - most_recent_instance: &425 + most_recent_instance: &420 type: object properties: - ref: &417 + ref: &412 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &435 + analysis_key: &430 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -24985,7 +25002,7 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &436 + category: &431 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -26309,7 +26326,7 @@ paths: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &448 + properties: &443 name: type: string description: The name of the machine. @@ -26351,7 +26368,7 @@ paths: - ready - in_progress nullable: true - required: &449 + required: &444 - name - display_name - operating_system @@ -27219,7 +27236,7 @@ paths: - updated_at - visibility examples: - default: &450 + default: &445 value: total_count: 2 secrets: @@ -27257,7 +27274,7 @@ paths: description: Response content: application/json: - schema: &451 + schema: &446 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -27286,7 +27303,7 @@ paths: - key_id - key examples: - default: &452 + default: &447 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -27318,7 +27335,7 @@ paths: application/json: schema: *178 examples: - default: &454 + default: &449 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -28931,7 +28948,7 @@ paths: description: Response content: application/json: - schema: &480 + schema: &475 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -28948,7 +28965,7 @@ paths: - key_id - key examples: - default: &481 + default: &476 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -30748,7 +30765,7 @@ paths: application/json: schema: *22 examples: - default: &519 + default: &514 value: id: 1 account: @@ -30973,7 +30990,7 @@ paths: required: true content: application/json: - schema: &520 + schema: &515 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -31826,7 +31843,7 @@ paths: application/json: schema: *224 examples: - default: &447 + default: &442 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -33071,7 +33088,7 @@ paths: parameters: - *63 - *231 - - &679 + - &673 name: repo_name description: repo_name parameter in: path @@ -34110,7 +34127,7 @@ paths: - nuget - container - *63 - - &680 + - &674 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -34151,7 +34168,7 @@ paths: default: *238 '403': *29 '401': *25 - '400': &682 + '400': &676 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -35943,7 +35960,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &756 + properties: &750 id: type: number description: The unique identifier of the status update. @@ -35991,7 +36008,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &757 + required: &751 - id - node_id - created_at @@ -36205,7 +36222,7 @@ paths: content: oneOf: - *82 - - &462 + - &457 title: Pull Request Simple description: Pull Request Simple type: object @@ -36434,7 +36451,7 @@ paths: - review_comment - self author_association: *69 - auto_merge: &568 + auto_merge: &563 title: Auto merge description: The status of auto merging a pull request. type: object @@ -36809,7 +36826,7 @@ paths: - updated_at - project_url examples: - default: &699 + default: &693 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -36941,7 +36958,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *255 - - &700 + - &694 name: field_id description: The unique identifier of the field. in: path @@ -36956,7 +36973,7 @@ paths: application/json: schema: *259 examples: - default: &701 + default: &695 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -36965,17 +36982,29 @@ paths: project_url: https://api.github.com/projects/67890 options: - id: option_1 - name: Low + name: + html: Low + raw: Low color: GREEN - description: Low priority items + description: + html: Low priority items + raw: Low priority items - id: option_2 - name: Medium + name: + html: Medium + raw: Medium color: YELLOW - description: Medium priority items + description: + html: Medium priority items + raw: Medium priority items - id: option_3 - name: High + name: + html: High + raw: High color: RED - description: High priority items + description: + html: High priority items + raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' headers: @@ -38875,7 +38904,7 @@ paths: description: Response content: application/json: - schema: &333 + schema: &328 title: Full Repository description: Full Repository type: object @@ -39268,7 +39297,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &467 + properties: &462 url: type: string format: uri @@ -39284,7 +39313,7 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &468 + required: &463 - url - key - name @@ -39373,7 +39402,7 @@ paths: - network_count - subscribers_count examples: - default: &335 + default: &330 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -39894,7 +39923,7 @@ paths: - *63 - *17 - *19 - - &591 + - &586 name: targets description: | A comma-separated list of rule targets to filter by. @@ -40175,7 +40204,7 @@ paths: - repository_property rules: type: array - items: &592 + items: &587 title: Repository Rule type: object description: A repository rule. @@ -40237,7 +40266,7 @@ paths: type: string enum: - required_linear_history - - &589 + - &584 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -40910,7 +40939,7 @@ paths: - tool required: - code_scanning_tools - - &590 + - &585 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -41136,7 +41165,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *63 - - &593 + - &588 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -41151,7 +41180,7 @@ paths: in: query schema: type: string - - &594 + - &589 name: time_period description: |- The time period to filter by. @@ -41167,14 +41196,14 @@ paths: - week - month default: day - - &595 + - &590 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &596 + - &591 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -41194,7 +41223,7 @@ paths: description: Response content: application/json: - schema: &597 + schema: &592 title: Rule Suites description: Response type: array @@ -41249,7 +41278,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &598 + default: &593 value: - id: 21 actor_id: 12 @@ -41293,7 +41322,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *63 - - &599 + - &594 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -41309,7 +41338,7 @@ paths: description: Response content: application/json: - schema: &600 + schema: &595 title: Rule Suite description: Response type: object @@ -41408,7 +41437,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &601 + default: &596 value: id: 21 actor_id: 12 @@ -41654,7 +41683,7 @@ paths: type: string format: date-time examples: - default: &603 + default: &598 value: - version_id: 3 actor: @@ -41707,7 +41736,7 @@ paths: description: Response content: application/json: - schema: &604 + schema: &599 allOf: - *301 - type: object @@ -41779,7 +41808,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *63 - - &605 + - &600 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -41790,7 +41819,7 @@ paths: enum: - open - resolved - - &606 + - &601 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -41800,7 +41829,7 @@ paths: required: false schema: type: string - - &607 + - &602 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -41809,7 +41838,26 @@ paths: required: false schema: type: string - - &608 + - &603 + name: assignee + in: query + description: Filters alerts by assignee. Use `*` to get all assigned alerts, + `none` to get all unassigned alerts, or a GitHub username to get alerts + assigned to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: "*" + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts + - &604 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. @@ -41824,7 +41872,7 @@ paths: - *48 - *19 - *17 - - &609 + - &605 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 @@ -41834,7 +41882,7 @@ paths: required: false schema: type: string - - &610 + - &606 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -41844,7 +41892,7 @@ paths: required: false schema: type: string - - &611 + - &607 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -41853,7 +41901,7 @@ paths: required: false schema: type: string - - &612 + - &608 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -41862,7 +41910,7 @@ paths: schema: type: boolean default: false - - &613 + - &609 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -41871,7 +41919,7 @@ paths: schema: type: boolean default: false - - &614 + - &610 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -41906,14 +41954,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &615 + state: &611 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &616 + resolution: &612 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -42020,8 +42068,8 @@ paths: pull request. ' - oneOf: &617 - - &619 + oneOf: &613 + - &615 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -42073,7 +42121,7 @@ paths: - blob_url - commit_sha - commit_url - - &620 + - &616 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. @@ -42128,7 +42176,7 @@ paths: - page_url - commit_sha - commit_url - - &621 + - &617 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -42142,7 +42190,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &622 + - &618 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -42156,7 +42204,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &623 + - &619 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -42170,7 +42218,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &624 + - &620 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -42184,7 +42232,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &625 + - &621 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -42198,7 +42246,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &626 + - &622 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -42212,7 +42260,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &627 + - &623 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. @@ -42226,7 +42274,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &628 + - &624 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. @@ -42240,7 +42288,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &629 + - &625 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. @@ -42254,7 +42302,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &630 + - &626 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. @@ -42268,7 +42316,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &631 + - &627 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. @@ -42766,7 +42814,7 @@ paths: application/json: schema: type: array - items: &635 + items: &631 description: A repository security advisory. type: object properties: @@ -43057,7 +43105,7 @@ paths: - private_fork additionalProperties: false examples: - default: &636 + default: &632 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -44968,7 +45016,7 @@ paths: - updated_at - url examples: - default: &653 + default: &649 value: - author: login: octocat @@ -45216,7 +45264,7 @@ paths: application/json: schema: *314 examples: - default: &654 + default: &650 value: author: login: octocat @@ -45399,7 +45447,7 @@ paths: - updated_at - url examples: - default: &655 + default: &651 value: - author: login: octocat @@ -45625,7 +45673,7 @@ paths: application/json: schema: *317 examples: - default: &656 + default: &652 value: author: login: octocat @@ -46241,7 +46289,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &657 + response-if-user-is-a-team-maintainer: &653 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -46306,7 +46354,7 @@ paths: application/json: schema: *324 examples: - response-if-users-membership-with-team-is-now-pending: &658 + response-if-users-membership-with-team-is-now-pending: &654 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -46354,322 +46402,6 @@ paths: enabledForGitHubApps: true category: teams subcategory: members - "/orgs/{org}/teams/{team_slug}/projects": - get: - summary: List team projects - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/list-projects-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-projects - parameters: - - *63 - - *64 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &325 - title: Team Project - description: A team's access to a project. - type: object - properties: - owner_url: - type: string - url: - type: string - html_url: - type: string - columns_url: - type: string - id: - type: integer - node_id: - type: string - name: - type: string - body: - type: string - nullable: true - number: - type: integer - state: - type: string - creator: *4 - created_at: - type: string - updated_at: - type: string - organization_permission: - description: The organization permission for this project. Only - present when owner is an organization. - type: string - private: - description: Whether the project is private or not. Only present - when owner is an organization. - type: boolean - permissions: - type: object - properties: - read: - type: boolean - write: - type: boolean - admin: - type: boolean - required: - - read - - write - - admin - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at - - permissions - examples: - default: &659 - value: - - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false - headers: - Link: *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": - get: - summary: Check team permissions for a project - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/check-permissions-for-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project - parameters: - - *63 - - *64 - - &326 - name: project_id - description: The unique identifier of the project. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *325 - examples: - default: &660 - value: - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - put: - summary: Add or update team project permissions - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/add-or-update-project-permissions-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - parameters: - - *63 - - *64 - - *326 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - nullable: true - examples: - default: - summary: Updates the permissions for the team to write for the project - value: - permission: write - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Remove a project from a team - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/remove-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team - parameters: - - *63 - - *64 - - *326 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/orgs/{org}/teams/{team_slug}/repos": get: summary: List team repositories @@ -46729,14 +46461,14 @@ paths: parameters: - *63 - *64 - - *327 - - *328 + - *325 + - *326 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &661 + schema: &655 title: Team Repository description: A team's access to a repository. type: object @@ -47307,8 +47039,8 @@ paths: parameters: - *63 - *64 - - *327 - - *328 + - *325 + - *326 requestBody: required: false content: @@ -47355,8 +47087,8 @@ paths: parameters: - *63 - *64 - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -47393,7 +47125,7 @@ paths: type: array items: *181 examples: - response-if-child-teams-exist: &662 + response-if-child-teams-exist: &656 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -47506,455 +47238,6 @@ paths: deprecationDate: '2024-07-22' removalDate: '2025-07-22' deprecated: true - "/projects/columns/{column_id}": - get: - summary: Get a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#get-a-project-column - parameters: - - &329 - name: column_id - description: The unique identifier of the column. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: &330 - title: Project Column - description: Project columns contain cards of work. - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/projects/columns/367 - project_url: - type: string - format: uri - example: https://api.github.com/projects/120 - cards_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367/cards - id: - description: The unique identifier of the project column - example: 42 - type: integer - node_id: - type: string - example: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: - description: Name of the project column - example: Remaining tasks - type: string - created_at: - type: string - format: date-time - example: '2016-09-05T14:18:44Z' - updated_at: - type: string - format: date-time - example: '2016-09-05T14:22:28Z' - required: - - id - - node_id - - url - - project_url - - cards_url - - name - - created_at - - updated_at - examples: - default: &331 - value: - url: https://api.github.com/projects/columns/367 - project_url: https://api.github.com/projects/120 - cards_url: https://api.github.com/projects/columns/367/cards - id: 367 - node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: To Do - created_at: '2016-09-05T14:18:44Z' - updated_at: '2016-09-05T14:22:28Z' - '304': *37 - '403': *29 - '404': *6 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update an existing project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/update-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column - parameters: - - *329 - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project column - example: Remaining tasks - type: string - required: - - name - type: object - examples: - default: - summary: Rename the project column - value: - name: To Do - responses: - '200': - description: Response - content: - application/json: - schema: *330 - examples: - default: *331 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/delete-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#delete-a-project-column - parameters: - - *329 - responses: - '204': - description: Response - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/columns/{column_id}/moves": - post: - summary: Move a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/move-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#move-a-project-column - parameters: - - *329 - requestBody: - required: true - content: - application/json: - schema: - properties: - position: - description: 'The position of the column in a project. Can be one - of: `first`, `last`, or `after:` to place after the - specified column.' - example: last - type: string - pattern: "^(?:first|last|after:\\d+)$" - required: - - position - type: object - examples: - default: - summary: Move the column to the end of the board - value: - position: last - responses: - '201': - description: Response - content: - application/json: - schema: - type: object - properties: {} - additionalProperties: false - examples: - default: - value: - '304': *37 - '403': *29 - '422': *7 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators": - get: - summary: List project collaborators - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/list-collaborators - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators - parameters: - - *326 - - name: affiliation - description: Filters the collaborators by their affiliation. `outside` means - outside collaborators of a project that are not a member of the project's - organization. `direct` means collaborators with permissions to a project, - regardless of organization membership status. `all` means all collaborators - the authenticated user can see. - in: query - required: false - schema: - type: string - enum: - - outside - - direct - - all - default: all - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *58 - headers: - Link: *54 - '404': *6 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators/{username}": - put: - summary: Add project collaborator - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/add-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator - parameters: - - *326 - - *59 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - description: The permission to grant the collaborator. - enum: - - read - - write - - admin - default: write - example: write - type: string - nullable: true - examples: - default: - summary: Applying write permissions for the new collaborator - value: - permission: write - responses: - '204': - description: Response - '404': *6 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Remove user as a collaborator - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/remove-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator - parameters: - - *326 - - *59 - responses: - '204': - description: Response - '304': *37 - '404': *6 - '403': *29 - '422': *15 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators/{username}/permission": - get: - summary: Get project permission for a user - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-permission-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user - parameters: - - *326 - - *59 - responses: - '200': - description: Response - content: - application/json: - schema: - title: Project Collaborator Permission - description: Project Collaborator Permission - type: object - properties: - permission: - type: string - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - required: - - permission - - user - examples: - default: - value: - permission: admin - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - '404': *6 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/rate_limit": get: summary: Get rate limit status for the authenticated user @@ -47996,7 +47279,7 @@ paths: resources: type: object properties: - core: &332 + core: &327 title: Rate Limit type: object properties: @@ -48013,21 +47296,21 @@ paths: - remaining - reset - used - graphql: *332 - search: *332 - code_search: *332 - source_import: *332 - integration_manifest: *332 - code_scanning_upload: *332 - actions_runner_registration: *332 - scim: *332 - dependency_snapshots: *332 - dependency_sbom: *332 - code_scanning_autofix: *332 + graphql: *327 + search: *327 + code_search: *327 + source_import: *327 + integration_manifest: *327 + code_scanning_upload: *327 + actions_runner_registration: *327 + scim: *327 + dependency_snapshots: *327 + dependency_sbom: *327 + code_scanning_autofix: *327 required: - core - search - rate: *332 + rate: *327 required: - rate - resources @@ -48132,14 +47415,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *333 + schema: *328 examples: default-response: summary: Default response @@ -48640,7 +47923,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *334 + '301': *329 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48658,8 +47941,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: false content: @@ -48906,10 +48189,10 @@ paths: description: Response content: application/json: - schema: *333 + schema: *328 examples: - default: *335 - '307': &336 + default: *330 + '307': &331 description: Temporary Redirect content: application/json: @@ -48938,8 +48221,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -48961,7 +48244,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *336 + '307': *331 '404': *6 '409': *47 x-github: @@ -48985,11 +48268,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 - - &367 + - &362 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -49012,7 +48295,7 @@ paths: type: integer artifacts: type: array - items: &337 + items: &332 title: Artifact description: An artifact type: object @@ -49090,7 +48373,7 @@ paths: - expires_at - updated_at examples: - default: &368 + default: &363 value: total_count: 2 artifacts: @@ -49151,9 +48434,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *327 - - *328 - - &338 + - *325 + - *326 + - &333 name: artifact_id description: The unique identifier of the artifact. in: path @@ -49165,7 +48448,7 @@ paths: description: Response content: application/json: - schema: *337 + schema: *332 examples: default: value: @@ -49203,9 +48486,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *327 - - *328 - - *338 + - *325 + - *326 + - *333 responses: '204': description: Response @@ -49229,9 +48512,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *327 - - *328 - - *338 + - *325 + - *326 + - *333 - name: archive_format in: path required: true @@ -49245,7 +48528,7 @@ paths: example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': &523 + '410': &518 description: Gone content: application/json: @@ -49272,14 +48555,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *339 + schema: *334 examples: default: value: @@ -49305,11 +48588,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 - - &340 + - &335 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -49343,7 +48626,7 @@ paths: description: Response content: application/json: - schema: &341 + schema: &336 title: Repository actions caches description: Repository actions caches type: object @@ -49385,7 +48668,7 @@ paths: - total_count - actions_caches examples: - default: &342 + default: &337 value: total_count: 1 actions_caches: @@ -49417,23 +48700,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *327 - - *328 + - *325 + - *326 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *340 + - *335 responses: '200': description: Response content: application/json: - schema: *341 + schema: *336 examples: - default: *342 + default: *337 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49453,8 +48736,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *327 - - *328 + - *325 + - *326 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -49485,9 +48768,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *327 - - *328 - - &343 + - *325 + - *326 + - &338 name: job_id description: The unique identifier of the job. in: path @@ -49499,7 +48782,7 @@ paths: description: Response content: application/json: - schema: &371 + schema: &366 title: Job description: Information of a job execution in a workflow run type: object @@ -49806,9 +49089,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *327 - - *328 - - *343 + - *325 + - *326 + - *338 responses: '302': description: Response @@ -49836,9 +49119,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *327 - - *328 - - *343 + - *325 + - *326 + - *338 requestBody: required: false content: @@ -49883,8 +49166,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Status response @@ -49934,8 +49217,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -49998,8 +49281,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -50017,7 +49300,7 @@ paths: type: integer secrets: type: array - items: &373 + items: &368 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -50037,7 +49320,7 @@ paths: - created_at - updated_at examples: - default: &374 + default: &369 value: total_count: 2 secrets: @@ -50070,9 +49353,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *327 - - *328 - - *344 + - *325 + - *326 + - *339 - *19 responses: '200': @@ -50089,7 +49372,7 @@ paths: type: integer variables: type: array - items: &377 + items: &372 title: Actions Variable type: object properties: @@ -50119,7 +49402,7 @@ paths: - created_at - updated_at examples: - default: &378 + default: &373 value: total_count: 2 variables: @@ -50152,8 +49435,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -50162,11 +49445,11 @@ paths: schema: type: object properties: - enabled: &346 + enabled: &341 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *128 - selected_actions_url: *345 + selected_actions_url: *340 sha_pinning_required: *129 required: - enabled @@ -50195,8 +49478,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -50207,7 +49490,7 @@ paths: schema: type: object properties: - enabled: *346 + enabled: *341 allowed_actions: *128 sha_pinning_required: *129 required: @@ -50239,14 +49522,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: &347 + schema: &342 type: object properties: access_level: @@ -50263,7 +49546,7 @@ paths: required: - access_level examples: - default: &348 + default: &343 value: access_level: organization x-github: @@ -50287,15 +49570,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: application/json: - schema: *347 + schema: *342 examples: - default: *348 + default: *343 responses: '204': description: Response @@ -50319,14 +49602,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *349 + schema: *344 examples: default: value: @@ -50350,8 +49633,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Empty response for successful settings update @@ -50361,7 +49644,7 @@ paths: required: true content: application/json: - schema: *350 + schema: *345 examples: default: summary: Set retention days @@ -50385,8 +49668,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -50394,7 +49677,7 @@ paths: application/json: schema: *130 examples: - default: *351 + default: *346 '404': *6 x-github: enabledForGitHubApps: true @@ -50413,8 +49696,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -50448,14 +49731,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *352 + schema: *347 examples: default: *131 '403': *29 @@ -50477,13 +49760,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: application/json: - schema: *353 + schema: *348 examples: default: *131 responses: @@ -50509,8 +49792,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -50537,8 +49820,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -50570,14 +49853,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *354 + schema: *349 examples: default: *138 x-github: @@ -50600,8 +49883,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Success response @@ -50612,7 +49895,7 @@ paths: required: true content: application/json: - schema: *355 + schema: *350 examples: default: *138 x-github: @@ -50641,8 +49924,8 @@ paths: in: query schema: type: string - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -50686,8 +49969,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -50695,9 +49978,9 @@ paths: application/json: schema: type: array - items: *356 + items: *351 examples: - default: *357 + default: *352 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50719,8 +50002,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -50763,7 +50046,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *358 + '201': *353 '404': *6 '422': *7 '409': *47 @@ -50794,8 +50077,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '201': description: Response @@ -50803,7 +50086,7 @@ paths: application/json: schema: *147 examples: - default: *359 + default: *354 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50831,8 +50114,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '201': description: Response @@ -50840,7 +50123,7 @@ paths: application/json: schema: *147 examples: - default: *360 + default: *355 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50862,8 +50145,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *144 responses: '200': @@ -50872,7 +50155,7 @@ paths: application/json: schema: *145 examples: - default: *361 + default: *356 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50893,8 +50176,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *144 responses: '204': @@ -50921,8 +50204,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *144 responses: '200': *149 @@ -50947,8 +50230,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *144 requestBody: required: true @@ -50997,8 +50280,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *144 requestBody: required: true @@ -51048,11 +50331,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *144 responses: - '200': *362 + '200': *357 '404': *6 x-github: githubCloudOnly: false @@ -51079,10 +50362,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *144 - - *363 + - *358 responses: '200': *149 '404': *6 @@ -51110,9 +50393,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *327 - - *328 - - &381 + - *325 + - *326 + - &376 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -51120,7 +50403,7 @@ paths: required: false schema: type: string - - &382 + - &377 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -51128,7 +50411,7 @@ paths: required: false schema: type: string - - &383 + - &378 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -51137,7 +50420,7 @@ paths: required: false schema: type: string - - &384 + - &379 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -51164,7 +50447,7 @@ paths: - pending - *17 - *19 - - &385 + - &380 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -51173,7 +50456,7 @@ paths: schema: type: string format: date-time - - &364 + - &359 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -51182,13 +50465,13 @@ paths: schema: type: boolean default: false - - &386 + - &381 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &387 + - &382 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -51211,7 +50494,7 @@ paths: type: integer workflow_runs: type: array - items: &365 + items: &360 title: Workflow Run description: An invocation of a workflow type: object @@ -51306,7 +50589,7 @@ paths: that triggered the run. type: array nullable: true - items: &406 + items: &401 title: Pull Request Minimal type: object properties: @@ -51425,7 +50708,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &410 + properties: &405 id: type: string description: SHA for the commit @@ -51476,7 +50759,7 @@ paths: - name - email nullable: true - required: &411 + required: &406 - id - tree_id - message @@ -51523,7 +50806,7 @@ paths: - workflow_url - pull_requests examples: - default: &388 + default: &383 value: total_count: 1 workflow_runs: @@ -51759,24 +51042,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *327 - - *328 - - &366 + - *325 + - *326 + - &361 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *364 + - *359 responses: '200': description: Response content: application/json: - schema: *365 + schema: *360 examples: - default: &369 + default: &364 value: id: 30433642 name: Build @@ -52017,9 +51300,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 responses: '204': description: Response @@ -52042,9 +51325,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 responses: '200': description: Response @@ -52163,9 +51446,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 responses: '201': description: Response @@ -52198,12 +51481,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 - *17 - *19 - - *367 + - *362 responses: '200': description: Response @@ -52219,9 +51502,9 @@ paths: type: integer artifacts: type: array - items: *337 + items: *332 examples: - default: *368 + default: *363 headers: Link: *54 x-github: @@ -52245,25 +51528,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *327 - - *328 - - *366 - - &370 + - *325 + - *326 + - *361 + - &365 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *364 + - *359 responses: '200': description: Response content: application/json: - schema: *365 + schema: *360 examples: - default: *369 + default: *364 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52286,10 +51569,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *327 - - *328 - - *366 - - *370 + - *325 + - *326 + - *361 + - *365 - *17 - *19 responses: @@ -52307,9 +51590,9 @@ paths: type: integer jobs: type: array - items: *371 + items: *366 examples: - default: &372 + default: &367 value: total_count: 1 jobs: @@ -52422,10 +51705,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *327 - - *328 - - *366 - - *370 + - *325 + - *326 + - *361 + - *365 responses: '302': description: Response @@ -52453,9 +51736,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 responses: '202': description: Response @@ -52488,9 +51771,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 requestBody: required: true content: @@ -52557,9 +51840,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 responses: '202': description: Response @@ -52592,9 +51875,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -52624,9 +51907,9 @@ paths: type: integer jobs: type: array - items: *371 + items: *366 examples: - default: *372 + default: *367 headers: Link: *54 x-github: @@ -52651,9 +51934,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 responses: '302': description: Response @@ -52680,9 +51963,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 responses: '204': description: Response @@ -52709,9 +51992,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 responses: '200': description: Response @@ -52771,7 +52054,7 @@ paths: items: type: object properties: - type: &489 + type: &484 type: string description: The type of reviewer. enum: @@ -52856,9 +52139,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 requestBody: required: true content: @@ -52905,7 +52188,7 @@ paths: application/json: schema: type: array - items: &484 + items: &479 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -53011,7 +52294,7 @@ paths: - created_at - updated_at examples: - default: &485 + default: &480 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -53067,9 +52350,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 requestBody: required: false content: @@ -53113,9 +52396,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 requestBody: required: false content: @@ -53168,9 +52451,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 responses: '200': description: Response @@ -53307,8 +52590,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -53326,9 +52609,9 @@ paths: type: integer secrets: type: array - items: *373 + items: *368 examples: - default: *374 + default: *369 headers: Link: *54 x-github: @@ -53353,16 +52636,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *375 + schema: *370 examples: - default: *376 + default: *371 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53384,17 +52667,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *327 - - *328 + - *325 + - *326 - *151 responses: '200': description: Response content: application/json: - schema: *373 + schema: *368 examples: - default: &502 + default: &497 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -53420,8 +52703,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *327 - - *328 + - *325 + - *326 - *151 requestBody: required: true @@ -53479,8 +52762,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *327 - - *328 + - *325 + - *326 - *151 responses: '204': @@ -53506,9 +52789,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *327 - - *328 - - *344 + - *325 + - *326 + - *339 - *19 responses: '200': @@ -53525,9 +52808,9 @@ paths: type: integer variables: type: array - items: *377 + items: *372 examples: - default: *378 + default: *373 headers: Link: *54 x-github: @@ -53550,8 +52833,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -53603,17 +52886,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *327 - - *328 + - *325 + - *326 - *154 responses: '200': description: Response content: application/json: - schema: *377 + schema: *372 examples: - default: &503 + default: &498 value: name: USERNAME value: octocat @@ -53639,8 +52922,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *327 - - *328 + - *325 + - *326 - *154 requestBody: required: true @@ -53683,8 +52966,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *327 - - *328 + - *325 + - *326 - *154 responses: '204': @@ -53710,8 +52993,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -53729,7 +53012,7 @@ paths: type: integer workflows: type: array - items: &379 + items: &374 title: Workflow description: A GitHub Actions workflow type: object @@ -53836,9 +53119,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *327 - - *328 - - &380 + - *325 + - *326 + - &375 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -53853,7 +53136,7 @@ paths: description: Response content: application/json: - schema: *379 + schema: *374 examples: default: value: @@ -53886,9 +53169,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *327 - - *328 - - *380 + - *325 + - *326 + - *375 responses: '204': description: Response @@ -53913,9 +53196,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *327 - - *328 - - *380 + - *325 + - *326 + - *375 responses: '204': description: Response @@ -53966,9 +53249,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *327 - - *328 - - *380 + - *325 + - *326 + - *375 responses: '204': description: Response @@ -53995,19 +53278,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *327 - - *328 + - *325 + - *326 + - *375 + - *376 + - *377 + - *378 + - *379 + - *17 + - *19 - *380 + - *359 - *381 - *382 - - *383 - - *384 - - *17 - - *19 - - *385 - - *364 - - *386 - - *387 responses: '200': description: Response @@ -54023,9 +53306,9 @@ paths: type: integer workflow_runs: type: array - items: *365 + items: *360 examples: - default: *388 + default: *383 headers: Link: *54 x-github: @@ -54057,9 +53340,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *327 - - *328 - - *380 + - *325 + - *326 + - *375 responses: '200': description: Response @@ -54120,8 +53403,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *327 - - *328 + - *325 + - *326 - *48 - *17 - *40 @@ -54285,8 +53568,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -54323,8 +53606,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *327 - - *328 + - *325 + - *326 - name: assignee in: path required: true @@ -54360,8 +53643,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-attestation parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -54473,8 +53756,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-attestations parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *40 - *41 @@ -54531,7 +53814,7 @@ paths: initiator: type: string examples: - default: *389 + default: *384 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54551,8 +53834,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -54560,7 +53843,7 @@ paths: application/json: schema: type: array - items: &390 + items: &385 title: Autolink reference description: An autolink reference. type: object @@ -54614,8 +53897,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -54654,9 +53937,9 @@ paths: description: response content: application/json: - schema: *390 + schema: *385 examples: - default: &391 + default: &386 value: id: 1 key_prefix: TICKET- @@ -54687,9 +53970,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *327 - - *328 - - &392 + - *325 + - *326 + - &387 name: autolink_id description: The unique identifier of the autolink. in: path @@ -54701,9 +53984,9 @@ paths: description: Response content: application/json: - schema: *390 + schema: *385 examples: - default: *391 + default: *386 '404': *6 x-github: githubCloudOnly: false @@ -54723,9 +54006,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *327 - - *328 - - *392 + - *325 + - *326 + - *387 responses: '204': description: Response @@ -54749,8 +54032,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response if Dependabot is enabled @@ -54798,8 +54081,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -54820,8 +54103,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -54841,8 +54124,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *327 - - *328 + - *325 + - *326 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -54880,7 +54163,7 @@ paths: - url protected: type: boolean - protection: &394 + protection: &389 title: Branch Protection description: Branch Protection type: object @@ -54922,7 +54205,7 @@ paths: required: - contexts - checks - enforce_admins: &397 + enforce_admins: &392 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -54937,7 +54220,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &399 + required_pull_request_reviews: &394 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -55013,7 +54296,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &396 + restrictions: &391 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -55290,9 +54573,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *327 - - *328 - - &395 + - *325 + - *326 + - &390 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). @@ -55306,14 +54589,14 @@ paths: description: Response content: application/json: - schema: &405 + schema: &400 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &458 + commit: &453 title: Commit description: Commit type: object @@ -55347,7 +54630,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &393 + properties: &388 name: type: string example: '"Chris Wanstrath"' @@ -55356,13 +54639,14 @@ paths: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true committer: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *393 + properties: *388 nullable: true message: type: string @@ -55383,7 +54667,7 @@ paths: required: - sha - url - verification: &509 + verification: &504 title: Verification type: object properties: @@ -55453,7 +54737,7 @@ paths: type: integer files: type: array - items: &471 + items: &466 title: Diff Entry description: Diff Entry type: object @@ -55537,7 +54821,7 @@ paths: - self protected: type: boolean - protection: *394 + protection: *389 protection_url: type: string format: uri @@ -55644,7 +54928,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *334 + '301': *329 '404': *6 x-github: githubCloudOnly: false @@ -55666,15 +54950,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response content: application/json: - schema: *394 + schema: *389 examples: default: value: @@ -55868,9 +55152,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: true content: @@ -56125,7 +55409,7 @@ paths: url: type: string format: uri - required_status_checks: &402 + required_status_checks: &397 title: Status Check Policy description: Status Check Policy type: object @@ -56277,7 +55561,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *396 + restrictions: *391 required_conversation_resolution: type: object properties: @@ -56389,9 +55673,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '204': description: Response @@ -56416,17 +55700,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response content: application/json: - schema: *397 + schema: *392 examples: - default: &398 + default: &393 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -56448,17 +55732,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response content: application/json: - schema: *397 + schema: *392 examples: - default: *398 + default: *393 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56477,9 +55761,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '204': description: Response @@ -56504,17 +55788,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response content: application/json: - schema: *399 + schema: *394 examples: - default: &400 + default: &395 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -56610,9 +55894,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: false content: @@ -56710,9 +55994,9 @@ paths: description: Response content: application/json: - schema: *399 + schema: *394 examples: - default: *400 + default: *395 '422': *15 x-github: githubCloudOnly: false @@ -56733,9 +56017,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '204': description: Response @@ -56762,17 +56046,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response content: application/json: - schema: *397 + schema: *392 examples: - default: &401 + default: &396 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -56795,17 +56079,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response content: application/json: - schema: *397 + schema: *392 examples: - default: *401 + default: *396 '404': *6 x-github: githubCloudOnly: false @@ -56825,9 +56109,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '204': description: Response @@ -56852,17 +56136,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response content: application/json: - schema: *402 + schema: *397 examples: - default: &403 + default: &398 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -56888,9 +56172,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: false content: @@ -56942,9 +56226,9 @@ paths: description: Response content: application/json: - schema: *402 + schema: *397 examples: - default: *403 + default: *398 '404': *6 '422': *15 x-github: @@ -56966,9 +56250,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '204': description: Response @@ -56992,9 +56276,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response @@ -57028,9 +56312,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: false content: @@ -57097,9 +56381,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: false content: @@ -57163,9 +56447,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: content: application/json: @@ -57231,15 +56515,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response content: application/json: - schema: *396 + schema: *391 examples: default: value: @@ -57330,9 +56614,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '204': description: Response @@ -57355,9 +56639,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response @@ -57367,7 +56651,7 @@ paths: type: array items: *5 examples: - default: &404 + default: &399 value: - id: 1 slug: octoapp @@ -57424,9 +56708,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: true content: @@ -57460,7 +56744,7 @@ paths: type: array items: *5 examples: - default: *404 + default: *399 '422': *15 x-github: githubCloudOnly: false @@ -57481,9 +56765,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: true content: @@ -57517,7 +56801,7 @@ paths: type: array items: *5 examples: - default: *404 + default: *399 '422': *15 x-github: githubCloudOnly: false @@ -57538,9 +56822,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: true content: @@ -57574,7 +56858,7 @@ paths: type: array items: *5 examples: - default: *404 + default: *399 '422': *15 x-github: githubCloudOnly: false @@ -57596,9 +56880,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response @@ -57628,9 +56912,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: false content: @@ -57689,9 +56973,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: false content: @@ -57750,9 +57034,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: content: application/json: @@ -57811,9 +57095,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response @@ -57847,9 +57131,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: true content: @@ -57907,9 +57191,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: true content: @@ -57967,9 +57251,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: true content: @@ -58029,9 +57313,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: true content: @@ -58053,7 +57337,7 @@ paths: description: Response content: application/json: - schema: *405 + schema: *400 examples: default: value: @@ -58169,8 +57453,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -58449,7 +57733,7 @@ paths: description: Response content: application/json: - schema: &407 + schema: &402 title: CheckRun description: A check performed on the code of a given code change type: object @@ -58568,8 +57852,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *406 - deployment: &714 + items: *401 + deployment: &708 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -58849,9 +58133,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *327 - - *328 - - &408 + - *325 + - *326 + - &403 name: check_run_id description: The unique identifier of the check run. in: path @@ -58863,9 +58147,9 @@ paths: description: Response content: application/json: - schema: *407 + schema: *402 examples: - default: &409 + default: &404 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -58965,9 +58249,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *327 - - *328 - - *408 + - *325 + - *326 + - *403 requestBody: required: true content: @@ -59207,9 +58491,9 @@ paths: description: Response content: application/json: - schema: *407 + schema: *402 examples: - default: *409 + default: *404 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59229,9 +58513,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *327 - - *328 - - *408 + - *325 + - *326 + - *403 - *17 - *19 responses: @@ -59326,9 +58610,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *327 - - *328 - - *408 + - *325 + - *326 + - *403 responses: '201': description: Response @@ -59372,8 +58656,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -59395,7 +58679,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &412 + schema: &407 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -59459,7 +58743,7 @@ paths: nullable: true pull_requests: type: array - items: *406 + items: *401 nullable: true app: title: GitHub app @@ -59481,12 +58765,12 @@ paths: type: string format: date-time nullable: true - head_commit: &740 + head_commit: &734 title: Simple Commit description: A commit. type: object - properties: *410 - required: *411 + properties: *405 + required: *406 latest_check_runs_count: type: integer check_runs_url: @@ -59514,7 +58798,7 @@ paths: - check_runs_url - pull_requests examples: - default: &413 + default: &408 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -59805,9 +59089,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *412 + schema: *407 examples: - default: *413 + default: *408 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59826,8 +59110,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -60136,9 +59420,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *327 - - *328 - - &414 + - *325 + - *326 + - &409 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -60150,9 +59434,9 @@ paths: description: Response content: application/json: - schema: *412 + schema: *407 examples: - default: *413 + default: *408 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60175,17 +59459,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *327 - - *328 - - *414 - - &464 + - *325 + - *326 + - *409 + - &459 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &465 + - &460 name: status description: Returns check runs with the specified `status`. in: query @@ -60224,9 +59508,9 @@ paths: type: integer check_runs: type: array - items: *407 + items: *402 examples: - default: &466 + default: &461 value: total_count: 1 check_runs: @@ -60328,9 +59612,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *327 - - *328 - - *414 + - *325 + - *326 + - *409 responses: '201': description: Response @@ -60363,21 +59647,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *327 - - *328 - - *415 - - *416 + - *325 + - *326 + - *410 + - *411 - *19 - *17 - - &433 + - &428 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *417 - - &434 + schema: *412 + - &429 name: pr description: The number of the pull request for the results you want to list. in: query @@ -60402,13 +59686,13 @@ paths: be returned. in: query required: false - schema: *418 + schema: *413 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *419 + schema: *414 responses: '200': description: Response @@ -60424,7 +59708,7 @@ paths: updated_at: *163 url: *164 html_url: *165 - instances_url: *420 + instances_url: *415 state: *170 fixed_at: *166 dismissed_by: @@ -60435,11 +59719,11 @@ paths: required: *21 nullable: true dismissed_at: *167 - dismissed_reason: *421 - dismissed_comment: *422 - rule: *423 - tool: *424 - most_recent_instance: *425 + dismissed_reason: *416 + dismissed_comment: *417 + rule: *418 + tool: *419 + most_recent_instance: *420 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -60565,7 +59849,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &426 + '403': &421 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -60592,9 +59876,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *327 - - *328 - - &427 + - *325 + - *326 + - &422 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -60608,7 +59892,7 @@ paths: description: Response content: application/json: - schema: &428 + schema: &423 type: object properties: number: *161 @@ -60616,7 +59900,7 @@ paths: updated_at: *163 url: *164 html_url: *165 - instances_url: *420 + instances_url: *415 state: *170 fixed_at: *166 dismissed_by: @@ -60627,8 +59911,8 @@ paths: required: *21 nullable: true dismissed_at: *167 - dismissed_reason: *421 - dismissed_comment: *422 + dismissed_reason: *416 + dismissed_comment: *417 rule: type: object properties: @@ -60682,8 +59966,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *424 - most_recent_instance: *425 + tool: *419 + most_recent_instance: *420 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -60782,7 +60066,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *426 + '403': *421 '404': *6 '503': *104 x-github: @@ -60802,9 +60086,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *327 - - *328 - - *427 + - *325 + - *326 + - *422 requestBody: required: true content: @@ -60819,8 +60103,8 @@ paths: enum: - open - dismissed - dismissed_reason: *421 - dismissed_comment: *422 + dismissed_reason: *416 + dismissed_comment: *417 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -60839,7 +60123,7 @@ paths: description: Response content: application/json: - schema: *428 + schema: *423 examples: default: value: @@ -60915,7 +60199,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &432 + '403': &427 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -60942,15 +60226,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *327 - - *328 - - *427 + - *325 + - *326 + - *422 responses: '200': description: Response content: application/json: - schema: &429 + schema: &424 type: object properties: status: @@ -60976,13 +60260,13 @@ paths: - description - started_at examples: - default: &430 + default: &425 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &431 + '400': &426 description: Bad Request content: application/json: @@ -60993,7 +60277,7 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *426 + '403': *421 '404': *6 '503': *104 x-github: @@ -61018,29 +60302,29 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *327 - - *328 - - *427 + - *325 + - *326 + - *422 responses: '200': description: OK content: application/json: - schema: *429 + schema: *424 examples: - default: *430 + default: *425 '202': description: Accepted content: application/json: - schema: *429 + schema: *424 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *431 + '400': *426 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -61072,9 +60356,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *327 - - *328 - - *427 + - *325 + - *326 + - *422 requestBody: required: false content: @@ -61119,8 +60403,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *431 - '403': *432 + '400': *426 + '403': *427 '404': *6 '422': description: Unprocessable Entity @@ -61144,13 +60428,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *327 - - *328 - - *427 + - *325 + - *326 + - *422 - *19 - *17 - - *433 - - *434 + - *428 + - *429 responses: '200': description: Response @@ -61158,7 +60442,7 @@ paths: application/json: schema: type: array - items: *425 + items: *420 examples: default: value: @@ -61197,7 +60481,7 @@ paths: end_column: 50 classifications: - source - '403': *426 + '403': *421 '404': *6 '503': *104 x-github: @@ -61231,25 +60515,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *327 - - *328 - - *415 - - *416 + - *325 + - *326 + - *410 + - *411 - *19 - *17 - - *434 + - *429 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *417 + schema: *412 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &437 + schema: &432 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -61270,23 +60554,23 @@ paths: application/json: schema: type: array - items: &438 + items: &433 type: object properties: - ref: *417 - commit_sha: &446 + ref: *412 + commit_sha: &441 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *435 + analysis_key: *430 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *436 + category: *431 error: type: string example: error reading field xyz @@ -61310,8 +60594,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *437 - tool: *424 + sarif_id: *432 + tool: *419 deletable: type: boolean warning: @@ -61372,7 +60656,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *426 + '403': *421 '404': *6 '503': *104 x-github: @@ -61408,8 +60692,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -61422,7 +60706,7 @@ paths: description: Response content: application/json: - schema: *438 + schema: *433 examples: response: summary: application/json response @@ -61476,7 +60760,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *426 + '403': *421 '404': *6 '422': description: Response if analysis could not be processed @@ -61563,8 +60847,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -61617,7 +60901,7 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *432 + '403': *427 '404': *6 '503': *104 x-github: @@ -61639,8 +60923,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -61648,7 +60932,7 @@ paths: application/json: schema: type: array - items: &439 + items: &434 title: CodeQL Database description: A CodeQL database. type: object @@ -61759,7 +61043,7 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *426 + '403': *421 '404': *6 '503': *104 x-github: @@ -61788,8 +61072,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - name: language in: path description: The language of the CodeQL database. @@ -61801,7 +61085,7 @@ paths: description: Response content: application/json: - schema: *439 + schema: *434 examples: default: value: @@ -61833,9 +61117,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &473 + '302': &468 description: Found - '403': *426 + '403': *421 '404': *6 '503': *104 x-github: @@ -61857,8 +61141,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *327 - - *328 + - *325 + - *326 - name: language in: path description: The language of the CodeQL database. @@ -61868,7 +61152,7 @@ paths: responses: '204': description: Response - '403': *432 + '403': *427 '404': *6 '503': *104 x-github: @@ -61896,8 +61180,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -61906,7 +61190,7 @@ paths: type: object additionalProperties: false properties: - language: &440 + language: &435 type: string description: The language targeted by the CodeQL query enum: @@ -61986,7 +61270,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &444 + schema: &439 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -61996,7 +61280,7 @@ paths: description: The ID of the variant analysis. controller_repo: *53 actor: *4 - query_language: *440 + query_language: *435 query_pack_url: type: string description: The download url for the query pack. @@ -62043,7 +61327,7 @@ paths: items: type: object properties: - repository: &441 + repository: &436 title: Repository Identifier description: Repository Identifier type: object @@ -62079,7 +61363,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &445 + analysis_status: &440 type: string description: The new status of the CodeQL variant analysis repository task. @@ -62111,7 +61395,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &442 + access_mismatch_repos: &437 type: object properties: repository_count: @@ -62125,7 +61409,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *441 + items: *436 required: - repository_count - repositories @@ -62147,8 +61431,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *442 - over_limit_repos: *442 + no_codeql_db_repos: *437 + over_limit_repos: *437 required: - access_mismatch_repos - not_found_repos @@ -62164,7 +61448,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &443 + value: &438 summary: Default response value: id: 1 @@ -62316,10 +61600,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *443 + value: *438 repository_lists: summary: Response for a successful variant analysis submission - value: *443 + value: *438 '404': *6 '422': description: Unable to process variant analysis submission @@ -62347,8 +61631,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *327 - - *328 + - *325 + - *326 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -62360,9 +61644,9 @@ paths: description: Response content: application/json: - schema: *444 + schema: *439 examples: - default: *443 + default: *438 '404': *6 '503': *104 x-github: @@ -62385,7 +61669,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *327 + - *325 - name: repo in: path description: The name of the controller repository. @@ -62420,7 +61704,7 @@ paths: type: object properties: repository: *53 - analysis_status: *445 + analysis_status: *440 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -62545,8 +61829,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -62631,7 +61915,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *426 + '403': *421 '404': *6 '503': *104 x-github: @@ -62652,8 +61936,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -62745,7 +62029,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *432 + '403': *427 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -62816,8 +62100,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -62825,7 +62109,7 @@ paths: schema: type: object properties: - commit_sha: *446 + commit_sha: *441 ref: type: string description: |- @@ -62883,7 +62167,7 @@ paths: schema: type: object properties: - id: *437 + id: *432 url: type: string description: The REST API URL for checking the status of the upload. @@ -62897,7 +62181,7 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *432 + '403': *427 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -62920,8 +62204,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *327 - - *328 + - *325 + - *326 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -62967,7 +62251,7 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *426 + '403': *421 '404': description: Not Found if the sarif id does not match any upload '503': *104 @@ -62992,8 +62276,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -63074,8 +62358,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *327 - - *328 + - *325 + - *326 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -63195,8 +62479,8 @@ paths: parameters: - *17 - *19 - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -63510,8 +62794,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -63576,7 +62860,7 @@ paths: application/json: schema: *224 examples: - default: *447 + default: *442 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -63584,7 +62868,7 @@ paths: application/json: schema: *224 examples: - default: *447 + default: *442 '400': *14 '401': *25 '403': *29 @@ -63613,8 +62897,8 @@ paths: parameters: - *17 - *19 - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -63678,8 +62962,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -63714,14 +62998,14 @@ paths: type: integer machines: type: array - items: &669 + items: &663 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *448 - required: *449 + properties: *443 + required: *444 examples: - default: &670 + default: &664 value: total_count: 2 machines: @@ -63761,8 +63045,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *327 - - *328 + - *325 + - *326 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -63846,8 +63130,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *327 - - *328 + - *325 + - *326 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -63913,8 +63197,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -63932,7 +63216,7 @@ paths: type: integer secrets: type: array - items: &453 + items: &448 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -63952,7 +63236,7 @@ paths: - created_at - updated_at examples: - default: *450 + default: *445 headers: Link: *54 x-github: @@ -63975,16 +63259,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *451 + schema: *446 examples: - default: *452 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64004,17 +63288,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *327 - - *328 + - *325 + - *326 - *151 responses: '200': description: Response content: application/json: - schema: *453 + schema: *448 examples: - default: *454 + default: *449 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64034,8 +63318,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *327 - - *328 + - *325 + - *326 - *151 requestBody: required: true @@ -64088,8 +63372,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *327 - - *328 + - *325 + - *326 - *151 responses: '204': @@ -64118,8 +63402,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *327 - - *328 + - *325 + - *326 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -64161,7 +63445,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &455 + properties: &450 login: type: string example: octocat @@ -64254,7 +63538,7 @@ paths: user_view_type: type: string example: public - required: &456 + required: &451 - avatar_url - events_url - followers_url @@ -64328,8 +63612,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *327 - - *328 + - *325 + - *326 - *59 responses: '204': @@ -64376,8 +63660,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *327 - - *328 + - *325 + - *326 - *59 requestBody: required: false @@ -64404,7 +63688,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &522 + schema: &517 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -64633,8 +63917,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *327 - - *328 + - *325 + - *326 - *59 responses: '204': @@ -64666,8 +63950,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *327 - - *328 + - *325 + - *326 - *59 responses: '200': @@ -64688,8 +63972,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *455 - required: *456 + properties: *450 + required: *451 nullable: true required: - permission @@ -64744,8 +64028,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -64755,7 +64039,7 @@ paths: application/json: schema: type: array - items: &457 + items: &452 title: Commit Comment description: Commit Comment type: object @@ -64813,7 +64097,7 @@ paths: - created_at - updated_at examples: - default: &460 + default: &455 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -64872,17 +64156,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 responses: '200': description: Response content: application/json: - schema: *457 + schema: *452 examples: - default: &461 + default: &456 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -64939,8 +64223,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 requestBody: required: true @@ -64963,7 +64247,7 @@ paths: description: Response content: application/json: - schema: *457 + schema: *452 examples: default: value: @@ -65014,8 +64298,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 responses: '204': @@ -65037,8 +64321,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -65088,8 +64372,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 requestBody: required: true @@ -65153,8 +64437,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *327 - - *328 + - *325 + - *326 - *81 - *323 responses: @@ -65205,8 +64489,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *327 - - *328 + - *325 + - *326 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -65262,9 +64546,9 @@ paths: application/json: schema: type: array - items: *458 + items: *453 examples: - default: &575 + default: &570 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -65358,9 +64642,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *327 - - *328 - - &459 + - *325 + - *326 + - &454 name: commit_sha description: The SHA of the commit. in: path @@ -65432,9 +64716,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *327 - - *328 - - *459 + - *325 + - *326 + - *454 - *17 - *19 responses: @@ -65444,9 +64728,9 @@ paths: application/json: schema: type: array - items: *457 + items: *452 examples: - default: *460 + default: *455 headers: Link: *54 x-github: @@ -65474,9 +64758,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *327 - - *328 - - *459 + - *325 + - *326 + - *454 requestBody: required: true content: @@ -65511,9 +64795,9 @@ paths: description: Response content: application/json: - schema: *457 + schema: *452 examples: - default: *461 + default: *456 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -65541,9 +64825,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *327 - - *328 - - *459 + - *325 + - *326 + - *454 - *17 - *19 responses: @@ -65553,9 +64837,9 @@ paths: application/json: schema: type: array - items: *462 + items: *457 examples: - default: &567 + default: &562 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -66092,11 +65376,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *327 - - *328 + - *325 + - *326 - *19 - *17 - - &463 + - &458 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -66111,9 +65395,9 @@ paths: description: Response content: application/json: - schema: *458 + schema: *453 examples: - default: &552 + default: &547 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -66226,11 +65510,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *327 - - *328 - - *463 - - *464 - - *465 + - *325 + - *326 + - *458 + - *459 + - *460 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -66264,9 +65548,9 @@ paths: type: integer check_runs: type: array - items: *407 + items: *402 examples: - default: *466 + default: *461 headers: Link: *54 x-github: @@ -66291,9 +65575,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *327 - - *328 - - *463 + - *325 + - *326 + - *458 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -66301,7 +65585,7 @@ paths: schema: type: integer example: 1 - - *464 + - *459 - *17 - *19 responses: @@ -66319,7 +65603,7 @@ paths: type: integer check_suites: type: array - items: *412 + items: *407 examples: default: value: @@ -66519,9 +65803,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *327 - - *328 - - *463 + - *325 + - *326 + - *458 - *17 - *19 responses: @@ -66719,9 +66003,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *327 - - *328 - - *463 + - *325 + - *326 + - *458 - *17 - *19 responses: @@ -66731,7 +66015,7 @@ paths: application/json: schema: type: array - items: &640 + items: &636 title: Status description: The status of a commit. type: object @@ -66812,7 +66096,7 @@ paths: site_admin: false headers: Link: *54 - '301': *334 + '301': *329 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66840,8 +66124,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -66870,20 +66154,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *467 - required: *468 + properties: *462 + required: *463 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &469 + properties: &464 url: type: string format: uri html_url: type: string format: uri - required: &470 + required: &465 - url - html_url nullable: true @@ -66897,26 +66181,26 @@ paths: contributing: title: Community Health File type: object - properties: *469 - required: *470 + properties: *464 + required: *465 nullable: true readme: title: Community Health File type: object - properties: *469 - required: *470 + properties: *464 + required: *465 nullable: true issue_template: title: Community Health File type: object - properties: *469 - required: *470 + properties: *464 + required: *465 nullable: true pull_request_template: title: Community Health File type: object - properties: *469 - required: *470 + properties: *464 + required: *465 nullable: true required: - code_of_conduct @@ -67043,8 +66327,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *327 - - *328 + - *325 + - *326 - *19 - *17 - name: basehead @@ -67087,8 +66371,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *458 - merge_base_commit: *458 + base_commit: *453 + merge_base_commit: *453 status: type: string enum: @@ -67108,10 +66392,10 @@ paths: example: 6 commits: type: array - items: *458 + items: *453 files: type: array - items: *471 + items: *466 required: - url - html_url @@ -67397,8 +66681,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *327 - - *328 + - *325 + - *326 - name: path description: path parameter in: path @@ -67541,7 +66825,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &472 + response-if-content-is-a-file: &467 summary: Response if content is a file value: type: file @@ -67673,7 +66957,7 @@ paths: - size - type - url - - &580 + - &575 title: Content File description: Content File type: object @@ -67874,7 +67158,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *472 + response-if-content-is-a-file: *467 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -67943,7 +67227,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *473 + '302': *468 '304': *37 x-github: githubCloudOnly: false @@ -67966,8 +67250,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *327 - - *328 + - *325 + - *326 - name: path description: path parameter in: path @@ -68060,7 +67344,7 @@ paths: description: Response content: application/json: - schema: &474 + schema: &469 title: File Commit description: File Commit type: object @@ -68212,7 +67496,7 @@ paths: description: Response content: application/json: - schema: *474 + schema: *469 examples: example-for-creating-a-file: value: @@ -68266,7 +67550,7 @@ paths: schema: oneOf: - *3 - - &504 + - &499 description: Repository rule violation was detected type: object properties: @@ -68287,7 +67571,7 @@ paths: items: type: object properties: - placeholder_id: &632 + placeholder_id: &628 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -68319,8 +67603,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *327 - - *328 + - *325 + - *326 - name: path description: path parameter in: path @@ -68381,7 +67665,7 @@ paths: description: Response content: application/json: - schema: *474 + schema: *469 examples: default: value: @@ -68436,8 +67720,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *327 - - *328 + - *325 + - *326 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -68560,8 +67844,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *182 - *183 - *184 @@ -68573,7 +67857,7 @@ paths: schema: type: string - *186 - - *475 + - *470 - *187 - *188 - *48 @@ -68594,7 +67878,7 @@ paths: application/json: schema: type: array - items: &478 + items: &473 type: object description: A Dependabot alert. properties: @@ -68640,7 +67924,7 @@ paths: - unknown - direct - transitive - security_advisory: *476 + security_advisory: *471 security_vulnerability: *52 url: *164 html_url: *165 @@ -68671,7 +67955,7 @@ paths: nullable: true maxLength: 280 fixed_at: *166 - auto_dismissed_at: *477 + auto_dismissed_at: *472 required: - number - state @@ -68901,9 +68185,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *327 - - *328 - - &479 + - *325 + - *326 + - &474 name: alert_number in: path description: |- @@ -68918,7 +68202,7 @@ paths: description: Response content: application/json: - schema: *478 + schema: *473 examples: default: value: @@ -69031,9 +68315,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *327 - - *328 - - *479 + - *325 + - *326 + - *474 requestBody: required: true content: @@ -69078,7 +68362,7 @@ paths: description: Response content: application/json: - schema: *478 + schema: *473 examples: default: value: @@ -69207,8 +68491,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -69226,7 +68510,7 @@ paths: type: integer secrets: type: array - items: &482 + items: &477 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -69279,16 +68563,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *480 + schema: *475 examples: - default: *481 + default: *476 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69308,15 +68592,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *327 - - *328 + - *325 + - *326 - *151 responses: '200': description: Response content: application/json: - schema: *482 + schema: *477 examples: default: value: @@ -69342,8 +68626,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *327 - - *328 + - *325 + - *326 - *151 requestBody: required: true @@ -69396,8 +68680,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *327 - - *328 + - *325 + - *326 - *151 responses: '204': @@ -69420,8 +68704,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *327 - - *328 + - *325 + - *326 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -69581,8 +68865,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -69821,8 +69105,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -69897,7 +69181,7 @@ paths: - version - url additionalProperties: false - metadata: &483 + metadata: &478 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -69930,7 +69214,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *483 + metadata: *478 resolved: type: object description: A collection of resolved package dependencies. @@ -69943,7 +69227,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *483 + metadata: *478 relationship: type: string description: A notation of whether a dependency is requested @@ -70072,8 +69356,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *327 - - *328 + - *325 + - *326 - name: sha description: The SHA recorded at creation time. in: query @@ -70113,9 +69397,9 @@ paths: application/json: schema: type: array - items: *484 + items: *479 examples: - default: *485 + default: *480 headers: Link: *54 x-github: @@ -70181,8 +69465,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -70263,7 +69547,7 @@ paths: description: Response content: application/json: - schema: *484 + schema: *479 examples: simple-example: summary: Simple example @@ -70336,9 +69620,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *327 - - *328 - - &486 + - *325 + - *326 + - &481 name: deployment_id description: deployment_id parameter in: path @@ -70350,7 +69634,7 @@ paths: description: Response content: application/json: - schema: *484 + schema: *479 examples: default: value: @@ -70415,9 +69699,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *327 - - *328 - - *486 + - *325 + - *326 + - *481 responses: '204': description: Response @@ -70439,9 +69723,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *327 - - *328 - - *486 + - *325 + - *326 + - *481 - *17 - *19 responses: @@ -70451,7 +69735,7 @@ paths: application/json: schema: type: array - items: &487 + items: &482 title: Deployment Status description: The status of a deployment. type: object @@ -70612,9 +69896,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *327 - - *328 - - *486 + - *325 + - *326 + - *481 requestBody: required: true content: @@ -70689,9 +69973,9 @@ paths: description: Response content: application/json: - schema: *487 + schema: *482 examples: - default: &488 + default: &483 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -70747,9 +70031,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *327 - - *328 - - *486 + - *325 + - *326 + - *481 - name: status_id in: path required: true @@ -70760,9 +70044,9 @@ paths: description: Response content: application/json: - schema: *487 + schema: *482 examples: - default: *488 + default: *483 '404': *6 x-github: githubCloudOnly: false @@ -70787,8 +70071,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -70845,8 +70129,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -70863,7 +70147,7 @@ paths: type: integer environments: type: array - items: &490 + items: &485 title: Environment description: Details of a deployment environment type: object @@ -70915,7 +70199,7 @@ paths: type: type: string example: wait_timer - wait_timer: &492 + wait_timer: &487 type: integer example: 30 description: The amount of time to delay a job after @@ -70952,7 +70236,7 @@ paths: items: type: object properties: - type: *489 + type: *484 reviewer: anyOf: - *4 @@ -70976,7 +70260,7 @@ paths: - id - node_id - type - deployment_branch_policy: &493 + deployment_branch_policy: &488 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -71092,9 +70376,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *327 - - *328 - - &491 + - *325 + - *326 + - &486 name: environment_name in: path required: true @@ -71107,9 +70391,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *485 examples: - default: &494 + default: &489 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -71193,9 +70477,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 requestBody: required: false content: @@ -71204,7 +70488,7 @@ paths: type: object nullable: true properties: - wait_timer: *492 + wait_timer: *487 prevent_self_review: type: boolean example: false @@ -71221,13 +70505,13 @@ paths: items: type: object properties: - type: *489 + type: *484 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *493 + deployment_branch_policy: *488 additionalProperties: false examples: default: @@ -71247,9 +70531,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *485 examples: - default: *494 + default: *489 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -71273,9 +70557,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 responses: '204': description: Default response @@ -71300,9 +70584,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 - *17 - *19 responses: @@ -71320,7 +70604,7 @@ paths: example: 2 branch_policies: type: array - items: &495 + items: &490 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -71377,9 +70661,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 requestBody: required: true content: @@ -71425,9 +70709,9 @@ paths: description: Response content: application/json: - schema: *495 + schema: *490 examples: - example-wildcard: &496 + example-wildcard: &491 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -71469,10 +70753,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *327 - - *328 - - *491 - - &497 + - *325 + - *326 + - *486 + - &492 name: branch_policy_id in: path required: true @@ -71484,9 +70768,9 @@ paths: description: Response content: application/json: - schema: *495 + schema: *490 examples: - default: *496 + default: *491 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71505,10 +70789,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *327 - - *328 - - *491 - - *497 + - *325 + - *326 + - *486 + - *492 requestBody: required: true content: @@ -71536,9 +70820,9 @@ paths: description: Response content: application/json: - schema: *495 + schema: *490 examples: - default: *496 + default: *491 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71557,10 +70841,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *327 - - *328 - - *491 - - *497 + - *325 + - *326 + - *486 + - *492 responses: '204': description: Response @@ -71585,9 +70869,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *491 - - *328 - - *327 + - *486 + - *326 + - *325 responses: '200': description: List of deployment protection rules @@ -71603,7 +70887,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &498 + items: &493 title: Deployment protection rule description: Deployment protection rule type: object @@ -71622,7 +70906,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &499 + app: &494 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -71721,9 +71005,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *491 - - *328 - - *327 + - *486 + - *326 + - *325 requestBody: content: application/json: @@ -71744,9 +71028,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *498 + schema: *493 examples: - default: &500 + default: &495 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -71781,9 +71065,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *491 - - *328 - - *327 + - *486 + - *326 + - *325 - *19 - *17 responses: @@ -71802,7 +71086,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *499 + items: *494 examples: default: value: @@ -71837,10 +71121,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *327 - - *328 - - *491 - - &501 + - *325 + - *326 + - *486 + - &496 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -71852,9 +71136,9 @@ paths: description: Response content: application/json: - schema: *498 + schema: *493 examples: - default: *500 + default: *495 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71875,10 +71159,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *491 - - *328 - - *327 - - *501 + - *486 + - *326 + - *325 + - *496 responses: '204': description: Response @@ -71904,9 +71188,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 - *17 - *19 responses: @@ -71924,9 +71208,9 @@ paths: type: integer secrets: type: array - items: *373 + items: *368 examples: - default: *374 + default: *369 headers: Link: *54 x-github: @@ -71951,17 +71235,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 responses: '200': description: Response content: application/json: - schema: *375 + schema: *370 examples: - default: *376 + default: *371 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71983,18 +71267,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 - *151 responses: '200': description: Response content: application/json: - schema: *373 + schema: *368 examples: - default: *502 + default: *497 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72016,9 +71300,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 - *151 requestBody: required: true @@ -72076,9 +71360,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 - *151 responses: '204': @@ -72104,10 +71388,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *327 - - *328 - - *491 - - *344 + - *325 + - *326 + - *486 + - *339 - *19 responses: '200': @@ -72124,9 +71408,9 @@ paths: type: integer variables: type: array - items: *377 + items: *372 examples: - default: *378 + default: *373 headers: Link: *54 x-github: @@ -72149,9 +71433,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 requestBody: required: true content: @@ -72203,18 +71487,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 - *154 responses: '200': description: Response content: application/json: - schema: *377 + schema: *372 examples: - default: *503 + default: *498 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72235,10 +71519,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *327 - - *328 + - *325 + - *326 - *154 - - *491 + - *486 requestBody: required: true content: @@ -72280,10 +71564,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *327 - - *328 + - *325 + - *326 - *154 - - *491 + - *486 responses: '204': description: Response @@ -72305,8 +71589,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -72374,8 +71658,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *327 - - *328 + - *325 + - *326 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -72534,8 +71818,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: false content: @@ -72567,9 +71851,9 @@ paths: description: Response content: application/json: - schema: *333 + schema: *328 examples: - default: *335 + default: *330 '400': *14 '422': *15 '403': *29 @@ -72590,8 +71874,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -72651,7 +71935,7 @@ paths: schema: oneOf: - *112 - - *504 + - *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72676,8 +71960,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *327 - - *328 + - *325 + - *326 - name: file_sha in: path required: true @@ -72776,8 +72060,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -72886,7 +72170,7 @@ paths: description: Response content: application/json: - schema: &505 + schema: &500 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -73100,15 +72384,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *327 - - *328 - - *459 + - *325 + - *326 + - *454 responses: '200': description: Response content: application/json: - schema: *505 + schema: *500 examples: default: value: @@ -73164,9 +72448,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *327 - - *328 - - &506 + - *325 + - *326 + - &501 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -73183,7 +72467,7 @@ paths: application/json: schema: type: array - items: &507 + items: &502 title: Git Reference description: Git references within a repository type: object @@ -73258,17 +72542,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *327 - - *328 - - *506 + - *325 + - *326 + - *501 responses: '200': description: Response content: application/json: - schema: *507 + schema: *502 examples: - default: &508 + default: &503 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -73297,8 +72581,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -73327,9 +72611,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *502 examples: - default: *508 + default: *503 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -73355,9 +72639,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *327 - - *328 - - *506 + - *325 + - *326 + - *501 requestBody: required: true content: @@ -73386,9 +72670,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *502 examples: - default: *508 + default: *503 '422': *15 '409': *47 x-github: @@ -73406,9 +72690,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *327 - - *328 - - *506 + - *325 + - *326 + - *501 responses: '204': description: Response @@ -73463,8 +72747,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -73531,7 +72815,7 @@ paths: description: Response content: application/json: - schema: &510 + schema: &505 title: Git Tag description: Metadata for a Git tag type: object @@ -73582,7 +72866,7 @@ paths: - sha - type - url - verification: *509 + verification: *504 required: - sha - url @@ -73592,7 +72876,7 @@ paths: - tag - message examples: - default: &511 + default: &506 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -73665,8 +72949,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *327 - - *328 + - *325 + - *326 - name: tag_sha in: path required: true @@ -73677,9 +72961,9 @@ paths: description: Response content: application/json: - schema: *510 + schema: *505 examples: - default: *511 + default: *506 '404': *6 '409': *47 x-github: @@ -73703,8 +72987,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -73777,7 +73061,7 @@ paths: description: Response content: application/json: - schema: &512 + schema: &507 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -73873,8 +73157,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *327 - - *328 + - *325 + - *326 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -73897,7 +73181,7 @@ paths: description: Response content: application/json: - schema: *512 + schema: *507 examples: default-response: summary: Default response @@ -73956,8 +73240,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -73967,7 +73251,7 @@ paths: application/json: schema: type: array - items: &513 + items: &508 title: Webhook description: Webhooks for repositories. type: object @@ -74021,7 +73305,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &748 + last_response: &742 title: Hook Response type: object properties: @@ -74095,8 +73379,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: false content: @@ -74148,9 +73432,9 @@ paths: description: Response content: application/json: - schema: *513 + schema: *508 examples: - default: &514 + default: &509 value: type: Repository id: 12345678 @@ -74198,17 +73482,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *327 - - *328 + - *325 + - *326 - *196 responses: '200': description: Response content: application/json: - schema: *513 + schema: *508 examples: - default: *514 + default: *509 '404': *6 x-github: githubCloudOnly: false @@ -74228,8 +73512,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *327 - - *328 + - *325 + - *326 - *196 requestBody: required: true @@ -74275,9 +73559,9 @@ paths: description: Response content: application/json: - schema: *513 + schema: *508 examples: - default: *514 + default: *509 '422': *15 '404': *6 x-github: @@ -74298,8 +73582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *327 - - *328 + - *325 + - *326 - *196 responses: '204': @@ -74324,8 +73608,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *196 responses: '200': @@ -74353,8 +73637,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *196 requestBody: required: false @@ -74399,8 +73683,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *327 - - *328 + - *325 + - *326 - *196 - *17 - *197 @@ -74432,8 +73716,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *327 - - *328 + - *325 + - *326 - *196 - *16 responses: @@ -74462,8 +73746,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *327 - - *328 + - *325 + - *326 - *196 - *16 responses: @@ -74487,8 +73771,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *327 - - *328 + - *325 + - *326 - *196 responses: '204': @@ -74514,8 +73798,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *327 - - *328 + - *325 + - *326 - *196 responses: '204': @@ -74539,8 +73823,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response if immutable releases are enabled @@ -74586,8 +73870,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': *175 '409': *47 @@ -74607,8 +73891,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': *175 '409': *47 @@ -74665,14 +73949,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: &515 + schema: &510 title: Import description: A repository import from an external source. type: object @@ -74771,7 +74055,7 @@ paths: - html_url - authors_url examples: - default: &518 + default: &513 value: vcs: subversion use_lfs: true @@ -74787,7 +74071,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &516 + '503': &511 description: Unavailable due to service under maintenance. content: application/json: @@ -74816,8 +74100,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -74865,7 +74149,7 @@ paths: description: Response content: application/json: - schema: *515 + schema: *510 examples: default: value: @@ -74890,7 +74174,7 @@ paths: type: string '422': *15 '404': *6 - '503': *516 + '503': *511 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74918,8 +74202,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: false content: @@ -74968,7 +74252,7 @@ paths: description: Response content: application/json: - schema: *515 + schema: *510 examples: example-1: summary: Example 1 @@ -75016,7 +74300,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *516 + '503': *511 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75039,12 +74323,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response - '503': *516 + '503': *511 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75070,9 +74354,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *327 - - *328 - - &691 + - *325 + - *326 + - &685 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -75086,7 +74370,7 @@ paths: application/json: schema: type: array - items: &517 + items: &512 title: Porter Author description: Porter Author type: object @@ -75140,7 +74424,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *516 + '503': *511 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75165,8 +74449,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *327 - - *328 + - *325 + - *326 - name: author_id in: path required: true @@ -75196,7 +74480,7 @@ paths: description: Response content: application/json: - schema: *517 + schema: *512 examples: default: value: @@ -75209,7 +74493,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *516 + '503': *511 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75233,8 +74517,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -75275,7 +74559,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *516 + '503': *511 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75303,8 +74587,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -75331,11 +74615,11 @@ paths: description: Response content: application/json: - schema: *515 + schema: *510 examples: - default: *518 + default: *513 '422': *15 - '503': *516 + '503': *511 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75358,8 +74642,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -75367,8 +74651,8 @@ paths: application/json: schema: *22 examples: - default: *519 - '301': *334 + default: *514 + '301': *329 '404': *6 x-github: githubCloudOnly: false @@ -75388,8 +74672,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -75402,7 +74686,7 @@ paths: properties: {} additionalProperties: false examples: - default: &521 + default: &516 value: limit: collaborators_only origin: repository @@ -75427,13 +74711,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: application/json: - schema: *520 + schema: *515 examples: default: summary: Example request body @@ -75447,7 +74731,7 @@ paths: application/json: schema: *214 examples: - default: *521 + default: *516 '409': description: Response x-github: @@ -75469,8 +74753,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -75493,8 +74777,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -75504,9 +74788,9 @@ paths: application/json: schema: type: array - items: *522 + items: *517 examples: - default: &684 + default: &678 value: - id: 1 repository: @@ -75637,8 +74921,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *327 - - *328 + - *325 + - *326 - *218 requestBody: required: false @@ -75668,7 +74952,7 @@ paths: description: Response content: application/json: - schema: *522 + schema: *517 examples: default: value: @@ -75799,8 +75083,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *327 - - *328 + - *325 + - *326 - *218 responses: '204': @@ -75832,8 +75116,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *327 - - *328 + - *325 + - *326 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -75906,7 +75190,7 @@ paths: type: array items: *82 examples: - default: &532 + default: &527 value: - id: 1 node_id: MDU6SXNzdWUx @@ -76054,7 +75338,7 @@ paths: state_reason: completed headers: Link: *54 - '301': *334 + '301': *329 '422': *15 '404': *6 x-github: @@ -76083,8 +75367,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -76168,7 +75452,7 @@ paths: application/json: schema: *82 examples: - default: &529 + default: &524 value: id: 1 node_id: MDU6SXNzdWUx @@ -76324,7 +75608,7 @@ paths: '422': *15 '503': *104 '404': *6 - '410': *523 + '410': *518 x-github: triggersNotification: true githubCloudOnly: false @@ -76352,8 +75636,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *92 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -76374,9 +75658,9 @@ paths: application/json: schema: type: array - items: *524 + items: *519 examples: - default: &531 + default: &526 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -76434,17 +75718,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 responses: '200': description: Response content: application/json: - schema: *524 + schema: *519 examples: - default: &525 + default: &520 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -76498,8 +75782,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 requestBody: required: true @@ -76522,9 +75806,9 @@ paths: description: Response content: application/json: - schema: *524 + schema: *519 examples: - default: *525 + default: *520 '422': *15 x-github: githubCloudOnly: false @@ -76542,8 +75826,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 responses: '204': @@ -76564,8 +75848,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -76615,8 +75899,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 requestBody: required: true @@ -76680,8 +75964,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *327 - - *328 + - *325 + - *326 - *81 - *323 responses: @@ -76703,8 +75987,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -76714,7 +75998,7 @@ paths: application/json: schema: type: array - items: &528 + items: &523 title: Issue Event description: Issue Event type: object @@ -76757,8 +76041,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *526 - required: *527 + properties: *521 + required: *522 nullable: true label: title: Issue Event Label @@ -77065,8 +76349,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *327 - - *328 + - *325 + - *326 - name: event_id in: path required: true @@ -77077,7 +76361,7 @@ paths: description: Response content: application/json: - schema: *528 + schema: *523 examples: default: value: @@ -77270,7 +76554,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *523 + '410': *518 '403': *29 x-github: githubCloudOnly: false @@ -77304,9 +76588,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *327 - - *328 - - &530 + - *325 + - *326 + - &525 name: issue_number description: The number that identifies the issue. in: path @@ -77320,10 +76604,10 @@ paths: application/json: schema: *82 examples: - default: *529 - '301': *334 + default: *524 + '301': *329 '404': *6 - '410': *523 + '410': *518 '304': *37 x-github: githubCloudOnly: false @@ -77348,9 +76632,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: false content: @@ -77456,13 +76740,13 @@ paths: application/json: schema: *82 examples: - default: *529 + default: *524 '422': *15 '503': *104 '403': *29 - '301': *334 + '301': *329 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77480,9 +76764,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: false content: @@ -77510,7 +76794,7 @@ paths: application/json: schema: *82 examples: - default: *529 + default: *524 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77526,9 +76810,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: content: application/json: @@ -77555,7 +76839,7 @@ paths: application/json: schema: *82 examples: - default: *529 + default: *524 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77577,9 +76861,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - name: assignee in: path required: true @@ -77619,9 +76903,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - *72 - *17 - *19 @@ -77632,13 +76916,13 @@ paths: application/json: schema: type: array - items: *524 + items: *519 examples: - default: *531 + default: *526 headers: Link: *54 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77667,9 +76951,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: true content: @@ -77691,16 +76975,16 @@ paths: description: Response content: application/json: - schema: *524 + schema: *519 examples: - default: *525 + default: *520 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *523 + '410': *518 '422': *15 '404': *6 x-github: @@ -77728,9 +77012,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - *17 - *19 responses: @@ -77742,12 +77026,12 @@ paths: type: array items: *82 examples: - default: *532 + default: *527 headers: Link: *54 - '301': *334 + '301': *329 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77775,9 +77059,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: true content: @@ -77801,15 +77085,15 @@ paths: application/json: schema: *82 examples: - default: *529 + default: *524 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *334 + '301': *329 '403': *29 - '410': *523 + '410': *518 '422': *15 '404': *6 x-github: @@ -77840,9 +77124,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -77856,13 +77140,13 @@ paths: application/json: schema: *82 examples: - default: *529 - '301': *334 + default: *524 + '301': *329 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *523 + '410': *518 x-github: triggersNotification: true githubCloudOnly: false @@ -77888,9 +77172,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - *17 - *19 responses: @@ -77902,12 +77186,12 @@ paths: type: array items: *82 examples: - default: *532 + default: *527 headers: Link: *54 - '301': *334 + '301': *329 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77924,9 +77208,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - *17 - *19 responses: @@ -77940,7 +77224,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &535 + - &530 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -77994,7 +77278,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &536 + - &531 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -78130,7 +77414,7 @@ paths: - performed_via_github_app - assignee - assigner - - &537 + - &532 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -78181,7 +77465,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &538 + - &533 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -78232,7 +77516,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &539 + - &534 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -78286,7 +77570,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &540 + - &535 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -78333,7 +77617,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &541 + - &536 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -78380,7 +77664,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &542 + - &537 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -78440,7 +77724,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &543 + - &538 title: Locked Issue Event description: Locked Issue Event type: object @@ -78488,7 +77772,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &544 + - &539 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -78554,7 +77838,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &545 + - &540 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -78620,7 +77904,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &546 + - &541 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -78686,7 +77970,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &547 + - &542 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -78777,7 +78061,7 @@ paths: color: red headers: Link: *54 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78794,9 +78078,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - *17 - *19 responses: @@ -78806,7 +78090,7 @@ paths: application/json: schema: type: array - items: &533 + items: &528 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -78853,7 +78137,7 @@ paths: - color - default examples: - default: &534 + default: &529 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -78871,9 +78155,9 @@ paths: default: false headers: Link: *54 - '301': *334 + '301': *329 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78890,9 +78174,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: false content: @@ -78951,12 +78235,12 @@ paths: application/json: schema: type: array - items: *533 + items: *528 examples: - default: *534 - '301': *334 + default: *529 + '301': *329 '404': *6 - '410': *523 + '410': *518 '422': *15 x-github: githubCloudOnly: false @@ -78973,9 +78257,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: false content: @@ -79035,12 +78319,12 @@ paths: application/json: schema: type: array - items: *533 + items: *528 examples: - default: *534 - '301': *334 + default: *529 + '301': *329 '404': *6 - '410': *523 + '410': *518 '422': *15 x-github: githubCloudOnly: false @@ -79057,15 +78341,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 responses: '204': description: Response - '301': *334 + '301': *329 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79084,9 +78368,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - name: name in: path required: true @@ -79099,7 +78383,7 @@ paths: application/json: schema: type: array - items: *533 + items: *528 examples: default: value: @@ -79110,9 +78394,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *334 + '301': *329 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79132,9 +78416,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: false content: @@ -79162,7 +78446,7 @@ paths: '204': description: Response '403': *29 - '410': *523 + '410': *518 '404': *6 '422': *15 x-github: @@ -79180,9 +78464,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 responses: '204': description: Response @@ -79212,9 +78496,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 responses: '200': description: Response @@ -79222,10 +78506,10 @@ paths: application/json: schema: *82 examples: - default: *529 - '301': *334 + default: *524 + '301': *329 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79242,9 +78526,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -79276,7 +78560,7 @@ paths: headers: Link: *54 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79294,9 +78578,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: true content: @@ -79359,9 +78643,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - *323 responses: '204': @@ -79391,9 +78675,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: true content: @@ -79417,7 +78701,7 @@ paths: application/json: schema: *82 examples: - default: *529 + default: *524 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -79450,9 +78734,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - *17 - *19 responses: @@ -79464,11 +78748,11 @@ paths: type: array items: *82 examples: - default: *532 + default: *527 headers: Link: *54 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79496,9 +78780,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: true content: @@ -79527,14 +78811,14 @@ paths: application/json: schema: *82 examples: - default: *529 + default: *524 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *523 + '410': *518 '422': *15 '404': *6 x-github: @@ -79554,9 +78838,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: true content: @@ -79589,7 +78873,7 @@ paths: application/json: schema: *82 examples: - default: *529 + default: *524 '403': *29 '404': *6 '422': *7 @@ -79611,9 +78895,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - *17 - *19 responses: @@ -79628,6 +78912,11 @@ paths: description: Timeline Event type: object anyOf: + - *530 + - *531 + - *532 + - *533 + - *534 - *535 - *536 - *537 @@ -79636,11 +78925,6 @@ paths: - *540 - *541 - *542 - - *543 - - *544 - - *545 - - *546 - - *547 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -79949,7 +79233,7 @@ paths: type: string comments: type: array - items: &569 + items: &564 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -80158,7 +79442,7 @@ paths: type: string comments: type: array - items: *457 + items: *452 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -80447,7 +79731,7 @@ paths: headers: Link: *54 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80464,8 +79748,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -80475,7 +79759,7 @@ paths: application/json: schema: type: array - items: &548 + items: &543 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -80541,8 +79825,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -80578,9 +79862,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *543 examples: - default: &549 + default: &544 value: id: 1 key: ssh-rsa AAA... @@ -80614,9 +79898,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *327 - - *328 - - &550 + - *325 + - *326 + - &545 name: key_id description: The unique identifier of the key. in: path @@ -80628,9 +79912,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *543 examples: - default: *549 + default: *544 '404': *6 x-github: githubCloudOnly: false @@ -80648,9 +79932,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *327 - - *328 - - *550 + - *325 + - *326 + - *545 responses: '204': description: Response @@ -80670,8 +79954,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -80681,9 +79965,9 @@ paths: application/json: schema: type: array - items: *533 + items: *528 examples: - default: *534 + default: *529 headers: Link: *54 '404': *6 @@ -80704,8 +79988,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -80741,9 +80025,9 @@ paths: description: Response content: application/json: - schema: *533 + schema: *528 examples: - default: &551 + default: &546 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -80775,8 +80059,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *327 - - *328 + - *325 + - *326 - name: name in: path required: true @@ -80787,9 +80071,9 @@ paths: description: Response content: application/json: - schema: *533 + schema: *528 examples: - default: *551 + default: *546 '404': *6 x-github: githubCloudOnly: false @@ -80806,8 +80090,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *327 - - *328 + - *325 + - *326 - name: name in: path required: true @@ -80846,7 +80130,7 @@ paths: description: Response content: application/json: - schema: *533 + schema: *528 examples: default: value: @@ -80872,8 +80156,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *327 - - *328 + - *325 + - *326 - name: name in: path required: true @@ -80899,8 +80183,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -80939,9 +80223,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *327 - - *328 - - *433 + - *325 + - *326 + - *428 responses: '200': description: Response @@ -81086,8 +80370,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -81152,8 +80436,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -81187,9 +80471,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *458 + schema: *453 examples: - default: *552 + default: *547 '204': description: Response when already merged '404': @@ -81214,8 +80498,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *327 - - *328 + - *325 + - *326 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -81256,7 +80540,7 @@ paths: application/json: schema: type: array - items: &553 + items: &548 title: Milestone description: A collection of related issues and pull requests. type: object @@ -81317,8 +80601,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -81358,9 +80642,9 @@ paths: description: Response content: application/json: - schema: *553 + schema: *548 examples: - default: &554 + default: &549 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -81419,9 +80703,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *327 - - *328 - - &555 + - *325 + - *326 + - &550 name: milestone_number description: The number that identifies the milestone. in: path @@ -81433,9 +80717,9 @@ paths: description: Response content: application/json: - schema: *553 + schema: *548 examples: - default: *554 + default: *549 '404': *6 x-github: githubCloudOnly: false @@ -81452,9 +80736,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *327 - - *328 - - *555 + - *325 + - *326 + - *550 requestBody: required: false content: @@ -81492,9 +80776,9 @@ paths: description: Response content: application/json: - schema: *553 + schema: *548 examples: - default: *554 + default: *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81510,9 +80794,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *327 - - *328 - - *555 + - *325 + - *326 + - *550 responses: '204': description: Response @@ -81533,9 +80817,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *327 - - *328 - - *555 + - *325 + - *326 + - *550 - *17 - *19 responses: @@ -81545,9 +80829,9 @@ paths: application/json: schema: type: array - items: *533 + items: *528 examples: - default: *534 + default: *529 headers: Link: *54 x-github: @@ -81566,12 +80850,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *327 - - *328 - - *556 - - *557 + - *325 + - *326 + - *551 + - *552 - *72 - - *558 + - *553 - *17 - *19 responses: @@ -81583,7 +80867,7 @@ paths: type: array items: *95 examples: - default: *559 + default: *554 headers: Link: *54 x-github: @@ -81607,8 +80891,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: false content: @@ -81666,14 +80950,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: &560 + schema: &555 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -81798,7 +81082,7 @@ paths: - custom_404 - public examples: - default: &561 + default: &556 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -81839,8 +81123,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -81894,9 +81178,9 @@ paths: description: Response content: application/json: - schema: *560 + schema: *555 examples: - default: *561 + default: *556 '422': *15 '409': *47 x-github: @@ -81919,8 +81203,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -82019,8 +81303,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -82046,8 +81330,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -82057,7 +81341,7 @@ paths: application/json: schema: type: array - items: &562 + items: &557 title: Page Build description: Page Build type: object @@ -82151,8 +81435,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *327 - - *328 + - *325 + - *326 responses: '201': description: Response @@ -82197,16 +81481,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *562 + schema: *557 examples: - default: &563 + default: &558 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -82254,8 +81538,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *327 - - *328 + - *325 + - *326 - name: build_id in: path required: true @@ -82266,9 +81550,9 @@ paths: description: Response content: application/json: - schema: *562 + schema: *557 examples: - default: *563 + default: *558 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82288,8 +81572,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -82394,9 +81678,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *327 - - *328 - - &564 + - *325 + - *326 + - &559 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -82454,9 +81738,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *327 - - *328 - - *564 + - *325 + - *326 + - *559 responses: '204': *175 '404': *6 @@ -82483,8 +81767,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -82742,8 +82026,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Private vulnerability reporting status @@ -82780,8 +82064,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': *175 '422': *14 @@ -82802,8 +82086,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': *175 '422': *14 @@ -82825,8 +82109,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -82836,7 +82120,7 @@ paths: type: array items: *102 examples: - default: *565 + default: *560 '403': *29 '404': *6 x-github: @@ -82858,8 +82142,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -82875,7 +82159,7 @@ paths: required: - properties examples: - default: *566 + default: *561 responses: '204': description: No Content when custom property values are successfully created @@ -82913,8 +82197,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *327 - - *328 + - *325 + - *326 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -82974,9 +82258,9 @@ paths: application/json: schema: type: array - items: *462 + items: *457 examples: - default: *567 + default: *562 headers: Link: *54 '304': *37 @@ -83008,8 +82292,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -83074,7 +82358,7 @@ paths: description: Response content: application/json: - schema: &571 + schema: &566 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -83288,7 +82572,7 @@ paths: - review_comment - self author_association: *69 - auto_merge: *568 + auto_merge: *563 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -83380,7 +82664,7 @@ paths: - merged_by - review_comments examples: - default: &572 + default: &567 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -83907,8 +83191,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - name: sort in: query required: false @@ -83937,9 +83221,9 @@ paths: application/json: schema: type: array - items: *569 + items: *564 examples: - default: &574 + default: &569 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -84016,17 +83300,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 + - *325 + - *326 - *81 responses: '200': description: Response content: application/json: - schema: *569 + schema: *564 examples: - default: &570 + default: &565 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -84101,8 +83385,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 + - *325 + - *326 - *81 requestBody: required: true @@ -84125,9 +83409,9 @@ paths: description: Response content: application/json: - schema: *569 + schema: *564 examples: - default: *570 + default: *565 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84143,8 +83427,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 + - *325 + - *326 - *81 responses: '204': @@ -84166,8 +83450,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -84217,8 +83501,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 requestBody: required: true @@ -84282,8 +83566,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *327 - - *328 + - *325 + - *326 - *81 - *323 responses: @@ -84328,9 +83612,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *327 - - *328 - - &573 + - *325 + - *326 + - &568 name: pull_number description: The number that identifies the pull request. in: path @@ -84343,9 +83627,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *571 + schema: *566 examples: - default: *572 + default: *567 '304': *37 '404': *6 '406': @@ -84380,9 +83664,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 requestBody: required: false content: @@ -84424,9 +83708,9 @@ paths: description: Response content: application/json: - schema: *571 + schema: *566 examples: - default: *572 + default: *567 '422': *15 '403': *29 x-github: @@ -84448,9 +83732,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 requestBody: required: true content: @@ -84512,7 +83796,7 @@ paths: application/json: schema: *224 examples: - default: *447 + default: *442 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -84520,7 +83804,7 @@ paths: application/json: schema: *224 examples: - default: *447 + default: *442 '401': *25 '403': *29 '404': *6 @@ -84550,9 +83834,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 - *92 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -84573,9 +83857,9 @@ paths: application/json: schema: type: array - items: *569 + items: *564 examples: - default: *574 + default: *569 headers: Link: *54 x-github: @@ -84608,9 +83892,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 requestBody: required: true content: @@ -84715,7 +83999,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *564 examples: example-for-a-multi-line-comment: value: @@ -84803,9 +84087,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 - *81 requestBody: required: true @@ -84828,7 +84112,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *564 examples: default: value: @@ -84914,9 +84198,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 - *17 - *19 responses: @@ -84926,9 +84210,9 @@ paths: application/json: schema: type: array - items: *458 + items: *453 examples: - default: *575 + default: *570 headers: Link: *54 x-github: @@ -84958,9 +84242,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 - *17 - *19 responses: @@ -84970,7 +84254,7 @@ paths: application/json: schema: type: array - items: *471 + items: *466 examples: default: value: @@ -85008,9 +84292,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 responses: '204': description: Response if pull request has been merged @@ -85033,9 +84317,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 requestBody: required: false content: @@ -85146,9 +84430,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 responses: '200': description: Response @@ -85223,9 +84507,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 requestBody: required: false content: @@ -85262,7 +84546,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *457 examples: default: value: @@ -85798,9 +85082,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 requestBody: required: true content: @@ -85834,7 +85118,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *457 examples: default: value: @@ -86339,9 +85623,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 - *17 - *19 responses: @@ -86351,7 +85635,7 @@ paths: application/json: schema: type: array - items: &576 + items: &571 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -86502,9 +85786,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 requestBody: required: false content: @@ -86590,9 +85874,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *571 examples: - default: &578 + default: &573 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -86655,10 +85939,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 - - &577 + - *325 + - *326 + - *568 + - &572 name: review_id description: The unique identifier of the review. in: path @@ -86670,9 +85954,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *571 examples: - default: &579 + default: &574 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -86731,10 +86015,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 - - *577 + - *325 + - *326 + - *568 + - *572 requestBody: required: true content: @@ -86757,7 +86041,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *571 examples: default: value: @@ -86819,18 +86103,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 - - *577 + - *325 + - *326 + - *568 + - *572 responses: '200': description: Response content: application/json: - schema: *576 + schema: *571 examples: - default: *578 + default: *573 '422': *7 '404': *6 x-github: @@ -86857,10 +86141,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *327 - - *328 - - *573 - - *577 + - *325 + - *326 + - *568 + - *572 - *17 - *19 responses: @@ -87095,10 +86379,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 - - *577 + - *325 + - *326 + - *568 + - *572 requestBody: required: true content: @@ -87126,7 +86410,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *571 examples: default: value: @@ -87189,10 +86473,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 - - *577 + - *325 + - *326 + - *568 + - *572 requestBody: required: true content: @@ -87227,9 +86511,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *571 examples: - default: *579 + default: *574 '404': *6 '422': *7 '403': *29 @@ -87251,9 +86535,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 requestBody: required: false content: @@ -87316,8 +86600,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *327 - - *328 + - *325 + - *326 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -87330,9 +86614,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *575 examples: - default: &581 + default: &576 value: type: file encoding: base64 @@ -87374,8 +86658,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *327 - - *328 + - *325 + - *326 - name: dir description: The alternate path to look for a README file in: path @@ -87395,9 +86679,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *575 examples: - default: *581 + default: *576 '404': *6 '422': *15 x-github: @@ -87419,8 +86703,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -87430,7 +86714,7 @@ paths: application/json: schema: type: array - items: &582 + items: &577 title: Release description: A release. type: object @@ -87501,7 +86785,7 @@ paths: author: *4 assets: type: array - items: &583 + items: &578 title: Release Asset description: Data related to a release. type: object @@ -87688,8 +86972,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -87765,9 +87049,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *577 examples: - default: &586 + default: &581 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -87872,9 +87156,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *327 - - *328 - - &584 + - *325 + - *326 + - &579 name: asset_id description: The unique identifier of the asset. in: path @@ -87886,9 +87170,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *578 examples: - default: &585 + default: &580 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -87923,7 +87207,7 @@ paths: type: User site_admin: false '404': *6 - '302': *473 + '302': *468 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87939,9 +87223,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *327 - - *328 - - *584 + - *325 + - *326 + - *579 requestBody: required: false content: @@ -87969,9 +87253,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *578 examples: - default: *585 + default: *580 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87987,9 +87271,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *327 - - *328 - - *584 + - *325 + - *326 + - *579 responses: '204': description: Response @@ -88013,8 +87297,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -88099,16 +87383,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *582 + schema: *577 examples: - default: *586 + default: *581 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88125,8 +87409,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *327 - - *328 + - *325 + - *326 - name: tag description: tag parameter in: path @@ -88139,9 +87423,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *577 examples: - default: *586 + default: *581 '404': *6 x-github: githubCloudOnly: false @@ -88163,9 +87447,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *327 - - *328 - - &587 + - *325 + - *326 + - &582 name: release_id description: The unique identifier of the release. in: path @@ -88179,9 +87463,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *582 + schema: *577 examples: - default: *586 + default: *581 '401': description: Unauthorized x-github: @@ -88199,9 +87483,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *327 - - *328 - - *587 + - *325 + - *326 + - *582 requestBody: required: false content: @@ -88265,9 +87549,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *577 examples: - default: *586 + default: *581 '404': description: Not Found if the discussion category name is invalid content: @@ -88288,9 +87572,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *327 - - *328 - - *587 + - *325 + - *326 + - *582 responses: '204': description: Response @@ -88310,9 +87594,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *327 - - *328 - - *587 + - *325 + - *326 + - *582 - *17 - *19 responses: @@ -88322,7 +87606,7 @@ paths: application/json: schema: type: array - items: *583 + items: *578 examples: default: value: @@ -88403,9 +87687,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *327 - - *328 - - *587 + - *325 + - *326 + - *582 - name: name in: query required: true @@ -88431,7 +87715,7 @@ paths: description: Response for successful upload content: application/json: - schema: *583 + schema: *578 examples: response-for-successful-upload: value: @@ -88486,9 +87770,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *327 - - *328 - - *587 + - *325 + - *326 + - *582 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -88535,9 +87819,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *327 - - *328 - - *587 + - *325 + - *326 + - *582 requestBody: required: true content: @@ -88598,9 +87882,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *327 - - *328 - - *587 + - *325 + - *326 + - *582 - *323 responses: '204': @@ -88625,9 +87909,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 - *17 - *19 responses: @@ -88644,7 +87928,7 @@ paths: oneOf: - allOf: - *278 - - &588 + - &583 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -88665,67 +87949,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *279 - - *588 + - *583 - allOf: - *280 - - *588 + - *583 - allOf: - *281 - - *588 + - *583 - allOf: - - *589 - - *588 + - *584 + - *583 - allOf: - *282 - - *588 + - *583 - allOf: - *283 - - *588 + - *583 - allOf: - *284 - - *588 + - *583 - allOf: - *285 - - *588 + - *583 - allOf: - *286 - - *588 + - *583 - allOf: - *287 - - *588 + - *583 - allOf: - *288 - - *588 + - *583 - allOf: - *289 - - *588 + - *583 - allOf: - *290 - - *588 + - *583 - allOf: - *291 - - *588 + - *583 - allOf: - *292 - - *588 + - *583 - allOf: - *293 - - *588 + - *583 - allOf: - *294 - - *588 + - *583 - allOf: - *295 - - *588 + - *583 - allOf: - *296 - - *588 + - *583 - allOf: - *297 - - *588 + - *583 - allOf: - - *590 - - *588 + - *585 + - *583 examples: default: value: @@ -88764,8 +88048,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 - name: includes_parents @@ -88776,7 +88060,7 @@ paths: schema: type: boolean default: true - - *591 + - *586 responses: '200': description: Response @@ -88831,8 +88115,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *325 + - *326 requestBody: description: Request body required: true @@ -88861,7 +88145,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *592 + items: *587 required: - name - enforcement @@ -88894,7 +88178,7 @@ paths: application/json: schema: *298 examples: - default: &602 + default: &597 value: id: 42 name: super cool ruleset @@ -88941,12 +88225,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *327 - - *328 - - *593 - - *594 - - *595 - - *596 + - *325 + - *326 + - *588 + - *589 + - *590 + - *591 - *17 - *19 responses: @@ -88954,9 +88238,9 @@ paths: description: Response content: application/json: - schema: *597 + schema: *592 examples: - default: *598 + default: *593 '404': *6 '500': *103 x-github: @@ -88977,17 +88261,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *327 - - *328 - - *599 + - *325 + - *326 + - *594 responses: '200': description: Response content: application/json: - schema: *600 + schema: *595 examples: - default: *601 + default: *596 '404': *6 '500': *103 x-github: @@ -89015,8 +88299,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *325 + - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89038,7 +88322,7 @@ paths: application/json: schema: *298 examples: - default: *602 + default: *597 '404': *6 '500': *103 put: @@ -89056,8 +88340,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *325 + - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89091,7 +88375,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *592 + items: *587 examples: default: value: @@ -89121,7 +88405,7 @@ paths: application/json: schema: *298 examples: - default: *602 + default: *597 '404': *6 '500': *103 delete: @@ -89139,8 +88423,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *325 + - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89163,8 +88447,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 - name: ruleset_id @@ -89182,7 +88466,7 @@ paths: type: array items: *301 examples: - default: *603 + default: *598 '404': *6 '500': *103 x-github: @@ -89201,8 +88485,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *327 - - *328 + - *325 + - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89220,7 +88504,7 @@ paths: description: Response content: application/json: - schema: *604 + schema: *599 examples: default: value: @@ -89275,21 +88559,22 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 + - *600 + - *601 + - *602 + - *603 + - *604 + - *48 + - *19 + - *17 - *605 - *606 - *607 - *608 - - *48 - - *19 - - *17 - *609 - *610 - - *611 - - *612 - - *613 - - *614 responses: '200': description: Response @@ -89297,7 +88582,7 @@ paths: application/json: schema: type: array - items: &618 + items: &614 type: object properties: number: *161 @@ -89316,8 +88601,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *615 - resolution: *616 + state: *611 + resolution: *612 resolved_at: type: string format: date-time @@ -89413,7 +88698,7 @@ paths: pull request. ' - oneOf: *617 + oneOf: *613 nullable: true has_more_locations: type: boolean @@ -89562,16 +88847,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *327 - - *328 - - *427 - - *614 + - *325 + - *326 + - *422 + - *610 responses: '200': description: Response content: application/json: - schema: *618 + schema: *614 examples: default: value: @@ -89613,6 +88898,8 @@ paths: description: |- Updates the status of a secret scanning alert in an eligible repository. + You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. 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. @@ -89623,9 +88910,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *327 - - *328 - - *427 + - *325 + - *326 + - *422 requestBody: required: true content: @@ -89633,27 +88920,42 @@ paths: schema: type: object properties: - state: *615 - resolution: *616 + state: *611 + resolution: *612 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: string nullable: true + assignee: + description: The username of the user to assign to the alert. Set + to `null` to unassign the alert. + type: string + nullable: true anyOf: - required: - state + - required: + - assignee examples: default: value: state: resolved resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: responses: '200': description: Response content: application/json: - schema: *618 + schema: *614 examples: default: value: @@ -89698,6 +89000,25 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false '400': description: Bad request, resolution comment is invalid or the resolution was not changed. @@ -89705,7 +89026,8 @@ paths: description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': - description: State does not match the resolution or resolution comment + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository '503': *104 x-github: enabledForGitHubApps: true @@ -89728,9 +89050,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *327 - - *328 - - *427 + - *325 + - *326 + - *422 - *19 - *17 responses: @@ -89741,7 +89063,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &770 + items: &764 type: object properties: type: @@ -89767,6 +89089,10 @@ paths: example: commit details: oneOf: + - *615 + - *616 + - *617 + - *618 - *619 - *620 - *621 @@ -89776,10 +89102,6 @@ paths: - *625 - *626 - *627 - - *628 - - *629 - - *630 - - *631 examples: default: value: @@ -89865,8 +89187,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -89874,14 +89196,14 @@ paths: schema: type: object properties: - reason: &633 + reason: &629 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *632 + placeholder_id: *628 required: - reason - placeholder_id @@ -89898,7 +89220,7 @@ paths: schema: type: object properties: - reason: *633 + reason: *629 expire_at: type: string format: date-time @@ -89944,8 +89266,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -89960,7 +89282,7 @@ paths: properties: incremental_scans: type: array - items: &634 + items: &630 description: Information on a single scan performed by secret scanning on the repository type: object @@ -89986,15 +89308,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *634 + items: *630 backfill_scans: type: array - items: *634 + items: *630 custom_pattern_backfill_scans: type: array items: allOf: - - *634 + - *630 - type: object properties: pattern_name: @@ -90064,8 +89386,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *327 - - *328 + - *325 + - *326 - *48 - name: sort description: The property to sort the results by. @@ -90109,9 +89431,9 @@ paths: application/json: schema: type: array - items: *635 + items: *631 examples: - default: *636 + default: *632 '400': *14 '404': *6 x-github: @@ -90134,8 +89456,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -90295,9 +89617,9 @@ paths: description: Response content: application/json: - schema: *635 + schema: *631 examples: - default: &638 + default: &634 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -90530,8 +89852,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -90635,7 +89957,7 @@ paths: description: Response content: application/json: - schema: *635 + schema: *631 examples: default: value: @@ -90782,17 +90104,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *327 - - *328 - - *637 + - *325 + - *326 + - *633 responses: '200': description: Response content: application/json: - schema: *635 + schema: *631 examples: - default: *638 + default: *634 '403': *29 '404': *6 x-github: @@ -90816,9 +90138,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *327 - - *328 - - *637 + - *325 + - *326 + - *633 requestBody: required: true content: @@ -90977,10 +90299,10 @@ paths: description: Response content: application/json: - schema: *635 + schema: *631 examples: - default: *638 - add_credit: *638 + default: *634 + add_credit: *634 '403': *29 '404': *6 '422': @@ -91018,9 +90340,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *327 - - *328 - - *637 + - *325 + - *326 + - *633 responses: '202': *39 '400': *14 @@ -91047,17 +90369,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *327 - - *328 - - *637 + - *325 + - *326 + - *633 responses: '202': description: Response content: application/json: - schema: *333 + schema: *328 examples: - default: *335 + default: *330 '400': *14 '422': *15 '403': *29 @@ -91083,8 +90405,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -91183,8 +90505,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -91193,7 +90515,7 @@ paths: application/json: schema: type: array - items: &639 + items: &635 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -91226,8 +90548,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -91303,8 +90625,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -91400,8 +90722,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -91555,8 +90877,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -91566,7 +90888,7 @@ paths: application/json: schema: type: array - items: *639 + items: *635 examples: default: value: @@ -91599,8 +90921,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *327 - - *328 + - *325 + - *326 - name: sha in: path required: true @@ -91654,7 +90976,7 @@ paths: description: Response content: application/json: - schema: *640 + schema: *636 examples: default: value: @@ -91708,8 +91030,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -91741,14 +91063,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &641 + schema: &637 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -91816,8 +91138,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: false content: @@ -91843,7 +91165,7 @@ paths: description: Response content: application/json: - schema: *641 + schema: *637 examples: default: value: @@ -91870,8 +91192,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -91891,8 +91213,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -91971,8 +91293,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -91980,7 +91302,7 @@ paths: application/json: schema: type: array - items: &642 + items: &638 title: Tag protection description: Tag protection type: object @@ -92032,8 +91354,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -92056,7 +91378,7 @@ paths: description: Response content: application/json: - schema: *642 + schema: *638 examples: default: value: @@ -92087,8 +91409,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -92125,8 +91447,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *327 - - *328 + - *325 + - *326 - name: ref in: path required: true @@ -92162,8 +91484,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -92195,8 +91517,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *327 - - *328 + - *325 + - *326 - *19 - *17 responses: @@ -92204,7 +91526,7 @@ paths: description: Response content: application/json: - schema: &643 + schema: &639 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -92216,7 +91538,7 @@ paths: required: - names examples: - default: &644 + default: &640 value: names: - octocat @@ -92239,8 +91561,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -92271,9 +91593,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *639 examples: - default: *644 + default: *640 '404': *6 '422': *7 x-github: @@ -92294,9 +91616,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *327 - - *328 - - &645 + - *325 + - *326 + - &641 name: per description: The time frame to display results for. in: query @@ -92325,7 +91647,7 @@ paths: example: 128 clones: type: array - items: &646 + items: &642 title: Traffic type: object properties: @@ -92412,8 +91734,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -92503,8 +91825,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -92564,9 +91886,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *327 - - *328 - - *645 + - *325 + - *326 + - *641 responses: '200': description: Response @@ -92585,7 +91907,7 @@ paths: example: 3782 views: type: array - items: *646 + items: *642 required: - uniques - count @@ -92662,8 +91984,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -92937,8 +92259,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -92961,8 +92283,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -92984,8 +92306,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -93011,8 +92333,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *327 - - *328 + - *325 + - *326 - name: ref in: path required: true @@ -93104,9 +92426,9 @@ paths: description: Response content: application/json: - schema: *333 + schema: *328 examples: - default: *335 + default: *330 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -93354,7 +92676,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &647 + text_matches: &643 title: Search Result Text Matches type: array items: @@ -93516,7 +92838,7 @@ paths: enum: - author-date - committer-date - - &648 + - &644 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -93587,7 +92909,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *393 + properties: *388 nullable: true comment_count: type: integer @@ -93607,7 +92929,7 @@ paths: url: type: string format: uri - verification: *509 + verification: *504 required: - author - committer @@ -93626,7 +92948,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *393 + properties: *388 nullable: true parents: type: array @@ -93644,7 +92966,7 @@ paths: type: number node_id: type: string - text_matches: *647 + text_matches: *643 required: - sha - node_id @@ -93836,7 +93158,7 @@ paths: - interactions - created - updated - - *648 + - *644 - *17 - *19 - name: advanced_search @@ -93933,11 +93255,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: type: string state_reason: @@ -93969,7 +93291,7 @@ paths: type: string format: date-time nullable: true - text_matches: *647 + text_matches: *643 pull_request: type: object properties: @@ -94194,7 +93516,7 @@ paths: enum: - created - updated - - *648 + - *644 - *17 - *19 responses: @@ -94238,7 +93560,7 @@ paths: nullable: true score: type: number - text_matches: *647 + text_matches: *643 required: - id - node_id @@ -94323,7 +93645,7 @@ paths: - forks - help-wanted-issues - updated - - *648 + - *644 - *17 - *19 responses: @@ -94562,7 +93884,7 @@ paths: - admin - pull - push - text_matches: *647 + text_matches: *643 temp_clone_token: type: string allow_merge_commit: @@ -94862,7 +94184,7 @@ paths: type: string format: uri nullable: true - text_matches: *647 + text_matches: *643 related: type: array nullable: true @@ -95053,7 +94375,7 @@ paths: - followers - repositories - joined - - *648 + - *644 - *17 - *19 responses: @@ -95157,7 +94479,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *647 + text_matches: *643 blog: type: string nullable: true @@ -95236,7 +94558,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &652 + - &648 name: team_id description: The unique identifier of the team. in: path @@ -95277,7 +94599,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *652 + - *648 requestBody: required: true content: @@ -95377,7 +94699,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *652 + - *648 responses: '204': description: Response @@ -95408,7 +94730,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *652 + - *648 - *48 - *17 - *19 @@ -95421,7 +94743,7 @@ paths: type: array items: *314 examples: - default: *653 + default: *649 headers: Link: *54 x-github: @@ -95450,7 +94772,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *652 + - *648 requestBody: required: true content: @@ -95513,7 +94835,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *652 + - *648 - *316 responses: '200': @@ -95547,7 +94869,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *652 + - *648 - *316 requestBody: required: false @@ -95573,7 +94895,7 @@ paths: application/json: schema: *314 examples: - default: *654 + default: *650 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95598,7 +94920,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *652 + - *648 - *316 responses: '204': @@ -95628,7 +94950,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *652 + - *648 - *316 - *48 - *17 @@ -95642,7 +94964,7 @@ paths: type: array items: *317 examples: - default: *655 + default: *651 headers: Link: *54 x-github: @@ -95671,7 +94993,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *652 + - *648 - *316 requestBody: required: true @@ -95723,7 +95045,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *652 + - *648 - *316 - *319 responses: @@ -95758,7 +95080,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *652 + - *648 - *316 - *319 requestBody: @@ -95784,7 +95106,7 @@ paths: application/json: schema: *317 examples: - default: *656 + default: *652 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95809,7 +95131,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *652 + - *648 - *316 - *319 responses: @@ -95840,7 +95162,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *652 + - *648 - *316 - *319 - name: content @@ -95899,7 +95221,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *652 + - *648 - *316 - *319 requestBody: @@ -95961,7 +95283,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *652 + - *648 - *316 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -96019,7 +95341,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *652 + - *648 - *316 requestBody: required: true @@ -96078,7 +95400,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *652 + - *648 - *17 - *19 responses: @@ -96116,7 +95438,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *652 + - *648 - name: role description: Filters members returned by their role in the team. in: query @@ -96167,7 +95489,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *652 + - *648 - *59 responses: '204': @@ -96204,7 +95526,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *652 + - *648 - *59 responses: '204': @@ -96244,7 +95566,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *652 + - *648 - *59 responses: '204': @@ -96281,7 +95603,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *652 + - *648 - *59 responses: '200': @@ -96290,7 +95612,7 @@ paths: application/json: schema: *324 examples: - response-if-user-is-a-team-maintainer: *657 + response-if-user-is-a-team-maintainer: *653 '404': *6 x-github: githubCloudOnly: false @@ -96323,7 +95645,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *652 + - *648 - *59 requestBody: required: false @@ -96351,7 +95673,7 @@ paths: application/json: schema: *324 examples: - response-if-users-membership-with-team-is-now-pending: *658 + response-if-users-membership-with-team-is-now-pending: *654 '403': description: Forbidden if team synchronization is set up '422': @@ -96385,7 +95707,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *652 + - *648 - *59 responses: '204': @@ -96400,174 +95722,6 @@ paths: category: teams subcategory: members deprecated: true - "/teams/{team_id}/projects": - get: - summary: List team projects (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/list-projects-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy - parameters: - - *652 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *325 - examples: - default: *659 - headers: - Link: *54 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - "/teams/{team_id}/projects/{project_id}": - get: - summary: Check team permissions for a project (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/check-permissions-for-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy - parameters: - - *652 - - *326 - responses: - '200': - description: Response - content: - application/json: - schema: *325 - examples: - default: *660 - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - put: - summary: Add or update team project permissions (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/add-or-update-project-permissions-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy - parameters: - - *652 - - *326 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - examples: - default: - summary: Example of setting permission to read - value: - permission: read - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - delete: - summary: Remove a project from a team (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/remove-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy - parameters: - - *652 - - *326 - responses: - '204': - description: Response - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true "/teams/{team_id}/repos": get: summary: List team repositories (Legacy) @@ -96581,7 +95735,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *652 + - *648 - *17 - *19 responses: @@ -96623,15 +95777,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *652 - - *327 - - *328 + - *648 + - *325 + - *326 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *661 + schema: *655 examples: alternative-response-with-extra-repository-information: value: @@ -96782,9 +95936,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *652 - - *327 - - *328 + - *648 + - *325 + - *326 requestBody: required: false content: @@ -96834,9 +95988,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *652 - - *327 - - *328 + - *648 + - *325 + - *326 responses: '204': description: Response @@ -96861,7 +96015,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *652 + - *648 - *17 - *19 responses: @@ -96873,7 +96027,7 @@ paths: type: array items: *181 examples: - response-if-child-teams-exist: *662 + response-if-child-teams-exist: *656 headers: Link: *54 '404': *6 @@ -96906,7 +96060,7 @@ paths: application/json: schema: oneOf: - - &664 + - &658 title: Private User description: Private User type: object @@ -97109,7 +96263,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *663 + - *657 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -97262,7 +96416,7 @@ paths: description: Response content: application/json: - schema: *664 + schema: *658 examples: default: value: @@ -97608,7 +96762,7 @@ paths: application/json: schema: *224 examples: - default: *447 + default: *442 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -97616,7 +96770,7 @@ paths: application/json: schema: *224 examples: - default: *447 + default: *442 '401': *25 '403': *29 '404': *6 @@ -97660,7 +96814,7 @@ paths: type: integer secrets: type: array - items: &665 + items: &659 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -97700,7 +96854,7 @@ paths: - visibility - selected_repositories_url examples: - default: *450 + default: *445 headers: Link: *54 x-github: @@ -97776,7 +96930,7 @@ paths: description: Response content: application/json: - schema: *665 + schema: *659 examples: default: value: @@ -97922,7 +97076,7 @@ paths: type: array items: *143 examples: - default: *666 + default: *660 '401': *25 '403': *29 '404': *6 @@ -98074,7 +97228,7 @@ paths: application/json: schema: *224 examples: - default: *447 + default: *442 '304': *37 '500': *103 '401': *25 @@ -98132,7 +97286,7 @@ paths: application/json: schema: *224 examples: - default: *447 + default: *442 '401': *25 '403': *29 '404': *6 @@ -98189,7 +97343,7 @@ paths: description: Response content: application/json: - schema: &667 + schema: &661 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -98230,7 +97384,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &668 + default: &662 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -98275,9 +97429,9 @@ paths: description: Response content: application/json: - schema: *667 + schema: *661 examples: - default: *668 + default: *662 '404': *6 x-github: githubCloudOnly: false @@ -98314,9 +97468,9 @@ paths: type: integer machines: type: array - items: *669 + items: *663 examples: - default: *670 + default: *664 '304': *37 '500': *103 '401': *25 @@ -98395,13 +97549,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *333 + repository: *328 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *448 - required: *449 + properties: *443 + required: *444 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -99183,7 +98337,7 @@ paths: application/json: schema: *224 examples: - default: *447 + default: *442 '304': *37 '500': *103 '400': *14 @@ -99223,7 +98377,7 @@ paths: application/json: schema: *224 examples: - default: *447 + default: *442 '500': *103 '401': *25 '403': *29 @@ -99255,7 +98409,7 @@ paths: type: array items: *237 examples: - default: &681 + default: &675 value: - id: 197 name: hello_docker @@ -99356,7 +98510,7 @@ paths: application/json: schema: type: array - items: &671 + items: &665 title: Email description: Email type: object @@ -99421,9 +98575,9 @@ paths: application/json: schema: type: array - items: *671 + items: *665 examples: - default: &683 + default: &677 value: - email: octocat@github.com verified: true @@ -99498,7 +98652,7 @@ paths: application/json: schema: type: array - items: *671 + items: *665 examples: default: value: @@ -99754,7 +98908,7 @@ paths: application/json: schema: type: array - items: &672 + items: &666 title: GPG Key description: A unique encryption key type: object @@ -99885,7 +99039,7 @@ paths: - subkeys - revoked examples: - default: &697 + default: &691 value: - id: 3 name: Octocat's GPG Key @@ -99970,9 +99124,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *666 examples: - default: &673 + default: &667 value: id: 3 name: Octocat's GPG Key @@ -100029,7 +99183,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &674 + - &668 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -100041,9 +99195,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *666 examples: - default: *673 + default: *667 '404': *6 '304': *37 '403': *29 @@ -100066,7 +99220,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *674 + - *668 responses: '204': description: Response @@ -100371,7 +99525,7 @@ paths: required: true content: application/json: - schema: *520 + schema: *515 examples: default: value: @@ -100521,7 +99675,7 @@ paths: application/json: schema: type: array - items: &675 + items: &669 title: Key description: Key type: object @@ -100622,9 +99776,9 @@ paths: description: Response content: application/json: - schema: *675 + schema: *669 examples: - default: &676 + default: &670 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -100657,15 +99811,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *550 + - *545 responses: '200': description: Response content: application/json: - schema: *675 + schema: *669 examples: - default: *676 + default: *670 '404': *6 '304': *37 '403': *29 @@ -100688,7 +99842,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *550 + - *545 responses: '204': description: Response @@ -100721,7 +99875,7 @@ paths: application/json: schema: type: array - items: &677 + items: &671 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -100789,7 +99943,7 @@ paths: - account - plan examples: - default: &678 + default: &672 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -100851,9 +100005,9 @@ paths: application/json: schema: type: array - items: *677 + items: *671 examples: - default: *678 + default: *672 headers: Link: *54 '304': *37 @@ -101848,7 +101002,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *231 - - *679 + - *673 responses: '204': description: Response @@ -101963,7 +101117,7 @@ paths: - docker - nuget - container - - *680 + - *674 - *19 - *17 responses: @@ -101975,8 +101129,8 @@ paths: type: array items: *237 examples: - default: *681 - '400': *682 + default: *675 + '400': *676 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -102005,7 +101159,7 @@ paths: application/json: schema: *237 examples: - default: &698 + default: &692 value: id: 40201 name: octo-name @@ -102367,9 +101521,9 @@ paths: application/json: schema: type: array - items: *671 + items: *665 examples: - default: *683 + default: *677 headers: Link: *54 '304': *37 @@ -102482,7 +101636,7 @@ paths: type: array items: *66 examples: - default: &690 + default: &684 summary: Default response value: - id: 1296269 @@ -102786,9 +101940,9 @@ paths: description: Response content: application/json: - schema: *333 + schema: *328 examples: - default: *335 + default: *330 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -102826,9 +101980,9 @@ paths: application/json: schema: type: array - items: *522 + items: *517 examples: - default: *684 + default: *678 headers: Link: *54 '304': *37 @@ -102907,7 +102061,7 @@ paths: application/json: schema: type: array - items: &685 + items: &679 title: Social account description: Social media account type: object @@ -102922,7 +102076,7 @@ paths: - provider - url examples: - default: &686 + default: &680 value: - provider: twitter url: https://twitter.com/github @@ -102984,9 +102138,9 @@ paths: application/json: schema: type: array - items: *685 + items: *679 examples: - default: *686 + default: *680 '422': *15 '304': *37 '404': *6 @@ -103073,7 +102227,7 @@ paths: application/json: schema: type: array - items: &687 + items: &681 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -103093,7 +102247,7 @@ paths: - title - created_at examples: - default: &706 + default: &700 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -103157,9 +102311,9 @@ paths: description: Response content: application/json: - schema: *687 + schema: *681 examples: - default: &688 + default: &682 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -103189,7 +102343,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &689 + - &683 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -103201,9 +102355,9 @@ paths: description: Response content: application/json: - schema: *687 + schema: *681 examples: - default: *688 + default: *682 '404': *6 '304': *37 '403': *29 @@ -103226,7 +102380,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *689 + - *683 responses: '204': description: Response @@ -103255,7 +102409,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &707 + - &701 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -103280,11 +102434,11 @@ paths: type: array items: *66 examples: - default-response: *690 + default-response: *684 application/vnd.github.v3.star+json: schema: type: array - items: &708 + items: &702 title: Starred Repository description: Starred Repository type: object @@ -103440,8 +102594,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response if this repository is starred by you @@ -103469,8 +102623,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -103494,8 +102648,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -103653,10 +102807,10 @@ paths: application/json: schema: oneOf: - - *664 - - *663 + - *658 + - *657 examples: - default-response: &692 + default-response: &686 summary: Default response value: login: octocat @@ -103691,7 +102845,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &693 + response-with-git-hub-plan-information: &687 summary: Response with GitHub plan information value: login: octocat @@ -103813,7 +102967,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *691 + - *685 - *17 responses: '200': @@ -103862,11 +103016,11 @@ paths: application/json: schema: oneOf: - - *664 - - *663 + - *658 + - *657 examples: - default-response: *692 - response-with-git-hub-plan-information: *693 + default-response: *686 + response-with-git-hub-plan-information: *687 '404': *6 x-github: githubCloudOnly: false @@ -103916,8 +103070,8 @@ paths: required: - subject_digests examples: - default: *694 - withPredicateType: *695 + default: *688 + withPredicateType: *689 responses: '200': description: Response @@ -103970,7 +103124,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *696 + default: *690 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104175,7 +103329,7 @@ paths: initiator: type: string examples: - default: *389 + default: *384 '201': description: Response content: @@ -104216,7 +103370,7 @@ paths: type: array items: *237 examples: - default: *681 + default: *675 '403': *29 '401': *25 x-github: @@ -104600,9 +103754,9 @@ paths: application/json: schema: type: array - items: *672 + items: *666 examples: - default: *697 + default: *691 headers: Link: *54 x-github: @@ -104706,7 +103860,7 @@ paths: application/json: schema: *22 examples: - default: *519 + default: *514 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104830,7 +103984,7 @@ paths: - docker - nuget - container - - *680 + - *674 - *59 - *19 - *17 @@ -104843,10 +103997,10 @@ paths: type: array items: *237 examples: - default: *681 + default: *675 '403': *29 '401': *25 - '400': *682 + '400': *676 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104876,7 +104030,7 @@ paths: application/json: schema: *237 examples: - default: *698 + default: *692 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105225,7 +104379,7 @@ paths: type: array items: *259 examples: - default: *699 + default: *693 headers: Link: *54 '304': *37 @@ -105236,6 +104390,257 @@ paths: enabledForGitHubApps: true category: projects subcategory: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project + parameters: + - *59 + - *255 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + - single_select + - iteration + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + iteration_configuration: + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: The duration of the iteration in days. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + properties: + title: + type: string + description: The title for the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + required: + - name + - data_type + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + iteration_field: + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + responses: + '201': + description: Response + content: + application/json: + schema: *259 + examples: + text_field: + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + number_field: + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + date_field: + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + single_select_field: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + iteration_field: + value: + id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' + '304': *37 + '403': *29 + '401': *25 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields "/users/{username}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for user @@ -105248,7 +104653,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *255 - - *700 + - *694 - *59 responses: '200': @@ -105257,7 +104662,7 @@ paths: application/json: schema: *259 examples: - default: *701 + default: *695 headers: Link: *54 '304': *37 @@ -105788,7 +105193,7 @@ paths: - *106 - *108 - *107 - - *702 + - *696 - *109 responses: '200': @@ -105919,7 +105324,7 @@ paths: parameters: - *59 - *106 - - *703 + - *697 - *107 responses: '200': @@ -106018,9 +105423,9 @@ paths: - *106 - *108 - *107 - - *704 + - *698 - *109 - - *705 + - *699 responses: '200': description: Response when getting a billing usage summary @@ -106154,9 +105559,9 @@ paths: application/json: schema: type: array - items: *685 + items: *679 examples: - default: *686 + default: *680 headers: Link: *54 x-github: @@ -106186,9 +105591,9 @@ paths: application/json: schema: type: array - items: *687 + items: *681 examples: - default: *706 + default: *700 headers: Link: *54 x-github: @@ -106213,7 +105618,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *59 - - *707 + - *701 - *48 - *17 - *19 @@ -106225,11 +105630,11 @@ paths: schema: anyOf: - type: array - items: *708 + items: *702 - type: array items: *66 examples: - default-response: *690 + default-response: *684 headers: Link: *54 x-github: @@ -106388,7 +105793,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &709 + enterprise: &703 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -106446,7 +105851,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &710 + installation: &704 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -106465,7 +105870,7 @@ x-webhooks: required: - id - node_id - organization: &711 + organization: &705 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -106525,13 +105930,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &712 + repository: &706 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &742 + properties: &736 id: description: Unique identifier of the repository example: 42 @@ -107214,7 +106619,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &743 + required: &737 - archive_url - assignees_url - blobs_url @@ -107365,10 +106770,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -107444,11 +106849,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - rule: &713 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + rule: &707 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -107671,11 +107076,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - rule: *713 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + rule: *707 sender: *4 required: - action @@ -107858,11 +107263,11 @@ x-webhooks: - everyone required: - from - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - rule: *713 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + rule: *707 sender: *4 required: - action @@ -107946,7 +107351,7 @@ x-webhooks: type: string enum: - completed - check_run: &715 + check_run: &709 title: CheckRun description: A check performed on the code of a given code change type: object @@ -107999,7 +107404,7 @@ x-webhooks: type: string pull_requests: type: array - items: *406 + items: *401 repository: *143 status: example: completed @@ -108037,7 +107442,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *714 + deployment: *708 details_url: example: https://example.com type: string @@ -108087,7 +107492,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *406 + items: *401 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -108122,10 +107527,10 @@ x-webhooks: - output - app - pull_requests - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + installation: *704 + enterprise: *703 + organization: *705 + repository: *706 sender: *4 required: - check_run @@ -108518,11 +107923,11 @@ x-webhooks: type: string enum: - created - check_run: *715 - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + check_run: *709 + installation: *704 + enterprise: *703 + organization: *705 + repository: *706 sender: *4 required: - check_run @@ -108918,11 +108323,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *715 - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + check_run: *709 + installation: *704 + enterprise: *703 + organization: *705 + repository: *706 requested_action: description: The action requested by the user. type: object @@ -109327,11 +108732,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *715 - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + check_run: *709 + installation: *704 + enterprise: *703 + organization: *705 + repository: *706 sender: *4 required: - check_run @@ -110308,10 +109713,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -110584,6 +109989,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -110996,10 +110406,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -111267,6 +110677,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -111678,10 +111093,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -111847,7 +111262,7 @@ x-webhooks: required: - login - id - dismissed_comment: *422 + dismissed_comment: *417 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -111992,20 +111407,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &716 + commit_oid: &710 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *709 - installation: *710 - organization: *711 - ref: &717 + enterprise: *703 + installation: *704 + organization: *705 + ref: &711 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *712 + repository: *706 sender: *4 required: - action @@ -112170,7 +111585,7 @@ x-webhooks: required: - login - id - dismissed_comment: *422 + dismissed_comment: *417 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -112400,12 +111815,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *710 + enterprise: *703 + installation: *704 + organization: *705 + ref: *711 + repository: *706 sender: *4 required: - action @@ -112500,7 +111915,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *422 + dismissed_comment: *417 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -112671,12 +112086,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *710 + enterprise: *703 + installation: *704 + organization: *705 + ref: *711 + repository: *706 sender: *4 required: - action @@ -112842,7 +112257,7 @@ x-webhooks: required: - login - id - dismissed_comment: *422 + dismissed_comment: *417 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -113008,12 +112423,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *710 + enterprise: *703 + installation: *704 + organization: *705 + ref: *711 + repository: *706 sender: *4 required: - action @@ -113113,7 +112528,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *422 + dismissed_comment: *417 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -113281,16 +112696,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *712 + repository: *706 sender: *4 required: - action @@ -113387,7 +112802,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *422 + dismissed_comment: *417 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -113527,12 +112942,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *710 + enterprise: *703 + installation: *704 + organization: *705 + ref: *711 + repository: *706 sender: *4 required: - action @@ -113789,10 +113204,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -113872,18 +113287,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *711 - pusher_type: &718 + organization: *705 + pusher_type: &712 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &719 + ref: &713 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -113893,7 +113308,7 @@ x-webhooks: enum: - tag - branch - repository: *712 + repository: *706 sender: *4 required: - ref @@ -113976,9 +113391,9 @@ x-webhooks: enum: - created definition: *266 - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 sender: *4 required: - action @@ -114063,9 +113478,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 sender: *4 required: - action @@ -114143,9 +113558,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *266 - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 sender: *4 required: - action @@ -114223,9 +113638,9 @@ x-webhooks: enum: - updated definition: *266 - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 sender: *4 required: - action @@ -114302,10 +113717,10 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - repository: *712 - organization: *711 + enterprise: *703 + installation: *704 + repository: *706 + organization: *705 sender: *4 new_property_values: type: array @@ -114390,18 +113805,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - pusher_type: *718 - ref: *719 + enterprise: *703 + installation: *704 + organization: *705 + pusher_type: *712 + ref: *713 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *712 + repository: *706 sender: *4 required: - ref @@ -114485,11 +113900,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *473 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *4 required: - action @@ -114573,11 +113988,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *473 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *4 required: - action @@ -114661,11 +114076,11 @@ x-webhooks: type: string enum: - created - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *473 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *4 required: - action @@ -114747,11 +114162,11 @@ x-webhooks: type: string enum: - dismissed - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *473 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *4 required: - action @@ -114833,11 +114248,11 @@ x-webhooks: type: string enum: - fixed - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *473 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *4 required: - action @@ -114920,11 +114335,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *473 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *4 required: - action @@ -115006,11 +114421,11 @@ x-webhooks: type: string enum: - reopened - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *473 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *4 required: - action @@ -115087,9 +114502,9 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - key: &720 + enterprise: *703 + installation: *704 + key: &714 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -115125,8 +114540,8 @@ x-webhooks: - verified - created_at - read_only - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -115203,11 +114618,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - key: *720 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + key: *714 + organization: *705 + repository: *706 sender: *4 required: - action @@ -115768,12 +115183,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - workflow: &724 + workflow: &718 title: Workflow type: object nullable: true @@ -116499,13 +115914,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *484 + deployment: *479 pull_requests: type: array - items: *571 - repository: *712 - organization: *711 - installation: *710 + items: *566 + repository: *706 + organization: *705 + installation: *704 sender: *4 responses: '200': @@ -116576,7 +115991,7 @@ x-webhooks: type: string enum: - approved - approver: &721 + approver: &715 type: object properties: avatar_url: @@ -116619,11 +116034,11 @@ x-webhooks: type: string comment: type: string - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - reviewers: &722 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + reviewers: &716 type: array items: type: object @@ -116702,7 +116117,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &723 + workflow_job_run: &717 type: object properties: conclusion: @@ -117433,18 +116848,18 @@ x-webhooks: type: string enum: - rejected - approver: *721 + approver: *715 comment: type: string - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - reviewers: *722 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + reviewers: *716 sender: *4 since: type: string - workflow_job_run: *723 + workflow_job_run: *717 workflow_job_runs: type: array items: @@ -118148,13 +117563,13 @@ x-webhooks: type: string enum: - requested - enterprise: *709 + enterprise: *703 environment: type: string - installation: *710 - organization: *711 - repository: *712 - requestor: &729 + installation: *704 + organization: *705 + repository: *706 + requestor: &723 title: User type: object nullable: true @@ -120053,12 +119468,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - workflow: *724 + workflow: *718 workflow_run: title: Deployment Workflow Run type: object @@ -120738,7 +120153,7 @@ x-webhooks: type: string enum: - answered - answer: &727 + answer: &721 type: object properties: author_association: @@ -120895,7 +120310,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &725 + discussion: &719 title: Discussion description: A Discussion in a repository. type: object @@ -121181,7 +120596,7 @@ x-webhooks: - id labels: type: array - items: *533 + items: *528 required: - repository_url - category @@ -121203,10 +120618,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -121333,11 +120748,11 @@ x-webhooks: - from required: - category - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -121420,11 +120835,11 @@ x-webhooks: type: string enum: - closed - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -121506,7 +120921,7 @@ x-webhooks: type: string enum: - created - comment: &726 + comment: &720 type: object properties: author_association: @@ -121663,11 +121078,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -121750,12 +121165,12 @@ x-webhooks: type: string enum: - deleted - comment: *726 - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + comment: *720 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -121850,12 +121265,12 @@ x-webhooks: - from required: - body - comment: *726 - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + comment: *720 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -121939,11 +121354,11 @@ x-webhooks: type: string enum: - created - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122025,11 +121440,11 @@ x-webhooks: type: string enum: - deleted - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122129,11 +121544,11 @@ x-webhooks: type: string required: - from - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122215,10 +121630,10 @@ x-webhooks: type: string enum: - labeled - discussion: *725 - enterprise: *709 - installation: *710 - label: &728 + discussion: *719 + enterprise: *703 + installation: *704 + label: &722 title: Label type: object properties: @@ -122250,8 +121665,8 @@ x-webhooks: - color - default - description - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122334,11 +121749,11 @@ x-webhooks: type: string enum: - locked - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122420,11 +121835,11 @@ x-webhooks: type: string enum: - pinned - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122506,11 +121921,11 @@ x-webhooks: type: string enum: - reopened - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122595,16 +122010,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *725 - new_repository: *712 + new_discussion: *719 + new_repository: *706 required: - new_discussion - new_repository - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122687,10 +122102,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *725 - old_answer: *727 - organization: *711 - repository: *712 + discussion: *719 + old_answer: *721 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122772,12 +122187,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *725 - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + label: *722 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122860,11 +122275,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122946,11 +122361,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -123023,7 +122438,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *709 + enterprise: *703 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -123683,9 +123098,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *710 - organization: *711 - repository: *712 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - forkee @@ -123831,9 +123246,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 pages: description: The pages that were updated. type: array @@ -123870,7 +123285,7 @@ x-webhooks: - action - sha - html_url - repository: *712 + repository: *706 sender: *4 required: - pages @@ -123946,10 +123361,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 + enterprise: *703 installation: *22 - organization: *711 - repositories: &730 + organization: *705 + repositories: &724 description: An array of repository objects that the installation can access. type: array @@ -123975,8 +123390,8 @@ x-webhooks: - name - full_name - private - repository: *712 - requester: *729 + repository: *706 + requester: *723 sender: *4 required: - action @@ -124051,11 +123466,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 + enterprise: *703 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *705 + repositories: *724 + repository: *706 requester: nullable: true sender: *4 @@ -124131,11 +123546,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *709 + enterprise: *703 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *705 + repositories: *724 + repository: *706 requester: nullable: true sender: *4 @@ -124211,10 +123626,10 @@ x-webhooks: type: string enum: - added - enterprise: *709 + enterprise: *703 installation: *22 - organization: *711 - repositories_added: &731 + organization: *705 + repositories_added: &725 description: An array of repository objects, which were added to the installation. type: array @@ -124260,15 +123675,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *712 - repository_selection: &732 + repository: *706 + repository_selection: &726 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *729 + requester: *723 sender: *4 required: - action @@ -124347,10 +123762,10 @@ x-webhooks: type: string enum: - removed - enterprise: *709 + enterprise: *703 installation: *22 - organization: *711 - repositories_added: *731 + organization: *705 + repositories_added: *725 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -124377,9 +123792,9 @@ x-webhooks: - name - full_name - private - repository: *712 - repository_selection: *732 - requester: *729 + repository: *706 + repository_selection: *726 + requester: *723 sender: *4 required: - action @@ -124458,11 +123873,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *709 + enterprise: *703 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *705 + repositories: *724 + repository: *706 requester: nullable: true sender: *4 @@ -124640,10 +124055,10 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 target_type: type: string @@ -124722,11 +124137,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *709 + enterprise: *703 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *705 + repositories: *724 + repository: *706 requester: nullable: true sender: *4 @@ -124978,8 +124393,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -125773,8 +125188,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 state: description: State of the issue; either 'open' or 'closed' type: string @@ -126123,8 +125538,8 @@ x-webhooks: - state - locked - assignee - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -126204,7 +125619,7 @@ x-webhooks: type: string enum: - deleted - comment: &733 + comment: &727 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -126369,8 +125784,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -127160,8 +126575,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 state: description: State of the issue; either 'open' or 'closed' type: string @@ -127512,8 +126927,8 @@ x-webhooks: - state - locked - assignee - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -127593,7 +127008,7 @@ x-webhooks: type: string enum: - edited - changes: &762 + changes: &756 description: The changes to the comment. type: object properties: @@ -127605,9 +127020,9 @@ x-webhooks: type: string required: - from - comment: *733 - enterprise: *709 - installation: *710 + comment: *727 + enterprise: *703 + installation: *704 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -128400,8 +127815,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128750,8 +128165,8 @@ x-webhooks: - state - locked - assignee - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -128841,9 +128256,9 @@ x-webhooks: type: number blocking_issue: *82 blocking_issue_repo: *66 - installation: *710 - organization: *711 - repository: *712 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -128937,9 +128352,9 @@ x-webhooks: type: number blocking_issue: *82 blocking_issue_repo: *66 - installation: *710 - organization: *711 - repository: *712 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -129032,9 +128447,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -129128,9 +128543,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -129215,10 +128630,10 @@ x-webhooks: type: string enum: - assigned - assignee: *729 - enterprise: *709 - installation: *710 - issue: &736 + assignee: *723 + enterprise: *703 + installation: *704 + issue: &730 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -130007,11 +129422,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130128,8 +129543,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -130209,8 +129624,8 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -131004,11 +130419,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131260,8 +130675,8 @@ x-webhooks: required: - state - closed_at - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -131340,8 +130755,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -132126,11 +131541,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132246,8 +131661,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -132326,8 +131741,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -133134,11 +132549,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133233,7 +132648,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &734 + milestone: &728 title: Milestone description: A collection of related issues and pull requests. type: object @@ -133371,8 +132786,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -133471,8 +132886,8 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -134261,11 +133676,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134382,9 +133797,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *728 - organization: *711 - repository: *712 + label: *722 + organization: *705 + repository: *706 sender: *4 required: - action @@ -134464,8 +133879,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135253,11 +134668,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135374,9 +134789,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *728 - organization: *711 - repository: *712 + label: *722 + organization: *705 + repository: *706 sender: *4 required: - action @@ -135456,8 +134871,8 @@ x-webhooks: type: string enum: - locked - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136269,11 +135684,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136367,8 +135782,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -136447,8 +135862,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -137254,11 +136669,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137352,9 +136767,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *734 - organization: *711 - repository: *712 + milestone: *728 + organization: *705 + repository: *706 sender: *4 required: - action @@ -138222,11 +137637,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138788,8 +138203,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139578,11 +138993,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139698,8 +139113,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -139779,9 +139194,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *709 - installation: *710 - issue: &735 + enterprise: *703 + installation: *704 + issue: &729 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -140564,11 +139979,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140684,8 +140099,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -140764,8 +140179,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141575,11 +140990,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141674,8 +141089,8 @@ x-webhooks: user_view_type: type: string type: *219 - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -142541,11 +141956,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143129,11 +142544,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *709 - installation: *710 - issue: *735 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + issue: *729 + organization: *705 + repository: *706 sender: *4 required: - action @@ -143213,12 +142628,12 @@ x-webhooks: type: string enum: - typed - enterprise: *709 - installation: *710 - issue: *736 + enterprise: *703 + installation: *704 + issue: *730 type: *219 - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -143299,7 +142714,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &765 + assignee: &759 title: User type: object nullable: true @@ -143369,11 +142784,11 @@ x-webhooks: required: - login - id - enterprise: *709 - installation: *710 - issue: *736 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + issue: *730 + organization: *705 + repository: *706 sender: *4 required: - action @@ -143452,12 +142867,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *709 - installation: *710 - issue: *736 - label: *728 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + issue: *730 + label: *722 + organization: *705 + repository: *706 sender: *4 required: - action @@ -143537,8 +142952,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144348,11 +143763,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144446,8 +143861,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -144527,11 +143942,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *709 - installation: *710 - issue: *735 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + issue: *729 + organization: *705 + repository: *706 sender: *4 required: - action @@ -144610,12 +144025,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *709 - installation: *710 - issue: *736 + enterprise: *703 + installation: *704 + issue: *730 type: *219 - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -144695,11 +144110,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + label: *722 + organization: *705 + repository: *706 sender: *4 required: - action @@ -144777,11 +144192,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + label: *722 + organization: *705 + repository: *706 sender: *4 required: - action @@ -144891,11 +144306,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + label: *722 + organization: *705 + repository: *706 sender: *4 required: - action @@ -144977,9 +144392,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: &737 + enterprise: *703 + installation: *704 + marketplace_purchase: &731 title: Marketplace Purchase type: object required: @@ -145062,8 +144477,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *711 - previous_marketplace_purchase: &738 + organization: *705 + previous_marketplace_purchase: &732 title: Marketplace Purchase type: object properties: @@ -145143,7 +144558,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *712 + repository: *706 sender: *4 required: - action @@ -145223,10 +144638,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: *737 - organization: *711 + enterprise: *703 + installation: *704 + marketplace_purchase: *731 + organization: *705 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -145309,7 +144724,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *712 + repository: *706 sender: *4 required: - action @@ -145391,10 +144806,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: *737 - organization: *711 + enterprise: *703 + installation: *704 + marketplace_purchase: *731 + organization: *705 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -145476,7 +144891,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *712 + repository: *706 sender: *4 required: - action @@ -145557,8 +144972,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 marketplace_purchase: title: Marketplace Purchase type: object @@ -145640,9 +145055,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *711 - previous_marketplace_purchase: *738 - repository: *712 + organization: *705 + previous_marketplace_purchase: *732 + repository: *706 sender: *4 required: - action @@ -145722,12 +145137,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: *737 - organization: *711 - previous_marketplace_purchase: *738 - repository: *712 + enterprise: *703 + installation: *704 + marketplace_purchase: *731 + organization: *705 + previous_marketplace_purchase: *732 + repository: *706 sender: *4 required: - action @@ -145829,11 +145244,11 @@ x-webhooks: type: string required: - to - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + member: *723 + organization: *705 + repository: *706 sender: *4 required: - action @@ -145933,11 +145348,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + member: *723 + organization: *705 + repository: *706 sender: *4 required: - action @@ -146016,11 +145431,11 @@ x-webhooks: type: string enum: - removed - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + member: *723 + organization: *705 + repository: *706 sender: *4 required: - action @@ -146098,11 +145513,11 @@ x-webhooks: type: string enum: - added - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + member: *723 + organization: *705 + repository: *706 scope: description: The scope of the membership. Currently, can only be `team`. @@ -146178,7 +145593,7 @@ x-webhooks: required: - login - id - team: &739 + team: &733 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -146401,11 +145816,11 @@ x-webhooks: type: string enum: - removed - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + member: *723 + organization: *705 + repository: *706 scope: description: The scope of the membership. Currently, can only be `team`. @@ -146482,7 +145897,7 @@ x-webhooks: required: - login - id - team: *739 + team: *733 required: - action - scope @@ -146564,8 +145979,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *710 - merge_group: &741 + installation: *704 + merge_group: &735 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -146584,15 +145999,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *740 + head_commit: *734 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -146678,10 +146093,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *710 - merge_group: *741 - organization: *711 - repository: *712 + installation: *704 + merge_group: *735 + organization: *705 + repository: *706 sender: *4 required: - action @@ -146754,7 +146169,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 + enterprise: *703 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -146863,16 +146278,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *710 - organization: *711 + installation: *704 + organization: *705 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *736 + required: *737 nullable: true sender: *4 required: @@ -146953,11 +146368,11 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 - milestone: *734 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + milestone: *728 + organization: *705 + repository: *706 sender: *4 required: - action @@ -147036,9 +146451,9 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - milestone: &744 + enterprise: *703 + installation: *704 + milestone: &738 title: Milestone description: A collection of related issues and pull requests. type: object @@ -147175,8 +146590,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -147255,11 +146670,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - milestone: *734 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + milestone: *728 + organization: *705 + repository: *706 sender: *4 required: - action @@ -147369,11 +146784,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - milestone: *734 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + milestone: *728 + organization: *705 + repository: *706 sender: *4 required: - action @@ -147453,11 +146868,11 @@ x-webhooks: type: string enum: - opened - enterprise: *709 - installation: *710 - milestone: *744 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + milestone: *738 + organization: *705 + repository: *706 sender: *4 required: - action @@ -147536,11 +146951,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *729 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + blocked_user: *723 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -147619,11 +147034,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *729 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + blocked_user: *723 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -147702,9 +147117,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - membership: &745 + enterprise: *703 + installation: *704 + membership: &739 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -147811,8 +147226,8 @@ x-webhooks: - role - organization_url - user - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -147890,11 +147305,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *709 - installation: *710 - membership: *745 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + membership: *739 + organization: *705 + repository: *706 sender: *4 required: - action @@ -147973,8 +147388,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -148090,10 +147505,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 - user: *729 + user: *723 required: - action - invitation @@ -148171,11 +147586,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *709 - installation: *710 - membership: *745 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + membership: *739 + organization: *705 + repository: *706 sender: *4 required: - action @@ -148262,11 +147677,11 @@ x-webhooks: properties: from: type: string - enterprise: *709 - installation: *710 - membership: *745 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + membership: *739 + organization: *705 + repository: *706 sender: *4 required: - action @@ -148342,9 +147757,9 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 package: description: Information about the package. type: object @@ -148843,7 +148258,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &746 + items: &740 title: Ruby Gems metadata type: object properties: @@ -148938,7 +148353,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *706 sender: *4 required: - action @@ -149014,9 +148429,9 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 package: description: Information about the package. type: object @@ -149369,7 +148784,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *746 + items: *740 source_url: type: string format: uri @@ -149439,7 +148854,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *706 sender: *4 required: - action @@ -149616,12 +149031,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *709 + enterprise: *703 id: type: integer - installation: *710 - organization: *711 - repository: *712 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - id @@ -149698,7 +149113,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &747 + personal_access_token_request: &741 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -149844,10 +149259,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *709 - organization: *711 + enterprise: *703 + organization: *705 sender: *4 - installation: *710 + installation: *704 required: - action - personal_access_token_request @@ -149924,11 +149339,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *747 - enterprise: *709 - organization: *711 + personal_access_token_request: *741 + enterprise: *703 + organization: *705 sender: *4 - installation: *710 + installation: *704 required: - action - personal_access_token_request @@ -150004,11 +149419,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *747 - enterprise: *709 - organization: *711 + personal_access_token_request: *741 + enterprise: *703 + organization: *705 sender: *4 - installation: *710 + installation: *704 required: - action - personal_access_token_request @@ -150083,11 +149498,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *747 - organization: *711 - enterprise: *709 + personal_access_token_request: *741 + organization: *705 + enterprise: *703 sender: *4 - installation: *710 + installation: *704 required: - action - personal_access_token_request @@ -150192,7 +149607,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *748 + last_response: *742 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -150224,8 +149639,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 zen: description: Random string of GitHub zen. @@ -150470,10 +149885,10 @@ x-webhooks: - from required: - note - enterprise: *709 - installation: *710 - organization: *711 - project_card: &749 + enterprise: *703 + installation: *704 + organization: *705 + project_card: &743 title: Project Card type: object properties: @@ -150592,7 +150007,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *712 + repository: *706 sender: *4 required: - action @@ -150673,11 +150088,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - project_card: *749 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + project_card: *743 + repository: *706 sender: *4 required: - action @@ -150757,9 +150172,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 project_card: title: Project Card type: object @@ -150887,8 +150302,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *736 + required: *737 nullable: true sender: *4 required: @@ -150982,11 +150397,11 @@ x-webhooks: - from required: - note - enterprise: *709 - installation: *710 - organization: *711 - project_card: *749 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + project_card: *743 + repository: *706 sender: *4 required: - action @@ -151080,9 +150495,9 @@ x-webhooks: - from required: - column_id - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 project_card: allOf: - title: Project Card @@ -151272,7 +150687,7 @@ x-webhooks: type: string required: - after_id - repository: *712 + repository: *706 sender: *4 required: - action @@ -151352,10 +150767,10 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 - organization: *711 - project: &751 + enterprise: *703 + installation: *704 + organization: *705 + project: &745 title: Project type: object properties: @@ -151479,7 +150894,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *712 + repository: *706 sender: *4 required: - action @@ -151559,10 +150974,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - project_column: &750 + enterprise: *703 + installation: *704 + organization: *705 + project_column: &744 title: Project Column type: object properties: @@ -151601,7 +151016,7 @@ x-webhooks: - name - created_at - updated_at - repository: *712 + repository: *706 sender: *4 required: - action @@ -151680,18 +151095,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - project_column: *750 + enterprise: *703 + installation: *704 + organization: *705 + project_column: *744 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *736 + required: *737 nullable: true sender: *4 required: @@ -151781,11 +151196,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - project_column: *750 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + project_column: *744 + repository: *706 sender: *4 required: - action @@ -151865,11 +151280,11 @@ x-webhooks: type: string enum: - moved - enterprise: *709 - installation: *710 - organization: *711 - project_column: *750 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + project_column: *744 + repository: *706 sender: *4 required: - action @@ -151949,11 +151364,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - project: *751 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + project: *745 + repository: *706 sender: *4 required: - action @@ -152033,18 +151448,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - project: *751 + enterprise: *703 + installation: *704 + organization: *705 + project: *745 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *736 + required: *737 nullable: true sender: *4 required: @@ -152146,11 +151561,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - project: *751 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + project: *745 + repository: *706 sender: *4 required: - action @@ -152229,11 +151644,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *709 - installation: *710 - organization: *711 - project: *751 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + project: *745 + repository: *706 sender: *4 required: - action @@ -152314,8 +151729,8 @@ x-webhooks: type: string enum: - closed - installation: *710 - organization: *711 + installation: *704 + organization: *705 projects_v2: *253 sender: *4 required: @@ -152397,8 +151812,8 @@ x-webhooks: type: string enum: - created - installation: *710 - organization: *711 + installation: *704 + organization: *705 projects_v2: *253 sender: *4 required: @@ -152480,8 +151895,8 @@ x-webhooks: type: string enum: - deleted - installation: *710 - organization: *711 + installation: *704 + organization: *705 projects_v2: *253 sender: *4 required: @@ -152599,8 +152014,8 @@ x-webhooks: type: string to: type: string - installation: *710 - organization: *711 + installation: *704 + organization: *705 projects_v2: *253 sender: *4 required: @@ -152684,7 +152099,7 @@ x-webhooks: type: string enum: - archived - changes: &755 + changes: &749 type: object properties: archived_at: @@ -152698,9 +152113,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *710 - organization: *711 - projects_v2_item: &752 + installation: *704 + organization: *705 + projects_v2_item: &746 title: Projects v2 Item description: An item belonging to a project type: object @@ -152835,9 +152250,9 @@ x-webhooks: nullable: true to: type: string - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *704 + organization: *705 + projects_v2_item: *746 sender: *4 required: - action @@ -152919,9 +152334,9 @@ x-webhooks: type: string enum: - created - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *704 + organization: *705 + projects_v2_item: *746 sender: *4 required: - action @@ -153002,9 +152417,9 @@ x-webhooks: type: string enum: - deleted - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *704 + organization: *705 + projects_v2_item: *746 sender: *4 required: - action @@ -153110,7 +152525,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &753 + - &747 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -153132,7 +152547,7 @@ x-webhooks: required: - id - name - - &754 + - &748 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -153166,8 +152581,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *753 - - *754 + - *747 + - *748 required: - field_value - type: object @@ -153183,9 +152598,9 @@ x-webhooks: nullable: true required: - body - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *704 + organization: *705 + projects_v2_item: *746 sender: *4 required: - action @@ -153280,9 +152695,9 @@ x-webhooks: to: type: string nullable: true - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *704 + organization: *705 + projects_v2_item: *746 sender: *4 required: - action @@ -153365,10 +152780,10 @@ x-webhooks: type: string enum: - restored - changes: *755 - installation: *710 - organization: *711 - projects_v2_item: *752 + changes: *749 + installation: *704 + organization: *705 + projects_v2_item: *746 sender: *4 required: - action @@ -153450,8 +152865,8 @@ x-webhooks: type: string enum: - reopened - installation: *710 - organization: *711 + installation: *704 + organization: *705 projects_v2: *253 sender: *4 required: @@ -153533,14 +152948,14 @@ x-webhooks: type: string enum: - created - installation: *710 - organization: *711 - projects_v2_status_update: &758 + installation: *704 + organization: *705 + projects_v2_status_update: &752 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *756 - required: *757 + properties: *750 + required: *751 sender: *4 required: - action @@ -153621,9 +153036,9 @@ x-webhooks: type: string enum: - deleted - installation: *710 - organization: *711 - projects_v2_status_update: *758 + installation: *704 + organization: *705 + projects_v2_status_update: *752 sender: *4 required: - action @@ -153759,9 +153174,9 @@ x-webhooks: type: string format: date nullable: true - installation: *710 - organization: *711 - projects_v2_status_update: *758 + installation: *704 + organization: *705 + projects_v2_status_update: *752 sender: *4 required: - action @@ -153832,10 +153247,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - repository @@ -153912,13 +153327,13 @@ x-webhooks: type: string enum: - assigned - assignee: *729 - enterprise: *709 - installation: *710 - number: &759 + assignee: *723 + enterprise: *703 + installation: *704 + number: &753 description: The pull request number. type: integer - organization: *711 + organization: *705 pull_request: title: Pull Request type: object @@ -156201,7 +155616,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 sender: *4 required: - action @@ -156283,11 +155698,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 number: type: integer - organization: *711 + organization: *705 pull_request: title: Pull Request type: object @@ -158565,7 +157980,7 @@ x-webhooks: - draft reason: type: string - repository: *712 + repository: *706 sender: *4 required: - action @@ -158647,11 +158062,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 number: type: integer - organization: *711 + organization: *705 pull_request: title: Pull Request type: object @@ -160929,7 +160344,7 @@ x-webhooks: - draft reason: type: string - repository: *712 + repository: *706 sender: *4 required: - action @@ -161011,13 +160426,13 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: &760 + enterprise: *703 + installation: *704 + number: *753 + organization: *705 + pull_request: &754 allOf: - - *571 + - *566 - type: object properties: allow_auto_merge: @@ -161079,7 +160494,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *712 + repository: *706 sender: *4 required: - action @@ -161160,12 +160575,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *703 + installation: *704 + number: *753 + organization: *705 + pull_request: *754 + repository: *706 sender: *4 required: - action @@ -161245,11 +160660,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *709 - milestone: *553 - number: *759 - organization: *711 - pull_request: &761 + enterprise: *703 + milestone: *548 + number: *753 + organization: *705 + pull_request: &755 title: Pull Request type: object properties: @@ -163512,7 +162927,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 sender: *4 required: - action @@ -163591,11 +163006,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 number: type: integer - organization: *711 + organization: *705 pull_request: title: Pull Request type: object @@ -165877,7 +165292,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *712 + repository: *706 sender: *4 required: - action @@ -166001,12 +165416,12 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *703 + installation: *704 + number: *753 + organization: *705 + pull_request: *754 + repository: *706 sender: *4 required: - action @@ -166086,11 +165501,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 number: type: integer - organization: *711 + organization: *705 pull_request: title: Pull Request type: object @@ -168357,7 +167772,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 sender: *4 required: - action @@ -168437,11 +167852,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *709 - installation: *710 - label: *728 - number: *759 - organization: *711 + enterprise: *703 + installation: *704 + label: *722 + number: *753 + organization: *705 pull_request: title: Pull Request type: object @@ -170723,7 +170138,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 sender: *4 required: - action @@ -170804,10 +170219,10 @@ x-webhooks: type: string enum: - locked - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + enterprise: *703 + installation: *704 + number: *753 + organization: *705 pull_request: title: Pull Request type: object @@ -173087,7 +172502,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 sender: *4 required: - action @@ -173167,12 +172582,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *709 - milestone: *553 - number: *759 - organization: *711 - pull_request: *761 - repository: *712 + enterprise: *703 + milestone: *548 + number: *753 + organization: *705 + pull_request: *755 + repository: *706 sender: *4 required: - action @@ -173251,12 +172666,12 @@ x-webhooks: type: string enum: - opened - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *703 + installation: *704 + number: *753 + organization: *705 + pull_request: *754 + repository: *706 sender: *4 required: - action @@ -173337,12 +172752,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *703 + installation: *704 + number: *753 + organization: *705 + pull_request: *754 + repository: *706 sender: *4 required: - action @@ -173422,12 +172837,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *703 + installation: *704 + number: *753 + organization: *705 + pull_request: *754 + repository: *706 sender: *4 required: - action @@ -173793,9 +173208,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 pull_request: type: object properties: @@ -175965,7 +175380,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *712 + repository: *706 sender: *4 required: - action @@ -176045,7 +175460,7 @@ x-webhooks: type: string enum: - deleted - comment: &763 + comment: &757 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -176330,9 +175745,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 pull_request: type: object properties: @@ -178490,7 +177905,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *712 + repository: *706 sender: *4 required: - action @@ -178570,11 +177985,11 @@ x-webhooks: type: string enum: - edited - changes: *762 - comment: *763 - enterprise: *709 - installation: *710 - organization: *711 + changes: *756 + comment: *757 + enterprise: *703 + installation: *704 + organization: *705 pull_request: type: object properties: @@ -180735,7 +180150,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *712 + repository: *706 sender: *4 required: - action @@ -180816,9 +180231,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 pull_request: title: Simple Pull Request type: object @@ -182991,7 +182406,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 + repository: *706 review: description: The review that was affected. type: object @@ -183238,9 +182653,9 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 pull_request: title: Simple Pull Request type: object @@ -185294,8 +184709,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 - review: &764 + repository: *706 + review: &758 description: The review that was affected. type: object properties: @@ -185528,12 +184943,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 number: description: The pull request number. type: integer - organization: *711 + organization: *705 pull_request: title: Pull Request type: object @@ -187816,7 +187231,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 requested_reviewer: title: User type: object @@ -187900,12 +187315,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 number: description: The pull request number. type: integer - organization: *711 + organization: *705 pull_request: title: Pull Request type: object @@ -190195,7 +189610,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 requested_team: title: Team description: Groups of organization members that gives permissions @@ -190387,12 +189802,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 number: description: The pull request number. type: integer - organization: *711 + organization: *705 pull_request: title: Pull Request type: object @@ -192677,7 +192092,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 requested_reviewer: title: User type: object @@ -192762,12 +192177,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 number: description: The pull request number. type: integer - organization: *711 + organization: *705 pull_request: title: Pull Request type: object @@ -195043,7 +194458,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 requested_team: title: Team description: Groups of organization members that gives permissions @@ -195224,9 +194639,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 pull_request: title: Simple Pull Request type: object @@ -197401,8 +196816,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 - review: *764 + repository: *706 + review: *758 sender: *4 required: - action @@ -197482,9 +196897,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 pull_request: title: Simple Pull Request type: object @@ -199554,7 +198969,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 + repository: *706 sender: *4 thread: type: object @@ -199941,9 +199356,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 pull_request: title: Simple Pull Request type: object @@ -201999,7 +201414,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 + repository: *706 sender: *4 thread: type: object @@ -202389,10 +201804,10 @@ x-webhooks: type: string before: type: string - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + enterprise: *703 + installation: *704 + number: *753 + organization: *705 pull_request: title: Pull Request type: object @@ -204663,7 +204078,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 sender: *4 required: - action @@ -204745,11 +204160,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *765 - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + assignee: *759 + enterprise: *703 + installation: *704 + number: *753 + organization: *705 pull_request: title: Pull Request type: object @@ -207032,7 +206447,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 sender: *4 required: - action @@ -207111,11 +206526,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *709 - installation: *710 - label: *728 - number: *759 - organization: *711 + enterprise: *703 + installation: *704 + label: *722 + number: *753 + organization: *705 pull_request: title: Pull Request type: object @@ -209388,7 +208803,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 sender: *4 required: - action @@ -209469,10 +208884,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + enterprise: *703 + installation: *704 + number: *753 + organization: *705 pull_request: title: Pull Request type: object @@ -211737,7 +211152,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 sender: *4 required: - action @@ -211937,7 +211352,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *709 + enterprise: *703 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -212029,8 +211444,8 @@ x-webhooks: - url - author - committer - installation: *710 - organization: *711 + installation: *704 + organization: *705 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -212605,9 +212020,9 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 registry_package: type: object properties: @@ -213053,7 +212468,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *746 + items: *740 summary: type: string tag_name: @@ -213107,7 +212522,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *706 sender: *4 required: - action @@ -213185,9 +212600,9 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 registry_package: type: object properties: @@ -213495,7 +212910,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *746 + items: *740 summary: type: string tag_name: @@ -213544,7 +212959,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *706 sender: *4 required: - action @@ -213621,10 +213036,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - release: &766 + enterprise: *703 + installation: *704 + organization: *705 + release: &760 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -213942,7 +213357,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *712 + repository: *706 sender: *4 required: - action @@ -214019,11 +213434,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - release: *766 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + release: *760 + repository: *706 sender: *4 required: - action @@ -214140,11 +213555,11 @@ x-webhooks: type: boolean required: - to - enterprise: *709 - installation: *710 - organization: *711 - release: *766 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + release: *760 + repository: *706 sender: *4 required: - action @@ -214222,9 +213637,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -214546,7 +213961,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *712 + repository: *706 sender: *4 required: - action @@ -214622,10 +214037,10 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 - release: &767 + enterprise: *703 + installation: *704 + organization: *705 + release: &761 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -214944,7 +214359,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *712 + repository: *706 sender: *4 required: - action @@ -215020,11 +214435,11 @@ x-webhooks: type: string enum: - released - enterprise: *709 - installation: *710 - organization: *711 - release: *766 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + release: *760 + repository: *706 sender: *4 required: - action @@ -215100,11 +214515,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *709 - installation: *710 - organization: *711 - release: *767 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + release: *761 + repository: *706 sender: *4 required: - action @@ -215180,11 +214595,11 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - repository_advisory: *635 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + repository_advisory: *631 sender: *4 required: - action @@ -215260,11 +214675,11 @@ x-webhooks: type: string enum: - reported - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - repository_advisory: *635 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + repository_advisory: *631 sender: *4 required: - action @@ -215340,10 +214755,10 @@ x-webhooks: type: string enum: - archived - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -215420,10 +214835,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -215501,10 +214916,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -215588,10 +215003,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -215703,10 +215118,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -215778,10 +215193,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 status: type: string @@ -215862,10 +215277,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -215942,10 +215357,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -216039,10 +215454,10 @@ x-webhooks: - name required: - repository - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -216122,10 +215537,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 repository_ruleset: *298 sender: *4 required: @@ -216204,10 +215619,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 repository_ruleset: *298 sender: *4 required: @@ -216286,10 +215701,10 @@ x-webhooks: type: string enum: - edited - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 repository_ruleset: *298 changes: type: object @@ -216351,16 +215766,16 @@ x-webhooks: properties: added: type: array - items: *592 + items: *587 deleted: type: array - items: *592 + items: *587 updated: type: array items: type: object properties: - rule: *592 + rule: *587 changes: type: object properties: @@ -216594,10 +216009,10 @@ x-webhooks: - from required: - owner - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -216675,10 +216090,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -216756,7 +216171,7 @@ x-webhooks: type: string enum: - create - alert: &768 + alert: &762 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -216877,10 +216292,10 @@ x-webhooks: type: string enum: - open - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -217086,10 +216501,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -217167,11 +216582,11 @@ x-webhooks: type: string enum: - reopen - alert: *768 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *762 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -217370,10 +216785,10 @@ x-webhooks: enum: - fixed - open - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -217391,7 +216806,7 @@ x-webhooks: supported-webhook-types: - repository - organization - secret-scanning-alert-created: + secret-scanning-alert-assigned: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -217399,8 +216814,8 @@ x-webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was created. - operationId: secret-scanning-alert/created + description: A secret scanning alert was assigned. + operationId: secret-scanning-alert/assigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -217444,14 +216859,14 @@ x-webhooks: content: application/json: schema: - title: secret_scanning_alert created event + title: secret_scanning_alert assigned event type: object properties: action: type: string enum: - - created - alert: &769 + - assigned + alert: &763 type: object properties: number: *161 @@ -217569,10 +216984,93 @@ x-webhooks: properties: *20 required: *21 nullable: true - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + assignee: *4 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-created: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was created. + operationId: secret-scanning-alert/created + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: secret_scanning_alert created event + type: object + properties: + action: + type: string + enum: + - created + alert: *763 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -217653,11 +217151,11 @@ x-webhooks: type: string enum: - created - alert: *769 - installation: *710 - location: *770 - organization: *711 - repository: *712 + alert: *763 + installation: *704 + location: *764 + organization: *705 + repository: *706 sender: *4 required: - location @@ -217895,11 +217393,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *763 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -217977,11 +217475,11 @@ x-webhooks: type: string enum: - reopened - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *763 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -218059,11 +217557,94 @@ x-webhooks: type: string enum: - resolved - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *763 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-unassigned: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was unassigned. + operationId: secret-scanning-alert/unassigned + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: secret_scanning_alert unassigned event + type: object + properties: + action: + type: string + enum: + - unassigned + alert: *763 + assignee: *4 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -218141,11 +217722,11 @@ x-webhooks: type: string enum: - validated - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *763 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -218271,10 +217852,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *712 - enterprise: *709 - installation: *710 - organization: *711 + repository: *706 + enterprise: *703 + installation: *704 + organization: *705 sender: *4 required: - action @@ -218352,11 +217933,11 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - security_advisory: &771 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + security_advisory: &765 description: The details of the security advisory, including summary, description, and severity. type: object @@ -218539,11 +218120,11 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - security_advisory: *771 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + security_advisory: *765 sender: *4 required: - action @@ -218616,10 +218197,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -218804,10 +218385,10 @@ x-webhooks: type: object properties: security_and_analysis: *272 - enterprise: *709 - installation: *710 - organization: *711 - repository: *333 + enterprise: *703 + installation: *704 + organization: *705 + repository: *328 sender: *4 required: - changes @@ -218885,12 +218466,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - sponsorship: &772 + sponsorship: &766 type: object properties: created_at: @@ -219191,12 +218772,12 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - sponsorship: *772 + sponsorship: *766 required: - action - sponsorship @@ -219284,12 +218865,12 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - sponsorship: *772 + sponsorship: *766 required: - action - changes @@ -219366,17 +218947,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &773 + effective_date: &767 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - sponsorship: *772 + sponsorship: *766 required: - action - sponsorship @@ -219450,7 +219031,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &774 + changes: &768 type: object properties: tier: @@ -219494,13 +219075,13 @@ x-webhooks: - from required: - tier - effective_date: *773 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + effective_date: *767 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - sponsorship: *772 + sponsorship: *766 required: - action - changes @@ -219577,13 +219158,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *774 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + changes: *768 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - sponsorship: *772 + sponsorship: *766 required: - action - changes @@ -219657,10 +219238,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -219743,10 +219324,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -220166,15 +219747,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *709 + enterprise: *703 id: description: The unique identifier of the status. type: integer - installation: *710 + installation: *704 name: type: string - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 sha: description: The Commit SHA. @@ -220289,9 +219870,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -220381,9 +219962,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -220473,9 +220054,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -220565,9 +220146,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -220644,12 +220225,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - team: &775 + team: &769 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -220872,9 +220453,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 repository: title: Repository description: A git repository @@ -221332,7 +220913,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *769 required: - action - team @@ -221408,9 +220989,9 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 repository: title: Repository description: A git repository @@ -221868,7 +221449,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *769 required: - action - team @@ -221945,9 +221526,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 repository: title: Repository description: A git repository @@ -222405,7 +221986,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *769 required: - action - team @@ -222549,9 +222130,9 @@ x-webhooks: - from required: - permissions - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 repository: title: Repository description: A git repository @@ -223009,7 +222590,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *769 required: - action - changes @@ -223087,9 +222668,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 repository: title: Repository description: A git repository @@ -223547,7 +223128,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *769 required: - action - team @@ -223623,10 +223204,10 @@ x-webhooks: type: string enum: - started - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -223699,16 +223280,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *709 + enterprise: *703 inputs: type: object nullable: true additionalProperties: true - installation: *710 - organization: *711 + installation: *704 + organization: *705 ref: type: string - repository: *712 + repository: *706 sender: *4 workflow: type: string @@ -223790,10 +223371,10 @@ x-webhooks: type: string enum: - completed - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 workflow_job: allOf: @@ -224030,7 +223611,7 @@ x-webhooks: type: string required: - conclusion - deployment: *484 + deployment: *479 required: - action - repository @@ -224109,10 +223690,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 workflow_job: allOf: @@ -224372,7 +223953,7 @@ x-webhooks: required: - status - steps - deployment: *484 + deployment: *479 required: - action - repository @@ -224451,10 +224032,10 @@ x-webhooks: type: string enum: - queued - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 workflow_job: type: object @@ -224589,7 +224170,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *484 + deployment: *479 required: - action - repository @@ -224668,10 +224249,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 workflow_job: type: object @@ -224807,7 +224388,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *484 + deployment: *479 required: - action - repository @@ -224887,12 +224468,12 @@ x-webhooks: type: string enum: - completed - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - workflow: *724 + workflow: *718 workflow_run: title: Workflow Run type: object @@ -225891,12 +225472,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - workflow: *724 + workflow: *718 workflow_run: title: Workflow Run type: object @@ -226880,12 +226461,12 @@ x-webhooks: type: string enum: - requested - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - workflow: *724 + workflow: *718 workflow_run: title: Workflow Run type: object diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 5a35ecf80..50d0a9d48 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -104,10 +104,6 @@ "name": "packages", "description": "Manage packages for authenticated users and organizations." }, - { - "name": "projects-classic", - "description": "Interact with GitHub Projects (classic)." - }, { "name": "pulls", "description": "Interact with GitHub Pull Requests." @@ -4718,6 +4714,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -5703,6 +5707,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -6542,6 +6554,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -7012,6 +7032,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -9037,6 +9065,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -10073,6 +10109,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -11026,6 +11070,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -11690,6 +11742,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -54329,226 +54389,20 @@ "update-budget": { "value": { "message": "Budget successfully updated.", - "id": "550e8400-e29b-41d4-a716-446655440000" - } - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Budget not found or feature not enabled", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - }, - "examples": { - "budget-not-found": { - "value": { - "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - }, - "feature-not-enabled": { - "value": { - "message": "Not Found", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } + "budget": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "org-name/example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] } } } @@ -54557,112 +54411,333 @@ } } }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - }, - "examples": { - "server-error": { - "value": { - "message": "Unable to update budget.", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "billing", - "subcategory": "budgets" - } - }, - "delete": { - "summary": "Delete a budget for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDeletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.", - "tags": [ - "billing" - ], - "operationId": "billing/delete-budget-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/billing/budgets#delete-a-budget-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "budget_id", - "description": "The ID corresponding to the budget.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response when deleting a budget", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "A message indicating the result of the deletion operation" - }, - "id": { - "type": "string", - "description": "The ID of the deleted budget" - } - }, - "required": [ - "message", - "id" - ] - }, - "examples": { - "default": { - "value": { - "message": "Budget successfully deleted.", - "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" - } - } - } - } - } - }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Budget not found or feature not enabled", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "budget-not-found": { + "value": { + "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + }, + "feature-not-enabled": { + "value": { + "message": "Not Found", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to update budget.", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "budgets" + } + }, + "delete": { + "summary": "Delete a budget for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDeletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/delete-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/budgets#delete-a-budget-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "budget_id", + "description": "The ID corresponding to the budget.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response when deleting a budget", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the result of the deletion operation" + }, + "id": { + "type": "string", + "description": "The ID of the deleted budget" + } + }, + "required": [ + "message", + "id" + ] + }, + "examples": { + "default": { + "value": { + "message": "Budget successfully deleted.", + "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" + } + } + } + } + } + }, "400": { "description": "Bad Request", "content": { @@ -102968,6 +103043,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -103968,6 +104051,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -139240,21 +139331,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -168149,6 +168258,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "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.", @@ -184462,17 +184594,17 @@ } } }, - "/orgs/{org}/teams/{team_slug}/projects": { + "/orgs/{org}/teams/{team_slug}/repos": { "get": { - "summary": "List team projects", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "List team repositories", + "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", "tags": [ "teams" ], - "operationId": "teams/list-projects-in-org", + "operationId": "teams/list-repos-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-projects" + "url": "https://docs.github.com/rest/teams/teams#list-team-repositories" }, "parameters": [ { @@ -184520,42 +184652,28 @@ "schema": { "type": "array", "items": { - "title": "Team Project", - "description": "A team's access to a project.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, "id": { - "type": "integer" + "type": "integer", + "format": "int64", + "example": 1296269 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { - "type": "string" - }, - "body": { "type": "string", - "nullable": true - }, - "number": { - "type": "integer" + "example": "Hello-World" }, - "state": { - "type": "string" + "full_name": { + "type": "string", + "example": "octocat/Hello-World" }, - "creator": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -184679,55 +184797,538 @@ "url" ] }, - "created_at": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, - "updated_at": { + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { "type": "string" }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { "type": "string" }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { "type": "boolean" }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, "permissions": { "type": "object", "properties": { - "read": { + "admin": { "type": "boolean" }, - "write": { + "maintain": { "type": "boolean" }, - "admin": { + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { "type": "boolean" } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + } }, "required": [ - "read", - "write", - "admin" + "url", + "html_url", + "key", + "name" ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ - "owner_url", - "url", + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", - "columns_url", "id", "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] } }, @@ -184735,17 +185336,11 @@ "default": { "value": [ { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -184765,1385 +185360,97 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": "string", - "nullable": true - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - } - } - } - } - }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - }, - "nullable": true - }, - "examples": { - "default": { - "summary": "Updates the permissions for the team to write for the project", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/teams/{team_slug}/repos": { - "get": { - "summary": "List team repositories", - "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", - "tags": [ - "teams" - ], - "operationId": "teams/list-repos-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-repositories" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + } } } ] @@ -187605,164 +186912,465 @@ "deprecated": true } }, - "/projects/columns/{column_id}": { + "/rate_limit": { "get": { - "summary": "Get a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "Get rate limit status for the authenticated user", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ - "projects-classic" + "rate-limit" ], - "operationId": "projects-classic/get-column", + "operationId": "rate-limit/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#get-a-project-column" + "url": "https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], + "parameters": [], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", + "title": "Rate Limit Overview", + "description": "Rate Limit Overview", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - }, - "cards_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" - }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" - }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" + "resources": { + "type": "object", + "properties": { + "core": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "graphql": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "source_import": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "integration_manifest": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_scanning_upload": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "actions_runner_registration": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "scim": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "dependency_snapshots": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "dependency_sbom": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_scanning_autofix": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + } + }, + "required": [ + "core", + "search" + ] }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:22:28Z" + "rate": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] } }, "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" + "rate", + "resources" ] }, "examples": { "default": { "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" + "resources": { + "core": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691591363 + }, + "search": { + "limit": 30, + "used": 12, + "remaining": 18, + "reset": 1691591091 + }, + "graphql": { + "limit": 5000, + "used": 7, + "remaining": 4993, + "reset": 1691593228 + }, + "integration_manifest": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691594631 + }, + "source_import": { + "limit": 100, + "used": 1, + "remaining": 99, + "reset": 1691591091 + }, + "code_scanning_upload": { + "limit": 500, + "used": 1, + "remaining": 499, + "reset": 1691594631 + }, + "actions_runner_registration": { + "limit": 10000, + "used": 0, + "remaining": 10000, + "reset": 1691594631 + }, + "scim": { + "limit": 15000, + "used": 0, + "remaining": 15000, + "reset": 1691594631 + }, + "dependency_snapshots": { + "limit": 100, + "used": 0, + "remaining": 100, + "reset": 1691591091 + }, + "code_search": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + } + }, + "rate": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1372700873 + } } } } } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { + }, + "headers": { + "X-RateLimit-Limit": { + "example": 5000, "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } + "type": "integer" } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { + }, + "X-RateLimit-Remaining": { + "example": 4999, "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } + "type": "integer" + } + }, + "X-RateLimit-Reset": { + "example": 1590701888, + "schema": { + "type": "integer", + "format": "timestamp" } } } }, - "401": { - "description": "Requires authentication", + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -187791,2870 +187399,741 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update an existing project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "category": "rate-limit", + "subcategory": "rate-limit" + } + } + }, + "/repos/{owner}/{repo}": { + "get": { + "summary": "Get a repository", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.", "tags": [ - "projects-classic" + "repos" ], - "operationId": "projects-classic/update-column", + "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column" + "url": "https://docs.github.com/rest/repos/repos#get-a-repository" }, "parameters": [ { - "name": "column_id", - "description": "The unique identifier of the column.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Rename the project column", - "value": { - "name": "To Do" - } - } - } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", + "title": "Full Repository", + "description": "Full Repository", "type": "object", "properties": { - "url": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "project_url": { + "name": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" + "example": "Hello-World" }, - "cards_url": { + "full_name": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" + "example": "octocat/Hello-World" }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "node_id": { + "private": { + "type": "boolean" + }, + "html_url": { "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true }, - "created_at": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "updated_at": { + "archive_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:22:28Z" - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "url": { - "type": "string" + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - "documentation_url": { - "type": "string" + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - "url": { - "type": "string" + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/delete-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#delete-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, - "documentation_url": { - "type": "string" + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, - "url": { - "type": "string" + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, - "documentation_url": { - "type": "string" + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "url": { - "type": "string" + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/{column_id}/moves": { - "post": { - "summary": "Move a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/move-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#move-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "example": "last", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$" - } - }, - "required": [ - "position" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Move the column to the end of the board", - "value": { - "position": "last" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, - "documentation_url": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - "url": { - "type": "string" + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - "documentation_url": { - "type": "string" + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, - "documentation_url": { - "type": "string" + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" }, - "url": { - "type": "string" + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators": { - "get": { - "summary": "List project collaborators", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/list-collaborators", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "affiliation", - "description": "Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "outside", - "direct", - "all" - ], - "default": "all" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, - "documentation_url": { - "type": "string" + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, - "url": { - "type": "string" + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, - "documentation_url": { - "type": "string" + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, - "documentation_url": { - "type": "string" + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, - "url": { - "type": "string" + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, - "documentation_url": { - "type": "string" + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" }, - "url": { - "type": "string" + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}": { - "put": { - "summary": "Add project collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/add-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "example": "write", - "type": "string" - } - }, - "nullable": true - }, - "examples": { - "default": { - "summary": "Applying write permissions for the new collaborator", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, - "documentation_url": { - "type": "string" + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, - "url": { - "type": "string" + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, - "documentation_url": { - "type": "string" + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, - "documentation_url": { - "type": "string" + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" }, - "url": { - "type": "string" + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, - "documentation_url": { - "type": "string" + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" }, - "url": { - "type": "string" + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove user as a collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/remove-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "language": { + "type": "string", + "nullable": true }, - "documentation_url": { - "type": "string" + "forks_count": { + "type": "integer", + "example": 9 }, - "url": { - "type": "string" + "stargazers_count": { + "type": "integer", + "example": 80 }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "watchers_count": { + "type": "integer", + "example": 80 }, - "documentation_url": { - "type": "string" + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 }, - "url": { - "type": "string" + "default_branch": { + "type": "string", + "example": "master" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "open_issues_count": { + "type": "integer", + "example": 0 }, - "documentation_url": { - "type": "string" + "is_template": { + "type": "boolean", + "example": true }, - "errors": { + "topics": { "type": "array", "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "type": "string" + }, + "example": [ + "octocat", + "atom", + "electron", + "API" + ] }, - "documentation_url": { - "type": "string" + "has_issues": { + "type": "boolean", + "example": true }, - "url": { - "type": "string" + "has_projects": { + "type": "boolean", + "example": true }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}/permission": { - "get": { - "summary": "Get project permission for a user", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-permission-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", - "type": "object", - "properties": { - "permission": { - "type": "string" + "has_wiki": { + "type": "boolean", + "example": true }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean", + "example": true + }, + "has_discussions": { + "type": "boolean", + "example": true + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "type": "string", + "example": "public" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z" + }, + "permissions": { "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" + "admin": { + "type": "boolean" }, - "email": { - "nullable": true, - "type": "string" + "maintain": { + "type": "boolean" }, - "login": { - "type": "string", - "example": "octocat" + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" }, + "pull": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "allow_rebase_merge": { + "type": "boolean", + "example": true + }, + "template_repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer", - "format": "int64", - "example": 1 + "format": "int64" }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "type": { + "name": { + "description": "The name of the repository.", "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "example": "Team Environment" }, - "starred_at": { + "full_name": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "example": "octocat/Hello-World" }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - }, - "required": [ - "permission", - "user" - ] - }, - "examples": { - "default": { - "value": { - "permission": "admin", - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/rate_limit": { - "get": { - "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", - "tags": [ - "rate-limit" - ], - "operationId": "rate-limit/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" - }, - "parameters": [], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Rate Limit Overview", - "description": "Rate Limit Overview", - "type": "object", - "properties": { - "resources": { - "type": "object", - "properties": { - "core": { - "title": "Rate Limit", + "license": { + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" + "key": { + "type": "string", + "example": "mit" }, - "reset": { - "type": "integer" + "name": { + "type": "string", + "example": "MIT License" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "graphql": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" }, - "remaining": { - "type": "integer" + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" }, - "reset": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" }, - "used": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "limit", - "remaining", - "reset", - "used" - ] + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true }, - "search": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] + "forks": { + "type": "integer" }, - "code_search": { - "title": "Rate Limit", + "permissions": { "type": "object", "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" + "admin": { + "type": "boolean" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "source_import": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "pull": { + "type": "boolean" }, - "remaining": { - "type": "integer" + "triage": { + "type": "boolean" }, - "reset": { - "type": "integer" + "push": { + "type": "boolean" }, - "used": { - "type": "integer" + "maintain": { + "type": "boolean" } }, "required": [ - "limit", - "remaining", - "reset", - "used" + "admin", + "pull", + "push" ] }, - "integration_manifest": { - "title": "Rate Limit", + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "limit": { - "type": "integer" + "name": { + "nullable": true, + "type": "string" }, - "remaining": { - "type": "integer" + "email": { + "nullable": true, + "type": "string" }, - "reset": { - "type": "integer" + "login": { + "type": "string", + "example": "octocat" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_upload": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "remaining": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "reset": { - "type": "integer" + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "actions_runner_registration": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "remaining": { - "type": "integer" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "reset": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "scim": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "remaining": { - "type": "integer" + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "reset": { - "type": "integer" + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_snapshots": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "remaining": { - "type": "integer" + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "reset": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_sbom": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" }, - "remaining": { - "type": "integer" + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "reset": { - "type": "integer" + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_autofix": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "type": { + "type": "string", + "example": "User" }, - "remaining": { - "type": "integer" + "site_admin": { + "type": "boolean" }, - "reset": { - "type": "integer" + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" }, - "used": { - "type": "integer" + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ - "limit", - "remaining", - "reset", - "used" - ] - } - }, - "required": [ - "core", - "search" - ] - }, - "rate": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - } - }, - "required": [ - "rate", - "resources" - ] - }, - "examples": { - "default": { - "value": { - "resources": { - "core": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691591363 - }, - "search": { - "limit": 30, - "used": 12, - "remaining": 18, - "reset": 1691591091 - }, - "graphql": { - "limit": 5000, - "used": 7, - "remaining": 4993, - "reset": 1691593228 - }, - "integration_manifest": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691594631 - }, - "source_import": { - "limit": 100, - "used": 1, - "remaining": 99, - "reset": 1691591091 - }, - "code_scanning_upload": { - "limit": 500, - "used": 1, - "remaining": 499, - "reset": 1691594631 - }, - "actions_runner_registration": { - "limit": 10000, - "used": 0, - "remaining": 10000, - "reset": 1691594631 - }, - "scim": { - "limit": 15000, - "used": 0, - "remaining": 15000, - "reset": 1691594631 - }, - "dependency_snapshots": { - "limit": 100, - "used": 0, - "remaining": 100, - "reset": 1691591091 - }, - "code_search": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - }, - "code_scanning_autofix": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - } - }, - "rate": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1372700873 - } - } - } - } - } - }, - "headers": { - "X-RateLimit-Limit": { - "example": 5000, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Remaining": { - "example": 4999, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Reset": { - "example": 1590701888, - "schema": { - "type": "integer", - "format": "timestamp" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "rate-limit", - "subcategory": "rate-limit" - } - } - }, - "/repos/{owner}/{repo}": { - "get": { - "summary": "Get a repository", - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.", - "tags": [ - "repos" - ], - "operationId": "repos/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#get-a-repository" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Full Repository", - "description": "Full Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "octocat", - "atom", - "electron", - "API" - ] - }, - "has_issues": { - "type": "boolean", - "example": true - }, - "has_projects": { - "type": "boolean", - "example": true - }, - "has_wiki": { - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean", - "example": true - }, - "has_discussions": { - "type": "boolean", - "example": true - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string", - "example": "public" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { - "type": "boolean", - "example": true - }, - "template_repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, "private": { @@ -224334,6 +221813,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -224354,6 +221834,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -242552,6 +240033,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -242572,6 +240054,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -278220,6 +275703,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -278240,6 +275724,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -283974,6 +281459,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -283994,6 +281480,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289303,6 +286790,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289323,6 +286811,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289849,6 +287338,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289869,6 +287359,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -290419,6 +287910,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -290439,6 +287931,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -324211,6 +321704,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -406452,6 +403953,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -406472,6 +403974,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -437285,6 +434788,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -437305,6 +434809,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -468363,6 +465868,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "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.", @@ -470603,7 +468131,7 @@ }, "patch": { "summary": "Update a secret scanning alert", - "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "operationId": "secret-scanning/update-alert", "tags": [ "secret-scanning" @@ -470673,6 +468201,11 @@ "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", "type": "string", "nullable": true + }, + "assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true } }, "anyOf": [ @@ -470680,6 +468213,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -470689,6 +468227,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -471665,7 +469215,27 @@ "resolution_comment": "Example comment", "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://alambic.github.com/avatars/u/1?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } } } @@ -471679,7 +469249,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment" + "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" }, "503": { "description": "Service unavailable", @@ -498900,6 +496470,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -499112,6 +496683,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -512070,17 +509642,17 @@ "deprecated": true } }, - "/teams/{team_id}/projects": { + "/teams/{team_id}/repos": { "get": { - "summary": "List team projects (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "List team repositories (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint.", "tags": [ "teams" ], - "operationId": "teams/list-projects-legacy", + "operationId": "teams/list-repos-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-projects-legacy" + "url": "https://docs.github.com/rest/teams/teams#list-team-repositories-legacy" }, "parameters": [ { @@ -512119,42 +509691,28 @@ "schema": { "type": "array", "items": { - "title": "Team Project", - "description": "A team's access to a project.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, "id": { - "type": "integer" + "type": "integer", + "format": "int64", + "example": 1296269 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { - "type": "string" - }, - "body": { "type": "string", - "nullable": true - }, - "number": { - "type": "integer" + "example": "Hello-World" }, - "state": { - "type": "string" + "full_name": { + "type": "string", + "example": "octocat/Hello-World" }, - "creator": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -512278,55 +509836,538 @@ "url" ] }, - "created_at": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, - "updated_at": { + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { "type": "string" }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { "type": "string" }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { "type": "boolean" }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, "permissions": { "type": "object", "properties": { - "read": { + "admin": { "type": "boolean" }, - "write": { + "maintain": { "type": "boolean" }, - "admin": { + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { "type": "boolean" } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + } }, "required": [ - "read", - "write", - "admin" + "url", + "html_url", + "key", + "name" ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ - "owner_url", - "url", + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", - "columns_url", "id", "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] } }, @@ -512334,17 +510375,11 @@ "default": { "value": [ { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -512364,1564 +510399,97 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, - "/teams/{team_id}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-project-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": "string", - "nullable": true - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - } - } - } - } - }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - } - }, - "examples": { - "default": { - "summary": "Example of setting permission to read", - "value": { - "permission": "read" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, - "/teams/{team_id}/repos": { - "get": { - "summary": "List team repositories (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/list-repos-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-repositories-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + } } } ] @@ -540360,6 +536928,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -589101,6 +585677,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -595498,6 +592082,675 @@ "category": "projects", "subcategory": "fields" } + }, + "post": { + "summary": "Add field to user owned project", + "description": "Add a field to a specified user owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/add-field-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_number", + "description": "The project's number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date", + "single_select", + "iteration" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "description": "The color associated with the option.", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + "description": { + "type": "string", + "description": "The description of the option." + } + } + } + }, + "iteration_configuration": { + "type": "object", + "description": "The configuration for iteration fields.", + "properties": { + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the first iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "description": "Zero or more iterations for the field.", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title for the iteration." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + } + } + } + } + } + } + }, + "required": [ + "name", + "data_type" + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "summary": "Create a single select field", + "value": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + } + }, + "iteration_field": { + "summary": "Create an iteration field", + "value": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "example": "https://api.github.com/projects/1" + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was last updated." + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + }, + "examples": { + "text_field": { + "value": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + } + }, + "number_field": { + "value": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + } + }, + "date_field": { + "value": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + } + }, + "single_select_field": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + }, + "iteration_field": { + "value": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" + } } }, "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { @@ -595743,21 +592996,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -647113,6 +644384,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -649494,6 +646772,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -757124,6 +754409,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -759716,6 +757009,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -762215,6 +759516,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -764714,6 +762023,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -767345,6 +764662,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -769983,6 +767308,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -774244,6 +771577,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1168125,949 +1165466,4357 @@ ] } }, - "updated": { + "updated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "rule": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "automatic_copilot_code_review_enabled": { + "type": "boolean", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + } + ] + }, + "changes": { + "type": "object", + "properties": { + "configuration": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "rule_type": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "pattern": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-transferred": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", + "operationId": "repository/transferred", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "repository transferred event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "transferred" + ] + }, + "changes": { + "type": "object", + "properties": { + "owner": { + "type": "object", + "properties": { + "from": { + "type": "object", + "properties": { + "organization": { + "title": "Organization", + "type": "object", + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issues_url": { + "type": "string", + "format": "uri" + }, + "login": { + "type": "string" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "node_id": { + "type": "string" + }, + "public_members_url": { + "type": "string", + "format": "uri-template" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id", + "node_id", + "url", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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": [ + "from" + ] + } + }, + "required": [ + "owner" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "changes", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-unarchived": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "repository unarchived event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unarchived" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { "type": "array", "items": { - "type": "object", - "properties": { - "rule": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "merge_queue" - ] - }, - "parameters": { - "type": "object", - "properties": { - "check_response_timeout_minutes": { - "type": "integer", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", - "minimum": 1, - "maximum": 360 - }, - "grouping_strategy": { - "type": "string", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - "max_entries_to_build": { - "type": "integer", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", - "minimum": 0, - "maximum": 100 - }, - "max_entries_to_merge": { - "type": "integer", - "description": "The maximum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "merge_method": { - "type": "string", - "description": "Method to use when merging changes from queued pull requests.", - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - "min_entries_to_merge": { - "type": "integer", - "description": "The minimum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "min_entries_to_merge_wait_minutes": { - "type": "integer", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", - "minimum": 0, - "maximum": 360 - } - }, - "required": [ - "check_response_timeout_minutes", - "grouping_strategy", - "max_entries_to_build", - "max_entries_to_merge", - "merge_method", - "min_entries_to_merge", - "min_entries_to_merge_wait_minutes" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "automatic_copilot_code_review_enabled": { - "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - }, - "required_reviewers": { - "type": "array", - "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", - "items": { - "title": "RequiredReviewerConfiguration", - "description": "A reviewing team, and file patterns describing which files they must approve changes to.", - "type": "object", - "properties": { - "file_patterns": { - "type": "array", - "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", - "items": { - "type": "string" - } - }, - "minimum_approvals": { - "type": "integer", - "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." - }, - "reviewer": { - "title": "Reviewer", - "description": "A required reviewing team", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "ID of the reviewer which must review changes to matching files." - }, - "type": { - "type": "string", - "description": "The type of the reviewer", - "enum": [ - "Team" - ] - } - }, - "required": [ - "id", - "type" - ] - } - }, - "required": [ - "file_patterns", - "minimum_approvals", - "reviewer" - ] - } - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } - } - ] - }, - "changes": { - "type": "object", - "properties": { - "configuration": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "rule_type": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "pattern": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - } - } - } + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" } } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" } } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } - } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] }, "sender": { "title": "Simple User", @@ -1169196,7 +1169945,7 @@ }, "required": [ "action", - "repository_ruleset", + "repository", "sender" ] } @@ -1169211,8 +1169960,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -1169220,13 +1169970,13 @@ } } }, - "repository-transferred": { + "repository-vulnerability-alert-create": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", - "operationId": "repository/transferred", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1169291,200 +1170041,180 @@ "content": { "application/json": { "schema": { - "title": "repository transferred event", + "title": "repository_vulnerability_alert create event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "transferred" + "create" ] }, - "changes": { + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], "properties": { - "owner": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "issues_url": { - "type": "string", - "format": "uri" - }, - "login": { - "type": "string" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "node_id": { - "type": "string" - }, - "public_members_url": { - "type": "string", - "format": "uri-template" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id", - "node_id", - "url", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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" - ] - } - } + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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" } - }, - "required": [ - "from" + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open" ] } - }, - "required": [ - "owner" - ] + } }, "enterprise": { "title": "Enterprise", @@ -1170992,7 +1171722,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1171008,23 +1171738,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-unarchived": { + "repository-vulnerability-alert-dismiss": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1171089,15 +1171817,191 @@ "content": { "application/json": { "schema": { - "title": "repository unarchived event", + "title": "repository_vulnerability_alert dismiss event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unarchived" + "dismiss" ] }, + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", + "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "dismiss_reason", + "dismissed_at", + "dismisser", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], + "properties": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_comment": { + "type": "string", + "nullable": true + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "dismissed" + ] + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -1172604,6 +1173508,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1172619,21 +1173524,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-vulnerability-alert-create": { + "repository-vulnerability-alert-reopen": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was created.", - "operationId": "repository-vulnerability-alert/create", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1172700,13 +1173603,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert create event", + "title": "repository_vulnerability_alert reopen event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "create" + "reopen" ] }, "alert": { @@ -1174405,11 +1175308,11 @@ } } }, - "repository-vulnerability-alert-dismiss": { + "repository-vulnerability-alert-resolve": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was dismissed.", - "operationId": "repository-vulnerability-alert/dismiss", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1174476,13 +1175379,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert dismiss event", + "title": "repository_vulnerability_alert resolve event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "dismiss" + "resolve" ] }, "alert": { @@ -1174493,9 +1175396,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1174515,10 +1175415,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": "string", - "nullable": true - }, "dismiss_reason": { "type": "string" }, @@ -1174614,9 +1175510,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1174656,7 +1175549,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1176163,279 +1177057,855 @@ "type", "url" ] - } - }, - "required": [ - "action", - "alert", - "repository", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "repository_vulnerability_alert", - "supported-webhook-types": [ - "repository", - "organization" - ] - } - } - }, - "repository-vulnerability-alert-reopen": { - "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "repository_vulnerability_alert reopen event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "reopen" - ] - }, - "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", - "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], - "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "dismiss_reason": { - "type": "string" - }, - "dismissed_at": { - "type": "string" - }, - "dismisser": { - "title": "User", - "type": "object", - "nullable": true, - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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" - } - } - }, - "external_identifier": { - "type": "string" - }, - "external_reference": { - "type": "string", - "nullable": true, - "format": "uri" - }, - "fix_reason": { - "type": "string" - }, - "fixed_at": { - "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "severity": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "open" - ] - } - } + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_vulnerability_alert", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "secret-scanning-alert-assigned": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "secret_scanning_alert assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { + "type": "string", + "description": "The reason for resolving the alert.", + "nullable": true, + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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).\"" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true + }, + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, "enterprise": { "title": "Enterprise", @@ -1177944,8 +1179414,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1177959,21 +1179428,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-resolve": { + "secret-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was marked as resolved.", - "operationId": "repository-vulnerability-alert/resolve", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was created.", + "operationId": "secret-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1178038,179 +1179508,630 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert resolve event", + "title": "secret_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolve" + "created" ] }, "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, "created_at": { - "type": "string" + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "dismiss_reason": { - "type": "string" + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", - "type": "object", + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { + "type": "string", + "description": "The reason for resolving the alert.", "nullable": true, - "required": [ - "login", - "id" - ], + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "format": "uri" + "example": "octocat" }, - "deleted": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "email": { + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "events_url": { + "url": { "type": "string", - "format": "uri-template" + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "gravatar_id": { - "type": "string" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "html_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "id": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "login": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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).\"" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { "name": { + "nullable": true, "type": "string" }, - "node_id": { + "email": { + "nullable": true, "type": "string" }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "repos_url": { + "type": { "type": "string", - "format": "uri" + "example": "User" }, "site_admin": { "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, "starred_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "example": "User" }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } - } - }, - "external_identifier": { - "type": "string" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "external_reference": { + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "nullable": true, - "format": "uri" - }, - "fix_reason": { - "type": "string" + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true }, - "fixed_at": { + "push_protection_bypass_request_comment": { "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true }, - "node_id": { - "type": "string" + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true }, - "number": { - "type": "integer" + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true }, - "severity": { - "type": "string" + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" - ] + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true } } }, @@ -1179721,8 +1181642,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1179736,21 +1181656,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "secret-scanning-alert-created": { + "secret-scanning-alert-location-created": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was created.", - "operationId": "secret-scanning-alert/created", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", + "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -1179815,7 +1181736,7 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { @@ -1180442,74 +1182363,6 @@ } } }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1180531,6 +1182384,314 @@ "node_id" ] }, + "location": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "commit", + "wiki_commit", + "issue_title", + "issue_body", + "issue_comment", + "discussion_title", + "discussion_body", + "discussion_comment", + "pull_request_title", + "pull_request_body", + "pull_request_comment", + "pull_request_review", + "pull_request_review_comment" + ], + "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", + "example": "commit" + }, + "details": { + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/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", + "example": "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", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/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", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ] + } + } + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", @@ -1181947,10 +1184108,185 @@ } }, "required": [ - "action", + "location", "alert", - "repository" + "repository", + "sender" + ] + }, + "examples": { + "default": { + "value": { + "action": "created", + "alert": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "updated_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", + "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", + "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "publicly_leaked": false, + "multi_repo": false + }, + "location": { + "type": "commit", + "details": { + "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-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + } + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "hello-world", + "full_name": "octocat-repo/hello-world", + "private": false, + "owner": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/octocat-repo/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octocat-repo/hello-world", + "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", + "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", + "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", + "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", + "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", + "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", + "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", + "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", + "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", + "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", + "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", + "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", + "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", + "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", + "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", + "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", + "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", + "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", + "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:21:03Z", + "pushed_at": "2019-05-15T15:20:57Z", + "git_url": "git://github.com/octocat-repo/hello-world.git", + "ssh_url": "git@github.com:octocat-repo/hello-world.git", + "clone_url": "https://github.com/octocat-repo/hello-world.git", + "svn_url": "https://github.com/octocat-repo/hello-world", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false + }, + "sender": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Secret Scanning Alert Location Created Event", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" ] + }, + "examples": { + "default": { + "value": { + "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" + } + } } } } @@ -1181962,8 +1184298,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1181972,13 +1184309,13 @@ } } }, - "secret-scanning-alert-location-created": { + "secret-scanning-alert-publicly-leaked": { "post": { - "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", - "operationId": "secret-scanning-alert-location/created", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1182043,13 +1184380,13 @@ "content": { "application/json": { "schema": { - "title": "Secret Scanning Alert Location Created Event", + "title": "secret_scanning_alert publicly leaked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "publicly_leaked" ] }, "alert": { @@ -1182670,6 +1185007,74 @@ } } }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1182691,314 +1185096,6 @@ "node_id" ] }, - "location": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "commit", - "wiki_commit", - "issue_title", - "issue_body", - "issue_comment", - "discussion_title", - "discussion_body", - "discussion_comment", - "pull_request_title", - "pull_request_body", - "pull_request_comment", - "pull_request_review", - "pull_request_review_comment" - ], - "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", - "example": "commit" - }, - "details": { - "oneOf": [ - { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "example": "/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", - "example": "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", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "example": "/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", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_title_url" - ] - }, - { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_body_url" - ] - }, - { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "issue_comment_url" - ] - }, - { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082" - } - }, - "required": [ - "discussion_title_url" - ] - }, - { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussion-4566270" - } - }, - "required": [ - "discussion_body_url" - ] - }, - { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - } - }, - "required": [ - "discussion_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_title_url" - ] - }, - { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_body_url" - ] - }, - { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - } - }, - "required": [ - "pull_request_review_url" - ] - }, - { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } - ] - } - } - }, "organization": { "title": "Organization Simple", "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", @@ -1184415,185 +1186512,10 @@ } }, "required": [ - "location", + "action", "alert", - "repository", - "sender" - ] - }, - "examples": { - "default": { - "value": { - "action": "created", - "alert": { - "number": 42, - "created_at": "2020-11-06T18:18:30Z", - "updated_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", - "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", - "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", - "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, - "secret_type": "mailchimp_api_key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "publicly_leaked": false, - "multi_repo": false - }, - "location": { - "type": "commit", - "details": { - "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-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - } - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "hello-world", - "full_name": "octocat-repo/hello-world", - "private": false, - "owner": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/octocat-repo/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octocat-repo/hello-world", - "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", - "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", - "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", - "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", - "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", - "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", - "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", - "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", - "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", - "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", - "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", - "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", - "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", - "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", - "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", - "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", - "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", - "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", - "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:03Z", - "pushed_at": "2019-05-15T15:20:57Z", - "git_url": "git://github.com/octocat-repo/hello-world.git", - "ssh_url": "git@github.com:octocat-repo/hello-world.git", - "clone_url": "https://github.com/octocat-repo/hello-world.git", - "svn_url": "https://github.com/octocat-repo/hello-world", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false - }, - "sender": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "title": "Secret Scanning Alert Location Created Event", - "type": "object", - "properties": { - "payload": { - "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", - "type": "string" - } - }, - "required": [ - "payload" + "repository" ] - }, - "examples": { - "default": { - "value": { - "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" - } - } } } } @@ -1184605,9 +1186527,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1184616,11 +1186537,11 @@ } } }, - "secret-scanning-alert-publicly-leaked": { + "secret-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was detected in a public repo.", - "operationId": "secret-scanning-alert/publicly-leaked", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1184687,13 +1186608,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert publicly leaked event", + "title": "secret_scanning_alert reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "publicly_leaked" + "reopened" ] }, "alert": { @@ -1186844,11 +1188765,11 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-resolved": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1186915,13 +1188836,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert reopened event", + "title": "secret_scanning_alert resolved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "resolved" ] }, "alert": { @@ -1189072,11 +1190993,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-unassigned": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1189143,13 +1191064,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert resolved event", + "title": "secret_scanning_alert unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolved" + "unassigned" ] }, "alert": { @@ -1189770,6 +1191691,130 @@ } } }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index e26d2a991..ed67ecb3f 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -57,8 +57,6 @@ tags: description: Interact with organizations. - name: packages description: Manage packages for authenticated users and organizations. -- name: projects-classic - description: Interact with GitHub Projects (classic). - name: pulls description: Interact with GitHub Pull Requests. - name: rate-limit @@ -1023,7 +1021,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &637 + - &633 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -2208,6 +2206,13 @@ paths: enum: - read - write + artifact_metadata: + type: string + description: The level of permission to grant the access + token to create and retrieve build artifact metadata records. + enum: + - read + - write attestations: type: string description: The level of permission to create and retrieve @@ -8629,7 +8634,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &475 + - &470 name: has in: query description: |- @@ -8745,7 +8750,7 @@ paths: - unknown - direct - transitive - security_advisory: &476 + security_advisory: &471 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9007,7 +9012,7 @@ paths: format: date-time readOnly: true nullable: true - auto_dismissed_at: &477 + auto_dismissed_at: &472 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -10303,7 +10308,7 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &526 + properties: &521 id: type: integer format: int64 @@ -10675,7 +10680,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &649 + sub_issues_summary: &645 title: Sub-issues Summary type: object properties: @@ -10695,7 +10700,7 @@ paths: type: string format: uri nullable: true - issue_dependencies_summary: &650 + issue_dependencies_summary: &646 title: Issue Dependencies Summary type: object properties: @@ -10714,7 +10719,7 @@ paths: - total_blocking issue_field_values: type: array - items: &651 + items: &647 title: Issue Field Value description: A value assigned to an issue field type: object @@ -10774,7 +10779,7 @@ paths: - node_id - data_type - value - required: &527 + required: &522 - assignee - closed_at - comments @@ -10795,7 +10800,7 @@ paths: - user - created_at - updated_at - comment: &524 + comment: &519 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -11365,7 +11370,7 @@ paths: url: type: string format: uri - user: &663 + user: &657 title: Public User description: Public User type: object @@ -14670,14 +14675,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &327 + - &325 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &328 + - &326 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -14739,7 +14744,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &334 + '301': &329 description: Moved permanently content: application/json: @@ -14761,7 +14766,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &556 + - &551 name: all description: If `true`, show notifications marked as read. in: query @@ -14769,7 +14774,7 @@ paths: schema: type: boolean default: false - - &557 + - &552 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -14779,7 +14784,7 @@ paths: type: boolean default: false - *72 - - &558 + - &553 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -15253,7 +15258,7 @@ paths: - url - subscription_url examples: - default: &559 + default: &554 value: - id: '1' repository: @@ -16121,7 +16126,7 @@ paths: - property_name - value examples: - default: &565 + default: &560 value: - property_name: environment value: production @@ -16171,7 +16176,7 @@ paths: required: - properties examples: - default: &566 + default: &561 value: properties: - property_name: environment @@ -16585,7 +16590,19 @@ paths: update-budget: value: message: Budget successfully updated. - id: 550e8400-e29b-41d4-a716-446655440000 + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa '400': *14 '401': *25 '403': *29 @@ -16716,7 +16733,7 @@ paths: required: false schema: type: string - - &702 + - &696 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -16862,7 +16879,7 @@ paths: parameters: - *63 - *106 - - &703 + - &697 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -16974,7 +16991,7 @@ paths: - *106 - *108 - *107 - - &704 + - &698 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -16982,7 +16999,7 @@ paths: schema: type: string - *109 - - &705 + - &699 name: sku description: The SKU to query for usage. in: query @@ -17884,7 +17901,7 @@ paths: type: integer repository_cache_usages: type: array - items: &339 + items: &334 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -19076,7 +19093,7 @@ paths: - all - local_only - selected - selected_actions_url: &345 + selected_actions_url: &340 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` @@ -19159,7 +19176,7 @@ paths: description: Response content: application/json: - schema: &349 + schema: &344 type: object properties: days: @@ -19201,7 +19218,7 @@ paths: required: true content: application/json: - schema: &350 + schema: &345 type: object properties: days: @@ -19258,7 +19275,7 @@ paths: required: - approval_policy examples: - default: &351 + default: &346 value: approval_policy: first_time_contributors '404': *6 @@ -19317,7 +19334,7 @@ paths: description: Response content: application/json: - schema: &352 + schema: &347 type: object required: - run_workflows_from_fork_pull_requests @@ -19371,7 +19388,7 @@ paths: required: true content: application/json: - schema: &353 + schema: &348 type: object required: - run_workflows_from_fork_pull_requests @@ -20006,7 +20023,7 @@ paths: description: Response content: application/json: - schema: &354 + schema: &349 type: object properties: default_workflow_permissions: &136 @@ -20057,7 +20074,7 @@ paths: required: false content: application/json: - schema: &355 + schema: &350 type: object properties: default_workflow_permissions: *136 @@ -20546,7 +20563,7 @@ paths: type: array items: *143 examples: - default: &666 + default: &660 value: total_count: 1 repositories: @@ -21188,7 +21205,7 @@ paths: application/json: schema: type: array - items: &356 + items: &351 title: Runner Application description: Runner Application type: object @@ -21213,7 +21230,7 @@ paths: - download_url - filename examples: - default: &357 + default: &352 value: - os: osx architecture: x64 @@ -21299,7 +21316,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &358 + '201': &353 description: Response content: application/json: @@ -21410,7 +21427,7 @@ paths: - token - expires_at examples: - default: &359 + default: &354 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -21449,7 +21466,7 @@ paths: application/json: schema: *147 examples: - default: &360 + default: &355 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -21483,7 +21500,7 @@ paths: application/json: schema: *145 examples: - default: &361 + default: &356 value: id: 23 name: MBP @@ -21709,7 +21726,7 @@ paths: - *63 - *144 responses: - '200': &362 + '200': &357 description: Response content: application/json: @@ -21766,7 +21783,7 @@ paths: parameters: - *63 - *144 - - &363 + - &358 name: name description: The name of a self-hosted runner's custom label. in: path @@ -21896,7 +21913,7 @@ paths: description: Response content: application/json: - schema: &375 + schema: &370 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -21925,7 +21942,7 @@ paths: - key_id - key examples: - default: &376 + default: &371 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -22338,7 +22355,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *63 - - &344 + - &339 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -23442,12 +23459,12 @@ paths: required: - subject_digests examples: - default: &694 + default: &688 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &695 + withPredicateType: &689 value: subject_digests: - sha256:abc123 @@ -23505,7 +23522,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &696 + default: &690 value: attestations_subject_digests: - sha256:abc: @@ -23854,7 +23871,7 @@ paths: initiator: type: string examples: - default: &389 + default: &384 value: attestations: - bundle: @@ -24783,7 +24800,7 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *63 - - &415 + - &410 name: tool_name description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, @@ -24793,7 +24810,7 @@ paths: schema: &168 type: string description: The name of the tool used to generate the code scanning analysis. - - &416 + - &411 name: tool_guid description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in @@ -24816,7 +24833,7 @@ paths: be returned. in: query required: false - schema: &418 + schema: &413 type: string description: State of a code scanning alert. enum: @@ -24839,7 +24856,7 @@ paths: be returned. in: query required: false - schema: &419 + schema: &414 type: string description: Severity of a code scanning alert. enum: @@ -24865,7 +24882,7 @@ paths: updated_at: *163 url: *164 html_url: *165 - instances_url: &420 + instances_url: &415 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -24888,7 +24905,7 @@ paths: required: *21 nullable: true dismissed_at: *167 - dismissed_reason: &421 + dismissed_reason: &416 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -24897,13 +24914,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &422 + dismissed_comment: &417 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &423 + rule: &418 type: object properties: id: @@ -24956,7 +24973,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &424 + tool: &419 type: object properties: name: *168 @@ -24966,15 +24983,15 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *169 - most_recent_instance: &425 + most_recent_instance: &420 type: object properties: - ref: &417 + ref: &412 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &435 + analysis_key: &430 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -24985,7 +25002,7 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &436 + category: &431 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -26309,7 +26326,7 @@ paths: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &448 + properties: &443 name: type: string description: The name of the machine. @@ -26351,7 +26368,7 @@ paths: - ready - in_progress nullable: true - required: &449 + required: &444 - name - display_name - operating_system @@ -27219,7 +27236,7 @@ paths: - updated_at - visibility examples: - default: &450 + default: &445 value: total_count: 2 secrets: @@ -27257,7 +27274,7 @@ paths: description: Response content: application/json: - schema: &451 + schema: &446 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -27286,7 +27303,7 @@ paths: - key_id - key examples: - default: &452 + default: &447 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -27318,7 +27335,7 @@ paths: application/json: schema: *178 examples: - default: &454 + default: &449 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -28931,7 +28948,7 @@ paths: description: Response content: application/json: - schema: &480 + schema: &475 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -28948,7 +28965,7 @@ paths: - key_id - key examples: - default: &481 + default: &476 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -30748,7 +30765,7 @@ paths: application/json: schema: *22 examples: - default: &519 + default: &514 value: id: 1 account: @@ -30973,7 +30990,7 @@ paths: required: true content: application/json: - schema: &520 + schema: &515 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -31826,7 +31843,7 @@ paths: application/json: schema: *224 examples: - default: &447 + default: &442 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -33071,7 +33088,7 @@ paths: parameters: - *63 - *231 - - &679 + - &673 name: repo_name description: repo_name parameter in: path @@ -34110,7 +34127,7 @@ paths: - nuget - container - *63 - - &680 + - &674 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -34151,7 +34168,7 @@ paths: default: *238 '403': *29 '401': *25 - '400': &682 + '400': &676 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -35943,7 +35960,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &756 + properties: &750 id: type: number description: The unique identifier of the status update. @@ -35991,7 +36008,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &757 + required: &751 - id - node_id - created_at @@ -36205,7 +36222,7 @@ paths: content: oneOf: - *82 - - &462 + - &457 title: Pull Request Simple description: Pull Request Simple type: object @@ -36434,7 +36451,7 @@ paths: - review_comment - self author_association: *69 - auto_merge: &568 + auto_merge: &563 title: Auto merge description: The status of auto merging a pull request. type: object @@ -36809,7 +36826,7 @@ paths: - updated_at - project_url examples: - default: &699 + default: &693 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -36941,7 +36958,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *255 - - &700 + - &694 name: field_id description: The unique identifier of the field. in: path @@ -36956,7 +36973,7 @@ paths: application/json: schema: *259 examples: - default: &701 + default: &695 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -36965,17 +36982,29 @@ paths: project_url: https://api.github.com/projects/67890 options: - id: option_1 - name: Low + name: + html: Low + raw: Low color: GREEN - description: Low priority items + description: + html: Low priority items + raw: Low priority items - id: option_2 - name: Medium + name: + html: Medium + raw: Medium color: YELLOW - description: Medium priority items + description: + html: Medium priority items + raw: Medium priority items - id: option_3 - name: High + name: + html: High + raw: High color: RED - description: High priority items + description: + html: High priority items + raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' headers: @@ -38875,7 +38904,7 @@ paths: description: Response content: application/json: - schema: &333 + schema: &328 title: Full Repository description: Full Repository type: object @@ -39268,7 +39297,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &467 + properties: &462 url: type: string format: uri @@ -39284,7 +39313,7 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &468 + required: &463 - url - key - name @@ -39373,7 +39402,7 @@ paths: - network_count - subscribers_count examples: - default: &335 + default: &330 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -39894,7 +39923,7 @@ paths: - *63 - *17 - *19 - - &591 + - &586 name: targets description: | A comma-separated list of rule targets to filter by. @@ -40175,7 +40204,7 @@ paths: - repository_property rules: type: array - items: &592 + items: &587 title: Repository Rule type: object description: A repository rule. @@ -40237,7 +40266,7 @@ paths: type: string enum: - required_linear_history - - &589 + - &584 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -40910,7 +40939,7 @@ paths: - tool required: - code_scanning_tools - - &590 + - &585 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -41136,7 +41165,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *63 - - &593 + - &588 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -41151,7 +41180,7 @@ paths: in: query schema: type: string - - &594 + - &589 name: time_period description: |- The time period to filter by. @@ -41167,14 +41196,14 @@ paths: - week - month default: day - - &595 + - &590 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &596 + - &591 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -41194,7 +41223,7 @@ paths: description: Response content: application/json: - schema: &597 + schema: &592 title: Rule Suites description: Response type: array @@ -41249,7 +41278,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &598 + default: &593 value: - id: 21 actor_id: 12 @@ -41293,7 +41322,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *63 - - &599 + - &594 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -41309,7 +41338,7 @@ paths: description: Response content: application/json: - schema: &600 + schema: &595 title: Rule Suite description: Response type: object @@ -41408,7 +41437,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &601 + default: &596 value: id: 21 actor_id: 12 @@ -41654,7 +41683,7 @@ paths: type: string format: date-time examples: - default: &603 + default: &598 value: - version_id: 3 actor: @@ -41707,7 +41736,7 @@ paths: description: Response content: application/json: - schema: &604 + schema: &599 allOf: - *301 - type: object @@ -41779,7 +41808,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *63 - - &605 + - &600 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -41790,7 +41819,7 @@ paths: enum: - open - resolved - - &606 + - &601 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -41800,7 +41829,7 @@ paths: required: false schema: type: string - - &607 + - &602 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -41809,7 +41838,26 @@ paths: required: false schema: type: string - - &608 + - &603 + name: assignee + in: query + description: Filters alerts by assignee. Use `*` to get all assigned alerts, + `none` to get all unassigned alerts, or a GitHub username to get alerts + assigned to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: "*" + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts + - &604 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. @@ -41824,7 +41872,7 @@ paths: - *48 - *19 - *17 - - &609 + - &605 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 @@ -41834,7 +41882,7 @@ paths: required: false schema: type: string - - &610 + - &606 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -41844,7 +41892,7 @@ paths: required: false schema: type: string - - &611 + - &607 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -41853,7 +41901,7 @@ paths: required: false schema: type: string - - &612 + - &608 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -41862,7 +41910,7 @@ paths: schema: type: boolean default: false - - &613 + - &609 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -41871,7 +41919,7 @@ paths: schema: type: boolean default: false - - &614 + - &610 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -41906,14 +41954,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &615 + state: &611 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &616 + resolution: &612 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -42020,8 +42068,8 @@ paths: pull request. ' - oneOf: &617 - - &619 + oneOf: &613 + - &615 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -42073,7 +42121,7 @@ paths: - blob_url - commit_sha - commit_url - - &620 + - &616 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. @@ -42128,7 +42176,7 @@ paths: - page_url - commit_sha - commit_url - - &621 + - &617 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -42142,7 +42190,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &622 + - &618 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -42156,7 +42204,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &623 + - &619 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -42170,7 +42218,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &624 + - &620 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -42184,7 +42232,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &625 + - &621 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -42198,7 +42246,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &626 + - &622 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -42212,7 +42260,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &627 + - &623 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. @@ -42226,7 +42274,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &628 + - &624 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. @@ -42240,7 +42288,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &629 + - &625 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. @@ -42254,7 +42302,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &630 + - &626 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. @@ -42268,7 +42316,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &631 + - &627 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. @@ -42766,7 +42814,7 @@ paths: application/json: schema: type: array - items: &635 + items: &631 description: A repository security advisory. type: object properties: @@ -43057,7 +43105,7 @@ paths: - private_fork additionalProperties: false examples: - default: &636 + default: &632 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -44968,7 +45016,7 @@ paths: - updated_at - url examples: - default: &653 + default: &649 value: - author: login: octocat @@ -45216,7 +45264,7 @@ paths: application/json: schema: *314 examples: - default: &654 + default: &650 value: author: login: octocat @@ -45399,7 +45447,7 @@ paths: - updated_at - url examples: - default: &655 + default: &651 value: - author: login: octocat @@ -45625,7 +45673,7 @@ paths: application/json: schema: *317 examples: - default: &656 + default: &652 value: author: login: octocat @@ -46241,7 +46289,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &657 + response-if-user-is-a-team-maintainer: &653 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -46306,7 +46354,7 @@ paths: application/json: schema: *324 examples: - response-if-users-membership-with-team-is-now-pending: &658 + response-if-users-membership-with-team-is-now-pending: &654 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -46354,322 +46402,6 @@ paths: enabledForGitHubApps: true category: teams subcategory: members - "/orgs/{org}/teams/{team_slug}/projects": - get: - summary: List team projects - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/list-projects-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-projects - parameters: - - *63 - - *64 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &325 - title: Team Project - description: A team's access to a project. - type: object - properties: - owner_url: - type: string - url: - type: string - html_url: - type: string - columns_url: - type: string - id: - type: integer - node_id: - type: string - name: - type: string - body: - type: string - nullable: true - number: - type: integer - state: - type: string - creator: *4 - created_at: - type: string - updated_at: - type: string - organization_permission: - description: The organization permission for this project. Only - present when owner is an organization. - type: string - private: - description: Whether the project is private or not. Only present - when owner is an organization. - type: boolean - permissions: - type: object - properties: - read: - type: boolean - write: - type: boolean - admin: - type: boolean - required: - - read - - write - - admin - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at - - permissions - examples: - default: &659 - value: - - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false - headers: - Link: *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": - get: - summary: Check team permissions for a project - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/check-permissions-for-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project - parameters: - - *63 - - *64 - - &326 - name: project_id - description: The unique identifier of the project. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *325 - examples: - default: &660 - value: - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - put: - summary: Add or update team project permissions - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/add-or-update-project-permissions-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - parameters: - - *63 - - *64 - - *326 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - nullable: true - examples: - default: - summary: Updates the permissions for the team to write for the project - value: - permission: write - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Remove a project from a team - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/remove-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team - parameters: - - *63 - - *64 - - *326 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/orgs/{org}/teams/{team_slug}/repos": get: summary: List team repositories @@ -46729,14 +46461,14 @@ paths: parameters: - *63 - *64 - - *327 - - *328 + - *325 + - *326 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &661 + schema: &655 title: Team Repository description: A team's access to a repository. type: object @@ -47307,8 +47039,8 @@ paths: parameters: - *63 - *64 - - *327 - - *328 + - *325 + - *326 requestBody: required: false content: @@ -47355,8 +47087,8 @@ paths: parameters: - *63 - *64 - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -47393,7 +47125,7 @@ paths: type: array items: *181 examples: - response-if-child-teams-exist: &662 + response-if-child-teams-exist: &656 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -47506,455 +47238,6 @@ paths: deprecationDate: '2024-07-22' removalDate: '2025-07-22' deprecated: true - "/projects/columns/{column_id}": - get: - summary: Get a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#get-a-project-column - parameters: - - &329 - name: column_id - description: The unique identifier of the column. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: &330 - title: Project Column - description: Project columns contain cards of work. - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/projects/columns/367 - project_url: - type: string - format: uri - example: https://api.github.com/projects/120 - cards_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367/cards - id: - description: The unique identifier of the project column - example: 42 - type: integer - node_id: - type: string - example: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: - description: Name of the project column - example: Remaining tasks - type: string - created_at: - type: string - format: date-time - example: '2016-09-05T14:18:44Z' - updated_at: - type: string - format: date-time - example: '2016-09-05T14:22:28Z' - required: - - id - - node_id - - url - - project_url - - cards_url - - name - - created_at - - updated_at - examples: - default: &331 - value: - url: https://api.github.com/projects/columns/367 - project_url: https://api.github.com/projects/120 - cards_url: https://api.github.com/projects/columns/367/cards - id: 367 - node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: To Do - created_at: '2016-09-05T14:18:44Z' - updated_at: '2016-09-05T14:22:28Z' - '304': *37 - '403': *29 - '404': *6 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update an existing project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/update-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column - parameters: - - *329 - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project column - example: Remaining tasks - type: string - required: - - name - type: object - examples: - default: - summary: Rename the project column - value: - name: To Do - responses: - '200': - description: Response - content: - application/json: - schema: *330 - examples: - default: *331 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/delete-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#delete-a-project-column - parameters: - - *329 - responses: - '204': - description: Response - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/columns/{column_id}/moves": - post: - summary: Move a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/move-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#move-a-project-column - parameters: - - *329 - requestBody: - required: true - content: - application/json: - schema: - properties: - position: - description: 'The position of the column in a project. Can be one - of: `first`, `last`, or `after:` to place after the - specified column.' - example: last - type: string - pattern: "^(?:first|last|after:\\d+)$" - required: - - position - type: object - examples: - default: - summary: Move the column to the end of the board - value: - position: last - responses: - '201': - description: Response - content: - application/json: - schema: - type: object - properties: {} - additionalProperties: false - examples: - default: - value: - '304': *37 - '403': *29 - '422': *7 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators": - get: - summary: List project collaborators - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/list-collaborators - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators - parameters: - - *326 - - name: affiliation - description: Filters the collaborators by their affiliation. `outside` means - outside collaborators of a project that are not a member of the project's - organization. `direct` means collaborators with permissions to a project, - regardless of organization membership status. `all` means all collaborators - the authenticated user can see. - in: query - required: false - schema: - type: string - enum: - - outside - - direct - - all - default: all - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *58 - headers: - Link: *54 - '404': *6 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators/{username}": - put: - summary: Add project collaborator - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/add-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator - parameters: - - *326 - - *59 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - description: The permission to grant the collaborator. - enum: - - read - - write - - admin - default: write - example: write - type: string - nullable: true - examples: - default: - summary: Applying write permissions for the new collaborator - value: - permission: write - responses: - '204': - description: Response - '404': *6 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Remove user as a collaborator - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/remove-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator - parameters: - - *326 - - *59 - responses: - '204': - description: Response - '304': *37 - '404': *6 - '403': *29 - '422': *15 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators/{username}/permission": - get: - summary: Get project permission for a user - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-permission-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user - parameters: - - *326 - - *59 - responses: - '200': - description: Response - content: - application/json: - schema: - title: Project Collaborator Permission - description: Project Collaborator Permission - type: object - properties: - permission: - type: string - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - required: - - permission - - user - examples: - default: - value: - permission: admin - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - '404': *6 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/rate_limit": get: summary: Get rate limit status for the authenticated user @@ -47996,7 +47279,7 @@ paths: resources: type: object properties: - core: &332 + core: &327 title: Rate Limit type: object properties: @@ -48013,21 +47296,21 @@ paths: - remaining - reset - used - graphql: *332 - search: *332 - code_search: *332 - source_import: *332 - integration_manifest: *332 - code_scanning_upload: *332 - actions_runner_registration: *332 - scim: *332 - dependency_snapshots: *332 - dependency_sbom: *332 - code_scanning_autofix: *332 + graphql: *327 + search: *327 + code_search: *327 + source_import: *327 + integration_manifest: *327 + code_scanning_upload: *327 + actions_runner_registration: *327 + scim: *327 + dependency_snapshots: *327 + dependency_sbom: *327 + code_scanning_autofix: *327 required: - core - search - rate: *332 + rate: *327 required: - rate - resources @@ -48132,14 +47415,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *333 + schema: *328 examples: default-response: summary: Default response @@ -48640,7 +47923,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *334 + '301': *329 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48658,8 +47941,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: false content: @@ -48906,10 +48189,10 @@ paths: description: Response content: application/json: - schema: *333 + schema: *328 examples: - default: *335 - '307': &336 + default: *330 + '307': &331 description: Temporary Redirect content: application/json: @@ -48938,8 +48221,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -48961,7 +48244,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *336 + '307': *331 '404': *6 '409': *47 x-github: @@ -48985,11 +48268,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 - - &367 + - &362 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -49012,7 +48295,7 @@ paths: type: integer artifacts: type: array - items: &337 + items: &332 title: Artifact description: An artifact type: object @@ -49090,7 +48373,7 @@ paths: - expires_at - updated_at examples: - default: &368 + default: &363 value: total_count: 2 artifacts: @@ -49151,9 +48434,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *327 - - *328 - - &338 + - *325 + - *326 + - &333 name: artifact_id description: The unique identifier of the artifact. in: path @@ -49165,7 +48448,7 @@ paths: description: Response content: application/json: - schema: *337 + schema: *332 examples: default: value: @@ -49203,9 +48486,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *327 - - *328 - - *338 + - *325 + - *326 + - *333 responses: '204': description: Response @@ -49229,9 +48512,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *327 - - *328 - - *338 + - *325 + - *326 + - *333 - name: archive_format in: path required: true @@ -49245,7 +48528,7 @@ paths: example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': &523 + '410': &518 description: Gone content: application/json: @@ -49272,14 +48555,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *339 + schema: *334 examples: default: value: @@ -49305,11 +48588,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 - - &340 + - &335 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -49343,7 +48626,7 @@ paths: description: Response content: application/json: - schema: &341 + schema: &336 title: Repository actions caches description: Repository actions caches type: object @@ -49385,7 +48668,7 @@ paths: - total_count - actions_caches examples: - default: &342 + default: &337 value: total_count: 1 actions_caches: @@ -49417,23 +48700,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *327 - - *328 + - *325 + - *326 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *340 + - *335 responses: '200': description: Response content: application/json: - schema: *341 + schema: *336 examples: - default: *342 + default: *337 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49453,8 +48736,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *327 - - *328 + - *325 + - *326 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -49485,9 +48768,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *327 - - *328 - - &343 + - *325 + - *326 + - &338 name: job_id description: The unique identifier of the job. in: path @@ -49499,7 +48782,7 @@ paths: description: Response content: application/json: - schema: &371 + schema: &366 title: Job description: Information of a job execution in a workflow run type: object @@ -49806,9 +49089,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *327 - - *328 - - *343 + - *325 + - *326 + - *338 responses: '302': description: Response @@ -49836,9 +49119,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *327 - - *328 - - *343 + - *325 + - *326 + - *338 requestBody: required: false content: @@ -49883,8 +49166,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Status response @@ -49934,8 +49217,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -49998,8 +49281,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -50017,7 +49300,7 @@ paths: type: integer secrets: type: array - items: &373 + items: &368 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -50037,7 +49320,7 @@ paths: - created_at - updated_at examples: - default: &374 + default: &369 value: total_count: 2 secrets: @@ -50070,9 +49353,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *327 - - *328 - - *344 + - *325 + - *326 + - *339 - *19 responses: '200': @@ -50089,7 +49372,7 @@ paths: type: integer variables: type: array - items: &377 + items: &372 title: Actions Variable type: object properties: @@ -50119,7 +49402,7 @@ paths: - created_at - updated_at examples: - default: &378 + default: &373 value: total_count: 2 variables: @@ -50152,8 +49435,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -50162,11 +49445,11 @@ paths: schema: type: object properties: - enabled: &346 + enabled: &341 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *128 - selected_actions_url: *345 + selected_actions_url: *340 sha_pinning_required: *129 required: - enabled @@ -50195,8 +49478,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -50207,7 +49490,7 @@ paths: schema: type: object properties: - enabled: *346 + enabled: *341 allowed_actions: *128 sha_pinning_required: *129 required: @@ -50239,14 +49522,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: &347 + schema: &342 type: object properties: access_level: @@ -50263,7 +49546,7 @@ paths: required: - access_level examples: - default: &348 + default: &343 value: access_level: organization x-github: @@ -50287,15 +49570,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: application/json: - schema: *347 + schema: *342 examples: - default: *348 + default: *343 responses: '204': description: Response @@ -50319,14 +49602,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *349 + schema: *344 examples: default: value: @@ -50350,8 +49633,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Empty response for successful settings update @@ -50361,7 +49644,7 @@ paths: required: true content: application/json: - schema: *350 + schema: *345 examples: default: summary: Set retention days @@ -50385,8 +49668,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -50394,7 +49677,7 @@ paths: application/json: schema: *130 examples: - default: *351 + default: *346 '404': *6 x-github: enabledForGitHubApps: true @@ -50413,8 +49696,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -50448,14 +49731,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *352 + schema: *347 examples: default: *131 '403': *29 @@ -50477,13 +49760,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: application/json: - schema: *353 + schema: *348 examples: default: *131 responses: @@ -50509,8 +49792,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -50537,8 +49820,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -50570,14 +49853,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *354 + schema: *349 examples: default: *138 x-github: @@ -50600,8 +49883,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Success response @@ -50612,7 +49895,7 @@ paths: required: true content: application/json: - schema: *355 + schema: *350 examples: default: *138 x-github: @@ -50641,8 +49924,8 @@ paths: in: query schema: type: string - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -50686,8 +49969,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -50695,9 +49978,9 @@ paths: application/json: schema: type: array - items: *356 + items: *351 examples: - default: *357 + default: *352 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50719,8 +50002,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -50763,7 +50046,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *358 + '201': *353 '404': *6 '422': *7 '409': *47 @@ -50794,8 +50077,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '201': description: Response @@ -50803,7 +50086,7 @@ paths: application/json: schema: *147 examples: - default: *359 + default: *354 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50831,8 +50114,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '201': description: Response @@ -50840,7 +50123,7 @@ paths: application/json: schema: *147 examples: - default: *360 + default: *355 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50862,8 +50145,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *144 responses: '200': @@ -50872,7 +50155,7 @@ paths: application/json: schema: *145 examples: - default: *361 + default: *356 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50893,8 +50176,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *144 responses: '204': @@ -50921,8 +50204,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *144 responses: '200': *149 @@ -50947,8 +50230,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *144 requestBody: required: true @@ -50997,8 +50280,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *144 requestBody: required: true @@ -51048,11 +50331,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *144 responses: - '200': *362 + '200': *357 '404': *6 x-github: githubCloudOnly: false @@ -51079,10 +50362,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *144 - - *363 + - *358 responses: '200': *149 '404': *6 @@ -51110,9 +50393,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *327 - - *328 - - &381 + - *325 + - *326 + - &376 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -51120,7 +50403,7 @@ paths: required: false schema: type: string - - &382 + - &377 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -51128,7 +50411,7 @@ paths: required: false schema: type: string - - &383 + - &378 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -51137,7 +50420,7 @@ paths: required: false schema: type: string - - &384 + - &379 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -51164,7 +50447,7 @@ paths: - pending - *17 - *19 - - &385 + - &380 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -51173,7 +50456,7 @@ paths: schema: type: string format: date-time - - &364 + - &359 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -51182,13 +50465,13 @@ paths: schema: type: boolean default: false - - &386 + - &381 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &387 + - &382 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -51211,7 +50494,7 @@ paths: type: integer workflow_runs: type: array - items: &365 + items: &360 title: Workflow Run description: An invocation of a workflow type: object @@ -51306,7 +50589,7 @@ paths: that triggered the run. type: array nullable: true - items: &406 + items: &401 title: Pull Request Minimal type: object properties: @@ -51425,7 +50708,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &410 + properties: &405 id: type: string description: SHA for the commit @@ -51476,7 +50759,7 @@ paths: - name - email nullable: true - required: &411 + required: &406 - id - tree_id - message @@ -51523,7 +50806,7 @@ paths: - workflow_url - pull_requests examples: - default: &388 + default: &383 value: total_count: 1 workflow_runs: @@ -51759,24 +51042,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *327 - - *328 - - &366 + - *325 + - *326 + - &361 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *364 + - *359 responses: '200': description: Response content: application/json: - schema: *365 + schema: *360 examples: - default: &369 + default: &364 value: id: 30433642 name: Build @@ -52017,9 +51300,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 responses: '204': description: Response @@ -52042,9 +51325,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 responses: '200': description: Response @@ -52163,9 +51446,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 responses: '201': description: Response @@ -52198,12 +51481,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 - *17 - *19 - - *367 + - *362 responses: '200': description: Response @@ -52219,9 +51502,9 @@ paths: type: integer artifacts: type: array - items: *337 + items: *332 examples: - default: *368 + default: *363 headers: Link: *54 x-github: @@ -52245,25 +51528,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *327 - - *328 - - *366 - - &370 + - *325 + - *326 + - *361 + - &365 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *364 + - *359 responses: '200': description: Response content: application/json: - schema: *365 + schema: *360 examples: - default: *369 + default: *364 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52286,10 +51569,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *327 - - *328 - - *366 - - *370 + - *325 + - *326 + - *361 + - *365 - *17 - *19 responses: @@ -52307,9 +51590,9 @@ paths: type: integer jobs: type: array - items: *371 + items: *366 examples: - default: &372 + default: &367 value: total_count: 1 jobs: @@ -52422,10 +51705,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *327 - - *328 - - *366 - - *370 + - *325 + - *326 + - *361 + - *365 responses: '302': description: Response @@ -52453,9 +51736,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 responses: '202': description: Response @@ -52488,9 +51771,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 requestBody: required: true content: @@ -52557,9 +51840,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 responses: '202': description: Response @@ -52592,9 +51875,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -52624,9 +51907,9 @@ paths: type: integer jobs: type: array - items: *371 + items: *366 examples: - default: *372 + default: *367 headers: Link: *54 x-github: @@ -52651,9 +51934,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 responses: '302': description: Response @@ -52680,9 +51963,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 responses: '204': description: Response @@ -52709,9 +51992,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 responses: '200': description: Response @@ -52771,7 +52054,7 @@ paths: items: type: object properties: - type: &489 + type: &484 type: string description: The type of reviewer. enum: @@ -52856,9 +52139,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 requestBody: required: true content: @@ -52905,7 +52188,7 @@ paths: application/json: schema: type: array - items: &484 + items: &479 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -53011,7 +52294,7 @@ paths: - created_at - updated_at examples: - default: &485 + default: &480 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -53067,9 +52350,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 requestBody: required: false content: @@ -53113,9 +52396,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 requestBody: required: false content: @@ -53168,9 +52451,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *327 - - *328 - - *366 + - *325 + - *326 + - *361 responses: '200': description: Response @@ -53307,8 +52590,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -53326,9 +52609,9 @@ paths: type: integer secrets: type: array - items: *373 + items: *368 examples: - default: *374 + default: *369 headers: Link: *54 x-github: @@ -53353,16 +52636,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *375 + schema: *370 examples: - default: *376 + default: *371 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53384,17 +52667,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *327 - - *328 + - *325 + - *326 - *151 responses: '200': description: Response content: application/json: - schema: *373 + schema: *368 examples: - default: &502 + default: &497 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -53420,8 +52703,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *327 - - *328 + - *325 + - *326 - *151 requestBody: required: true @@ -53479,8 +52762,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *327 - - *328 + - *325 + - *326 - *151 responses: '204': @@ -53506,9 +52789,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *327 - - *328 - - *344 + - *325 + - *326 + - *339 - *19 responses: '200': @@ -53525,9 +52808,9 @@ paths: type: integer variables: type: array - items: *377 + items: *372 examples: - default: *378 + default: *373 headers: Link: *54 x-github: @@ -53550,8 +52833,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -53603,17 +52886,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *327 - - *328 + - *325 + - *326 - *154 responses: '200': description: Response content: application/json: - schema: *377 + schema: *372 examples: - default: &503 + default: &498 value: name: USERNAME value: octocat @@ -53639,8 +52922,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *327 - - *328 + - *325 + - *326 - *154 requestBody: required: true @@ -53683,8 +52966,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *327 - - *328 + - *325 + - *326 - *154 responses: '204': @@ -53710,8 +52993,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -53729,7 +53012,7 @@ paths: type: integer workflows: type: array - items: &379 + items: &374 title: Workflow description: A GitHub Actions workflow type: object @@ -53836,9 +53119,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *327 - - *328 - - &380 + - *325 + - *326 + - &375 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -53853,7 +53136,7 @@ paths: description: Response content: application/json: - schema: *379 + schema: *374 examples: default: value: @@ -53886,9 +53169,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *327 - - *328 - - *380 + - *325 + - *326 + - *375 responses: '204': description: Response @@ -53913,9 +53196,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *327 - - *328 - - *380 + - *325 + - *326 + - *375 responses: '204': description: Response @@ -53966,9 +53249,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *327 - - *328 - - *380 + - *325 + - *326 + - *375 responses: '204': description: Response @@ -53995,19 +53278,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *327 - - *328 + - *325 + - *326 + - *375 + - *376 + - *377 + - *378 + - *379 + - *17 + - *19 - *380 + - *359 - *381 - *382 - - *383 - - *384 - - *17 - - *19 - - *385 - - *364 - - *386 - - *387 responses: '200': description: Response @@ -54023,9 +53306,9 @@ paths: type: integer workflow_runs: type: array - items: *365 + items: *360 examples: - default: *388 + default: *383 headers: Link: *54 x-github: @@ -54057,9 +53340,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *327 - - *328 - - *380 + - *325 + - *326 + - *375 responses: '200': description: Response @@ -54120,8 +53403,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *327 - - *328 + - *325 + - *326 - *48 - *17 - *40 @@ -54285,8 +53568,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -54323,8 +53606,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *327 - - *328 + - *325 + - *326 - name: assignee in: path required: true @@ -54360,8 +53643,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-attestation parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -54473,8 +53756,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-attestations parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *40 - *41 @@ -54531,7 +53814,7 @@ paths: initiator: type: string examples: - default: *389 + default: *384 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54551,8 +53834,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -54560,7 +53843,7 @@ paths: application/json: schema: type: array - items: &390 + items: &385 title: Autolink reference description: An autolink reference. type: object @@ -54614,8 +53897,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -54654,9 +53937,9 @@ paths: description: response content: application/json: - schema: *390 + schema: *385 examples: - default: &391 + default: &386 value: id: 1 key_prefix: TICKET- @@ -54687,9 +53970,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *327 - - *328 - - &392 + - *325 + - *326 + - &387 name: autolink_id description: The unique identifier of the autolink. in: path @@ -54701,9 +53984,9 @@ paths: description: Response content: application/json: - schema: *390 + schema: *385 examples: - default: *391 + default: *386 '404': *6 x-github: githubCloudOnly: false @@ -54723,9 +54006,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *327 - - *328 - - *392 + - *325 + - *326 + - *387 responses: '204': description: Response @@ -54749,8 +54032,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response if Dependabot is enabled @@ -54798,8 +54081,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -54820,8 +54103,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -54841,8 +54124,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *327 - - *328 + - *325 + - *326 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -54880,7 +54163,7 @@ paths: - url protected: type: boolean - protection: &394 + protection: &389 title: Branch Protection description: Branch Protection type: object @@ -54922,7 +54205,7 @@ paths: required: - contexts - checks - enforce_admins: &397 + enforce_admins: &392 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -54937,7 +54220,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &399 + required_pull_request_reviews: &394 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -55013,7 +54296,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &396 + restrictions: &391 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -55290,9 +54573,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *327 - - *328 - - &395 + - *325 + - *326 + - &390 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). @@ -55306,14 +54589,14 @@ paths: description: Response content: application/json: - schema: &405 + schema: &400 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &458 + commit: &453 title: Commit description: Commit type: object @@ -55347,7 +54630,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &393 + properties: &388 name: type: string example: '"Chris Wanstrath"' @@ -55356,13 +54639,14 @@ paths: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true committer: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *393 + properties: *388 nullable: true message: type: string @@ -55383,7 +54667,7 @@ paths: required: - sha - url - verification: &509 + verification: &504 title: Verification type: object properties: @@ -55453,7 +54737,7 @@ paths: type: integer files: type: array - items: &471 + items: &466 title: Diff Entry description: Diff Entry type: object @@ -55537,7 +54821,7 @@ paths: - self protected: type: boolean - protection: *394 + protection: *389 protection_url: type: string format: uri @@ -55644,7 +54928,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *334 + '301': *329 '404': *6 x-github: githubCloudOnly: false @@ -55666,15 +54950,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response content: application/json: - schema: *394 + schema: *389 examples: default: value: @@ -55868,9 +55152,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: true content: @@ -56125,7 +55409,7 @@ paths: url: type: string format: uri - required_status_checks: &402 + required_status_checks: &397 title: Status Check Policy description: Status Check Policy type: object @@ -56277,7 +55561,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *396 + restrictions: *391 required_conversation_resolution: type: object properties: @@ -56389,9 +55673,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '204': description: Response @@ -56416,17 +55700,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response content: application/json: - schema: *397 + schema: *392 examples: - default: &398 + default: &393 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -56448,17 +55732,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response content: application/json: - schema: *397 + schema: *392 examples: - default: *398 + default: *393 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56477,9 +55761,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '204': description: Response @@ -56504,17 +55788,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response content: application/json: - schema: *399 + schema: *394 examples: - default: &400 + default: &395 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -56610,9 +55894,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: false content: @@ -56710,9 +55994,9 @@ paths: description: Response content: application/json: - schema: *399 + schema: *394 examples: - default: *400 + default: *395 '422': *15 x-github: githubCloudOnly: false @@ -56733,9 +56017,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '204': description: Response @@ -56762,17 +56046,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response content: application/json: - schema: *397 + schema: *392 examples: - default: &401 + default: &396 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -56795,17 +56079,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response content: application/json: - schema: *397 + schema: *392 examples: - default: *401 + default: *396 '404': *6 x-github: githubCloudOnly: false @@ -56825,9 +56109,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '204': description: Response @@ -56852,17 +56136,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response content: application/json: - schema: *402 + schema: *397 examples: - default: &403 + default: &398 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -56888,9 +56172,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: false content: @@ -56942,9 +56226,9 @@ paths: description: Response content: application/json: - schema: *402 + schema: *397 examples: - default: *403 + default: *398 '404': *6 '422': *15 x-github: @@ -56966,9 +56250,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '204': description: Response @@ -56992,9 +56276,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response @@ -57028,9 +56312,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: false content: @@ -57097,9 +56381,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: false content: @@ -57163,9 +56447,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: content: application/json: @@ -57231,15 +56515,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response content: application/json: - schema: *396 + schema: *391 examples: default: value: @@ -57330,9 +56614,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '204': description: Response @@ -57355,9 +56639,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response @@ -57367,7 +56651,7 @@ paths: type: array items: *5 examples: - default: &404 + default: &399 value: - id: 1 slug: octoapp @@ -57424,9 +56708,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: true content: @@ -57460,7 +56744,7 @@ paths: type: array items: *5 examples: - default: *404 + default: *399 '422': *15 x-github: githubCloudOnly: false @@ -57481,9 +56765,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: true content: @@ -57517,7 +56801,7 @@ paths: type: array items: *5 examples: - default: *404 + default: *399 '422': *15 x-github: githubCloudOnly: false @@ -57538,9 +56822,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: true content: @@ -57574,7 +56858,7 @@ paths: type: array items: *5 examples: - default: *404 + default: *399 '422': *15 x-github: githubCloudOnly: false @@ -57596,9 +56880,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response @@ -57628,9 +56912,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: false content: @@ -57689,9 +56973,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: false content: @@ -57750,9 +57034,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: content: application/json: @@ -57811,9 +57095,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 responses: '200': description: Response @@ -57847,9 +57131,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: true content: @@ -57907,9 +57191,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: true content: @@ -57967,9 +57251,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: true content: @@ -58029,9 +57313,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 requestBody: required: true content: @@ -58053,7 +57337,7 @@ paths: description: Response content: application/json: - schema: *405 + schema: *400 examples: default: value: @@ -58169,8 +57453,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -58449,7 +57733,7 @@ paths: description: Response content: application/json: - schema: &407 + schema: &402 title: CheckRun description: A check performed on the code of a given code change type: object @@ -58568,8 +57852,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *406 - deployment: &714 + items: *401 + deployment: &708 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -58849,9 +58133,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *327 - - *328 - - &408 + - *325 + - *326 + - &403 name: check_run_id description: The unique identifier of the check run. in: path @@ -58863,9 +58147,9 @@ paths: description: Response content: application/json: - schema: *407 + schema: *402 examples: - default: &409 + default: &404 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -58965,9 +58249,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *327 - - *328 - - *408 + - *325 + - *326 + - *403 requestBody: required: true content: @@ -59207,9 +58491,9 @@ paths: description: Response content: application/json: - schema: *407 + schema: *402 examples: - default: *409 + default: *404 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59229,9 +58513,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *327 - - *328 - - *408 + - *325 + - *326 + - *403 - *17 - *19 responses: @@ -59326,9 +58610,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *327 - - *328 - - *408 + - *325 + - *326 + - *403 responses: '201': description: Response @@ -59372,8 +58656,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -59395,7 +58679,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &412 + schema: &407 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -59459,7 +58743,7 @@ paths: nullable: true pull_requests: type: array - items: *406 + items: *401 nullable: true app: title: GitHub app @@ -59481,12 +58765,12 @@ paths: type: string format: date-time nullable: true - head_commit: &740 + head_commit: &734 title: Simple Commit description: A commit. type: object - properties: *410 - required: *411 + properties: *405 + required: *406 latest_check_runs_count: type: integer check_runs_url: @@ -59514,7 +58798,7 @@ paths: - check_runs_url - pull_requests examples: - default: &413 + default: &408 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -59805,9 +59089,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *412 + schema: *407 examples: - default: *413 + default: *408 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59826,8 +59110,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -60136,9 +59420,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *327 - - *328 - - &414 + - *325 + - *326 + - &409 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -60150,9 +59434,9 @@ paths: description: Response content: application/json: - schema: *412 + schema: *407 examples: - default: *413 + default: *408 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60175,17 +59459,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *327 - - *328 - - *414 - - &464 + - *325 + - *326 + - *409 + - &459 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &465 + - &460 name: status description: Returns check runs with the specified `status`. in: query @@ -60224,9 +59508,9 @@ paths: type: integer check_runs: type: array - items: *407 + items: *402 examples: - default: &466 + default: &461 value: total_count: 1 check_runs: @@ -60328,9 +59612,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *327 - - *328 - - *414 + - *325 + - *326 + - *409 responses: '201': description: Response @@ -60363,21 +59647,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *327 - - *328 - - *415 - - *416 + - *325 + - *326 + - *410 + - *411 - *19 - *17 - - &433 + - &428 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *417 - - &434 + schema: *412 + - &429 name: pr description: The number of the pull request for the results you want to list. in: query @@ -60402,13 +59686,13 @@ paths: be returned. in: query required: false - schema: *418 + schema: *413 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *419 + schema: *414 responses: '200': description: Response @@ -60424,7 +59708,7 @@ paths: updated_at: *163 url: *164 html_url: *165 - instances_url: *420 + instances_url: *415 state: *170 fixed_at: *166 dismissed_by: @@ -60435,11 +59719,11 @@ paths: required: *21 nullable: true dismissed_at: *167 - dismissed_reason: *421 - dismissed_comment: *422 - rule: *423 - tool: *424 - most_recent_instance: *425 + dismissed_reason: *416 + dismissed_comment: *417 + rule: *418 + tool: *419 + most_recent_instance: *420 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -60565,7 +59849,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &426 + '403': &421 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -60592,9 +59876,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *327 - - *328 - - &427 + - *325 + - *326 + - &422 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -60608,7 +59892,7 @@ paths: description: Response content: application/json: - schema: &428 + schema: &423 type: object properties: number: *161 @@ -60616,7 +59900,7 @@ paths: updated_at: *163 url: *164 html_url: *165 - instances_url: *420 + instances_url: *415 state: *170 fixed_at: *166 dismissed_by: @@ -60627,8 +59911,8 @@ paths: required: *21 nullable: true dismissed_at: *167 - dismissed_reason: *421 - dismissed_comment: *422 + dismissed_reason: *416 + dismissed_comment: *417 rule: type: object properties: @@ -60682,8 +59966,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *424 - most_recent_instance: *425 + tool: *419 + most_recent_instance: *420 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -60782,7 +60066,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *426 + '403': *421 '404': *6 '503': *104 x-github: @@ -60802,9 +60086,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *327 - - *328 - - *427 + - *325 + - *326 + - *422 requestBody: required: true content: @@ -60819,8 +60103,8 @@ paths: enum: - open - dismissed - dismissed_reason: *421 - dismissed_comment: *422 + dismissed_reason: *416 + dismissed_comment: *417 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -60839,7 +60123,7 @@ paths: description: Response content: application/json: - schema: *428 + schema: *423 examples: default: value: @@ -60915,7 +60199,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &432 + '403': &427 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -60942,15 +60226,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *327 - - *328 - - *427 + - *325 + - *326 + - *422 responses: '200': description: Response content: application/json: - schema: &429 + schema: &424 type: object properties: status: @@ -60976,13 +60260,13 @@ paths: - description - started_at examples: - default: &430 + default: &425 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &431 + '400': &426 description: Bad Request content: application/json: @@ -60993,7 +60277,7 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *426 + '403': *421 '404': *6 '503': *104 x-github: @@ -61018,29 +60302,29 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *327 - - *328 - - *427 + - *325 + - *326 + - *422 responses: '200': description: OK content: application/json: - schema: *429 + schema: *424 examples: - default: *430 + default: *425 '202': description: Accepted content: application/json: - schema: *429 + schema: *424 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *431 + '400': *426 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -61072,9 +60356,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *327 - - *328 - - *427 + - *325 + - *326 + - *422 requestBody: required: false content: @@ -61119,8 +60403,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *431 - '403': *432 + '400': *426 + '403': *427 '404': *6 '422': description: Unprocessable Entity @@ -61144,13 +60428,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *327 - - *328 - - *427 + - *325 + - *326 + - *422 - *19 - *17 - - *433 - - *434 + - *428 + - *429 responses: '200': description: Response @@ -61158,7 +60442,7 @@ paths: application/json: schema: type: array - items: *425 + items: *420 examples: default: value: @@ -61197,7 +60481,7 @@ paths: end_column: 50 classifications: - source - '403': *426 + '403': *421 '404': *6 '503': *104 x-github: @@ -61231,25 +60515,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *327 - - *328 - - *415 - - *416 + - *325 + - *326 + - *410 + - *411 - *19 - *17 - - *434 + - *429 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *417 + schema: *412 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &437 + schema: &432 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -61270,23 +60554,23 @@ paths: application/json: schema: type: array - items: &438 + items: &433 type: object properties: - ref: *417 - commit_sha: &446 + ref: *412 + commit_sha: &441 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *435 + analysis_key: *430 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *436 + category: *431 error: type: string example: error reading field xyz @@ -61310,8 +60594,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *437 - tool: *424 + sarif_id: *432 + tool: *419 deletable: type: boolean warning: @@ -61372,7 +60656,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *426 + '403': *421 '404': *6 '503': *104 x-github: @@ -61408,8 +60692,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -61422,7 +60706,7 @@ paths: description: Response content: application/json: - schema: *438 + schema: *433 examples: response: summary: application/json response @@ -61476,7 +60760,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *426 + '403': *421 '404': *6 '422': description: Response if analysis could not be processed @@ -61563,8 +60847,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -61617,7 +60901,7 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *432 + '403': *427 '404': *6 '503': *104 x-github: @@ -61639,8 +60923,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -61648,7 +60932,7 @@ paths: application/json: schema: type: array - items: &439 + items: &434 title: CodeQL Database description: A CodeQL database. type: object @@ -61759,7 +61043,7 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *426 + '403': *421 '404': *6 '503': *104 x-github: @@ -61788,8 +61072,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - name: language in: path description: The language of the CodeQL database. @@ -61801,7 +61085,7 @@ paths: description: Response content: application/json: - schema: *439 + schema: *434 examples: default: value: @@ -61833,9 +61117,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &473 + '302': &468 description: Found - '403': *426 + '403': *421 '404': *6 '503': *104 x-github: @@ -61857,8 +61141,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *327 - - *328 + - *325 + - *326 - name: language in: path description: The language of the CodeQL database. @@ -61868,7 +61152,7 @@ paths: responses: '204': description: Response - '403': *432 + '403': *427 '404': *6 '503': *104 x-github: @@ -61896,8 +61180,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -61906,7 +61190,7 @@ paths: type: object additionalProperties: false properties: - language: &440 + language: &435 type: string description: The language targeted by the CodeQL query enum: @@ -61986,7 +61270,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &444 + schema: &439 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -61996,7 +61280,7 @@ paths: description: The ID of the variant analysis. controller_repo: *53 actor: *4 - query_language: *440 + query_language: *435 query_pack_url: type: string description: The download url for the query pack. @@ -62043,7 +61327,7 @@ paths: items: type: object properties: - repository: &441 + repository: &436 title: Repository Identifier description: Repository Identifier type: object @@ -62079,7 +61363,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &445 + analysis_status: &440 type: string description: The new status of the CodeQL variant analysis repository task. @@ -62111,7 +61395,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &442 + access_mismatch_repos: &437 type: object properties: repository_count: @@ -62125,7 +61409,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *441 + items: *436 required: - repository_count - repositories @@ -62147,8 +61431,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *442 - over_limit_repos: *442 + no_codeql_db_repos: *437 + over_limit_repos: *437 required: - access_mismatch_repos - not_found_repos @@ -62164,7 +61448,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &443 + value: &438 summary: Default response value: id: 1 @@ -62316,10 +61600,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *443 + value: *438 repository_lists: summary: Response for a successful variant analysis submission - value: *443 + value: *438 '404': *6 '422': description: Unable to process variant analysis submission @@ -62347,8 +61631,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *327 - - *328 + - *325 + - *326 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -62360,9 +61644,9 @@ paths: description: Response content: application/json: - schema: *444 + schema: *439 examples: - default: *443 + default: *438 '404': *6 '503': *104 x-github: @@ -62385,7 +61669,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *327 + - *325 - name: repo in: path description: The name of the controller repository. @@ -62420,7 +61704,7 @@ paths: type: object properties: repository: *53 - analysis_status: *445 + analysis_status: *440 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -62545,8 +61829,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -62631,7 +61915,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *426 + '403': *421 '404': *6 '503': *104 x-github: @@ -62652,8 +61936,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -62745,7 +62029,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *432 + '403': *427 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -62816,8 +62100,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -62825,7 +62109,7 @@ paths: schema: type: object properties: - commit_sha: *446 + commit_sha: *441 ref: type: string description: |- @@ -62883,7 +62167,7 @@ paths: schema: type: object properties: - id: *437 + id: *432 url: type: string description: The REST API URL for checking the status of the upload. @@ -62897,7 +62181,7 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *432 + '403': *427 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -62920,8 +62204,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *327 - - *328 + - *325 + - *326 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -62967,7 +62251,7 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *426 + '403': *421 '404': description: Not Found if the sarif id does not match any upload '503': *104 @@ -62992,8 +62276,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -63074,8 +62358,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *327 - - *328 + - *325 + - *326 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -63195,8 +62479,8 @@ paths: parameters: - *17 - *19 - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -63510,8 +62794,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -63576,7 +62860,7 @@ paths: application/json: schema: *224 examples: - default: *447 + default: *442 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -63584,7 +62868,7 @@ paths: application/json: schema: *224 examples: - default: *447 + default: *442 '400': *14 '401': *25 '403': *29 @@ -63613,8 +62897,8 @@ paths: parameters: - *17 - *19 - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -63678,8 +62962,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -63714,14 +62998,14 @@ paths: type: integer machines: type: array - items: &669 + items: &663 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *448 - required: *449 + properties: *443 + required: *444 examples: - default: &670 + default: &664 value: total_count: 2 machines: @@ -63761,8 +63045,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *327 - - *328 + - *325 + - *326 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -63846,8 +63130,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *327 - - *328 + - *325 + - *326 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -63913,8 +63197,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -63932,7 +63216,7 @@ paths: type: integer secrets: type: array - items: &453 + items: &448 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -63952,7 +63236,7 @@ paths: - created_at - updated_at examples: - default: *450 + default: *445 headers: Link: *54 x-github: @@ -63975,16 +63259,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *451 + schema: *446 examples: - default: *452 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64004,17 +63288,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *327 - - *328 + - *325 + - *326 - *151 responses: '200': description: Response content: application/json: - schema: *453 + schema: *448 examples: - default: *454 + default: *449 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64034,8 +63318,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *327 - - *328 + - *325 + - *326 - *151 requestBody: required: true @@ -64088,8 +63372,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *327 - - *328 + - *325 + - *326 - *151 responses: '204': @@ -64118,8 +63402,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *327 - - *328 + - *325 + - *326 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -64161,7 +63445,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &455 + properties: &450 login: type: string example: octocat @@ -64254,7 +63538,7 @@ paths: user_view_type: type: string example: public - required: &456 + required: &451 - avatar_url - events_url - followers_url @@ -64328,8 +63612,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *327 - - *328 + - *325 + - *326 - *59 responses: '204': @@ -64376,8 +63660,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *327 - - *328 + - *325 + - *326 - *59 requestBody: required: false @@ -64404,7 +63688,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &522 + schema: &517 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -64633,8 +63917,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *327 - - *328 + - *325 + - *326 - *59 responses: '204': @@ -64666,8 +63950,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *327 - - *328 + - *325 + - *326 - *59 responses: '200': @@ -64688,8 +63972,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *455 - required: *456 + properties: *450 + required: *451 nullable: true required: - permission @@ -64744,8 +64028,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -64755,7 +64039,7 @@ paths: application/json: schema: type: array - items: &457 + items: &452 title: Commit Comment description: Commit Comment type: object @@ -64813,7 +64097,7 @@ paths: - created_at - updated_at examples: - default: &460 + default: &455 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -64872,17 +64156,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 responses: '200': description: Response content: application/json: - schema: *457 + schema: *452 examples: - default: &461 + default: &456 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -64939,8 +64223,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 requestBody: required: true @@ -64963,7 +64247,7 @@ paths: description: Response content: application/json: - schema: *457 + schema: *452 examples: default: value: @@ -65014,8 +64298,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 responses: '204': @@ -65037,8 +64321,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -65088,8 +64372,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 requestBody: required: true @@ -65153,8 +64437,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *327 - - *328 + - *325 + - *326 - *81 - *323 responses: @@ -65205,8 +64489,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *327 - - *328 + - *325 + - *326 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -65262,9 +64546,9 @@ paths: application/json: schema: type: array - items: *458 + items: *453 examples: - default: &575 + default: &570 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -65358,9 +64642,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *327 - - *328 - - &459 + - *325 + - *326 + - &454 name: commit_sha description: The SHA of the commit. in: path @@ -65432,9 +64716,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *327 - - *328 - - *459 + - *325 + - *326 + - *454 - *17 - *19 responses: @@ -65444,9 +64728,9 @@ paths: application/json: schema: type: array - items: *457 + items: *452 examples: - default: *460 + default: *455 headers: Link: *54 x-github: @@ -65474,9 +64758,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *327 - - *328 - - *459 + - *325 + - *326 + - *454 requestBody: required: true content: @@ -65511,9 +64795,9 @@ paths: description: Response content: application/json: - schema: *457 + schema: *452 examples: - default: *461 + default: *456 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -65541,9 +64825,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *327 - - *328 - - *459 + - *325 + - *326 + - *454 - *17 - *19 responses: @@ -65553,9 +64837,9 @@ paths: application/json: schema: type: array - items: *462 + items: *457 examples: - default: &567 + default: &562 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -66092,11 +65376,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *327 - - *328 + - *325 + - *326 - *19 - *17 - - &463 + - &458 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -66111,9 +65395,9 @@ paths: description: Response content: application/json: - schema: *458 + schema: *453 examples: - default: &552 + default: &547 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -66226,11 +65510,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *327 - - *328 - - *463 - - *464 - - *465 + - *325 + - *326 + - *458 + - *459 + - *460 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -66264,9 +65548,9 @@ paths: type: integer check_runs: type: array - items: *407 + items: *402 examples: - default: *466 + default: *461 headers: Link: *54 x-github: @@ -66291,9 +65575,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *327 - - *328 - - *463 + - *325 + - *326 + - *458 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -66301,7 +65585,7 @@ paths: schema: type: integer example: 1 - - *464 + - *459 - *17 - *19 responses: @@ -66319,7 +65603,7 @@ paths: type: integer check_suites: type: array - items: *412 + items: *407 examples: default: value: @@ -66519,9 +65803,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *327 - - *328 - - *463 + - *325 + - *326 + - *458 - *17 - *19 responses: @@ -66719,9 +66003,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *327 - - *328 - - *463 + - *325 + - *326 + - *458 - *17 - *19 responses: @@ -66731,7 +66015,7 @@ paths: application/json: schema: type: array - items: &640 + items: &636 title: Status description: The status of a commit. type: object @@ -66812,7 +66096,7 @@ paths: site_admin: false headers: Link: *54 - '301': *334 + '301': *329 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66840,8 +66124,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -66870,20 +66154,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *467 - required: *468 + properties: *462 + required: *463 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &469 + properties: &464 url: type: string format: uri html_url: type: string format: uri - required: &470 + required: &465 - url - html_url nullable: true @@ -66897,26 +66181,26 @@ paths: contributing: title: Community Health File type: object - properties: *469 - required: *470 + properties: *464 + required: *465 nullable: true readme: title: Community Health File type: object - properties: *469 - required: *470 + properties: *464 + required: *465 nullable: true issue_template: title: Community Health File type: object - properties: *469 - required: *470 + properties: *464 + required: *465 nullable: true pull_request_template: title: Community Health File type: object - properties: *469 - required: *470 + properties: *464 + required: *465 nullable: true required: - code_of_conduct @@ -67043,8 +66327,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *327 - - *328 + - *325 + - *326 - *19 - *17 - name: basehead @@ -67087,8 +66371,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *458 - merge_base_commit: *458 + base_commit: *453 + merge_base_commit: *453 status: type: string enum: @@ -67108,10 +66392,10 @@ paths: example: 6 commits: type: array - items: *458 + items: *453 files: type: array - items: *471 + items: *466 required: - url - html_url @@ -67397,8 +66681,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *327 - - *328 + - *325 + - *326 - name: path description: path parameter in: path @@ -67541,7 +66825,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &472 + response-if-content-is-a-file: &467 summary: Response if content is a file value: type: file @@ -67673,7 +66957,7 @@ paths: - size - type - url - - &580 + - &575 title: Content File description: Content File type: object @@ -67874,7 +67158,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *472 + response-if-content-is-a-file: *467 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -67943,7 +67227,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *473 + '302': *468 '304': *37 x-github: githubCloudOnly: false @@ -67966,8 +67250,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *327 - - *328 + - *325 + - *326 - name: path description: path parameter in: path @@ -68060,7 +67344,7 @@ paths: description: Response content: application/json: - schema: &474 + schema: &469 title: File Commit description: File Commit type: object @@ -68212,7 +67496,7 @@ paths: description: Response content: application/json: - schema: *474 + schema: *469 examples: example-for-creating-a-file: value: @@ -68266,7 +67550,7 @@ paths: schema: oneOf: - *3 - - &504 + - &499 description: Repository rule violation was detected type: object properties: @@ -68287,7 +67571,7 @@ paths: items: type: object properties: - placeholder_id: &632 + placeholder_id: &628 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -68319,8 +67603,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *327 - - *328 + - *325 + - *326 - name: path description: path parameter in: path @@ -68381,7 +67665,7 @@ paths: description: Response content: application/json: - schema: *474 + schema: *469 examples: default: value: @@ -68436,8 +67720,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *327 - - *328 + - *325 + - *326 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -68560,8 +67844,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *182 - *183 - *184 @@ -68573,7 +67857,7 @@ paths: schema: type: string - *186 - - *475 + - *470 - *187 - *188 - *48 @@ -68594,7 +67878,7 @@ paths: application/json: schema: type: array - items: &478 + items: &473 type: object description: A Dependabot alert. properties: @@ -68640,7 +67924,7 @@ paths: - unknown - direct - transitive - security_advisory: *476 + security_advisory: *471 security_vulnerability: *52 url: *164 html_url: *165 @@ -68671,7 +67955,7 @@ paths: nullable: true maxLength: 280 fixed_at: *166 - auto_dismissed_at: *477 + auto_dismissed_at: *472 required: - number - state @@ -68901,9 +68185,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *327 - - *328 - - &479 + - *325 + - *326 + - &474 name: alert_number in: path description: |- @@ -68918,7 +68202,7 @@ paths: description: Response content: application/json: - schema: *478 + schema: *473 examples: default: value: @@ -69031,9 +68315,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *327 - - *328 - - *479 + - *325 + - *326 + - *474 requestBody: required: true content: @@ -69078,7 +68362,7 @@ paths: description: Response content: application/json: - schema: *478 + schema: *473 examples: default: value: @@ -69207,8 +68491,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -69226,7 +68510,7 @@ paths: type: integer secrets: type: array - items: &482 + items: &477 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -69279,16 +68563,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *480 + schema: *475 examples: - default: *481 + default: *476 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69308,15 +68592,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *327 - - *328 + - *325 + - *326 - *151 responses: '200': description: Response content: application/json: - schema: *482 + schema: *477 examples: default: value: @@ -69342,8 +68626,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *327 - - *328 + - *325 + - *326 - *151 requestBody: required: true @@ -69396,8 +68680,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *327 - - *328 + - *325 + - *326 - *151 responses: '204': @@ -69420,8 +68704,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *327 - - *328 + - *325 + - *326 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -69581,8 +68865,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -69821,8 +69105,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -69897,7 +69181,7 @@ paths: - version - url additionalProperties: false - metadata: &483 + metadata: &478 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -69930,7 +69214,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *483 + metadata: *478 resolved: type: object description: A collection of resolved package dependencies. @@ -69943,7 +69227,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *483 + metadata: *478 relationship: type: string description: A notation of whether a dependency is requested @@ -70072,8 +69356,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *327 - - *328 + - *325 + - *326 - name: sha description: The SHA recorded at creation time. in: query @@ -70113,9 +69397,9 @@ paths: application/json: schema: type: array - items: *484 + items: *479 examples: - default: *485 + default: *480 headers: Link: *54 x-github: @@ -70181,8 +69465,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -70263,7 +69547,7 @@ paths: description: Response content: application/json: - schema: *484 + schema: *479 examples: simple-example: summary: Simple example @@ -70336,9 +69620,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *327 - - *328 - - &486 + - *325 + - *326 + - &481 name: deployment_id description: deployment_id parameter in: path @@ -70350,7 +69634,7 @@ paths: description: Response content: application/json: - schema: *484 + schema: *479 examples: default: value: @@ -70415,9 +69699,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *327 - - *328 - - *486 + - *325 + - *326 + - *481 responses: '204': description: Response @@ -70439,9 +69723,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *327 - - *328 - - *486 + - *325 + - *326 + - *481 - *17 - *19 responses: @@ -70451,7 +69735,7 @@ paths: application/json: schema: type: array - items: &487 + items: &482 title: Deployment Status description: The status of a deployment. type: object @@ -70612,9 +69896,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *327 - - *328 - - *486 + - *325 + - *326 + - *481 requestBody: required: true content: @@ -70689,9 +69973,9 @@ paths: description: Response content: application/json: - schema: *487 + schema: *482 examples: - default: &488 + default: &483 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -70747,9 +70031,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *327 - - *328 - - *486 + - *325 + - *326 + - *481 - name: status_id in: path required: true @@ -70760,9 +70044,9 @@ paths: description: Response content: application/json: - schema: *487 + schema: *482 examples: - default: *488 + default: *483 '404': *6 x-github: githubCloudOnly: false @@ -70787,8 +70071,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -70845,8 +70129,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -70863,7 +70147,7 @@ paths: type: integer environments: type: array - items: &490 + items: &485 title: Environment description: Details of a deployment environment type: object @@ -70915,7 +70199,7 @@ paths: type: type: string example: wait_timer - wait_timer: &492 + wait_timer: &487 type: integer example: 30 description: The amount of time to delay a job after @@ -70952,7 +70236,7 @@ paths: items: type: object properties: - type: *489 + type: *484 reviewer: anyOf: - *4 @@ -70976,7 +70260,7 @@ paths: - id - node_id - type - deployment_branch_policy: &493 + deployment_branch_policy: &488 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -71092,9 +70376,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *327 - - *328 - - &491 + - *325 + - *326 + - &486 name: environment_name in: path required: true @@ -71107,9 +70391,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *485 examples: - default: &494 + default: &489 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -71193,9 +70477,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 requestBody: required: false content: @@ -71204,7 +70488,7 @@ paths: type: object nullable: true properties: - wait_timer: *492 + wait_timer: *487 prevent_self_review: type: boolean example: false @@ -71221,13 +70505,13 @@ paths: items: type: object properties: - type: *489 + type: *484 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *493 + deployment_branch_policy: *488 additionalProperties: false examples: default: @@ -71247,9 +70531,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *485 examples: - default: *494 + default: *489 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -71273,9 +70557,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 responses: '204': description: Default response @@ -71300,9 +70584,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 - *17 - *19 responses: @@ -71320,7 +70604,7 @@ paths: example: 2 branch_policies: type: array - items: &495 + items: &490 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -71377,9 +70661,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 requestBody: required: true content: @@ -71425,9 +70709,9 @@ paths: description: Response content: application/json: - schema: *495 + schema: *490 examples: - example-wildcard: &496 + example-wildcard: &491 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -71469,10 +70753,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *327 - - *328 - - *491 - - &497 + - *325 + - *326 + - *486 + - &492 name: branch_policy_id in: path required: true @@ -71484,9 +70768,9 @@ paths: description: Response content: application/json: - schema: *495 + schema: *490 examples: - default: *496 + default: *491 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71505,10 +70789,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *327 - - *328 - - *491 - - *497 + - *325 + - *326 + - *486 + - *492 requestBody: required: true content: @@ -71536,9 +70820,9 @@ paths: description: Response content: application/json: - schema: *495 + schema: *490 examples: - default: *496 + default: *491 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71557,10 +70841,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *327 - - *328 - - *491 - - *497 + - *325 + - *326 + - *486 + - *492 responses: '204': description: Response @@ -71585,9 +70869,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *491 - - *328 - - *327 + - *486 + - *326 + - *325 responses: '200': description: List of deployment protection rules @@ -71603,7 +70887,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &498 + items: &493 title: Deployment protection rule description: Deployment protection rule type: object @@ -71622,7 +70906,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &499 + app: &494 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -71721,9 +71005,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *491 - - *328 - - *327 + - *486 + - *326 + - *325 requestBody: content: application/json: @@ -71744,9 +71028,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *498 + schema: *493 examples: - default: &500 + default: &495 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -71781,9 +71065,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *491 - - *328 - - *327 + - *486 + - *326 + - *325 - *19 - *17 responses: @@ -71802,7 +71086,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *499 + items: *494 examples: default: value: @@ -71837,10 +71121,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *327 - - *328 - - *491 - - &501 + - *325 + - *326 + - *486 + - &496 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -71852,9 +71136,9 @@ paths: description: Response content: application/json: - schema: *498 + schema: *493 examples: - default: *500 + default: *495 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71875,10 +71159,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *491 - - *328 - - *327 - - *501 + - *486 + - *326 + - *325 + - *496 responses: '204': description: Response @@ -71904,9 +71188,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 - *17 - *19 responses: @@ -71924,9 +71208,9 @@ paths: type: integer secrets: type: array - items: *373 + items: *368 examples: - default: *374 + default: *369 headers: Link: *54 x-github: @@ -71951,17 +71235,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 responses: '200': description: Response content: application/json: - schema: *375 + schema: *370 examples: - default: *376 + default: *371 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71983,18 +71267,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 - *151 responses: '200': description: Response content: application/json: - schema: *373 + schema: *368 examples: - default: *502 + default: *497 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72016,9 +71300,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 - *151 requestBody: required: true @@ -72076,9 +71360,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 - *151 responses: '204': @@ -72104,10 +71388,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *327 - - *328 - - *491 - - *344 + - *325 + - *326 + - *486 + - *339 - *19 responses: '200': @@ -72124,9 +71408,9 @@ paths: type: integer variables: type: array - items: *377 + items: *372 examples: - default: *378 + default: *373 headers: Link: *54 x-github: @@ -72149,9 +71433,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 requestBody: required: true content: @@ -72203,18 +71487,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *327 - - *328 - - *491 + - *325 + - *326 + - *486 - *154 responses: '200': description: Response content: application/json: - schema: *377 + schema: *372 examples: - default: *503 + default: *498 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72235,10 +71519,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *327 - - *328 + - *325 + - *326 - *154 - - *491 + - *486 requestBody: required: true content: @@ -72280,10 +71564,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *327 - - *328 + - *325 + - *326 - *154 - - *491 + - *486 responses: '204': description: Response @@ -72305,8 +71589,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -72374,8 +71658,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *327 - - *328 + - *325 + - *326 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -72534,8 +71818,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: false content: @@ -72567,9 +71851,9 @@ paths: description: Response content: application/json: - schema: *333 + schema: *328 examples: - default: *335 + default: *330 '400': *14 '422': *15 '403': *29 @@ -72590,8 +71874,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -72651,7 +71935,7 @@ paths: schema: oneOf: - *112 - - *504 + - *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72676,8 +71960,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *327 - - *328 + - *325 + - *326 - name: file_sha in: path required: true @@ -72776,8 +72060,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -72886,7 +72170,7 @@ paths: description: Response content: application/json: - schema: &505 + schema: &500 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -73100,15 +72384,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *327 - - *328 - - *459 + - *325 + - *326 + - *454 responses: '200': description: Response content: application/json: - schema: *505 + schema: *500 examples: default: value: @@ -73164,9 +72448,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *327 - - *328 - - &506 + - *325 + - *326 + - &501 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -73183,7 +72467,7 @@ paths: application/json: schema: type: array - items: &507 + items: &502 title: Git Reference description: Git references within a repository type: object @@ -73258,17 +72542,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *327 - - *328 - - *506 + - *325 + - *326 + - *501 responses: '200': description: Response content: application/json: - schema: *507 + schema: *502 examples: - default: &508 + default: &503 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -73297,8 +72581,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -73327,9 +72611,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *502 examples: - default: *508 + default: *503 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -73355,9 +72639,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *327 - - *328 - - *506 + - *325 + - *326 + - *501 requestBody: required: true content: @@ -73386,9 +72670,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *502 examples: - default: *508 + default: *503 '422': *15 '409': *47 x-github: @@ -73406,9 +72690,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *327 - - *328 - - *506 + - *325 + - *326 + - *501 responses: '204': description: Response @@ -73463,8 +72747,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -73531,7 +72815,7 @@ paths: description: Response content: application/json: - schema: &510 + schema: &505 title: Git Tag description: Metadata for a Git tag type: object @@ -73582,7 +72866,7 @@ paths: - sha - type - url - verification: *509 + verification: *504 required: - sha - url @@ -73592,7 +72876,7 @@ paths: - tag - message examples: - default: &511 + default: &506 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -73665,8 +72949,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *327 - - *328 + - *325 + - *326 - name: tag_sha in: path required: true @@ -73677,9 +72961,9 @@ paths: description: Response content: application/json: - schema: *510 + schema: *505 examples: - default: *511 + default: *506 '404': *6 '409': *47 x-github: @@ -73703,8 +72987,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -73777,7 +73061,7 @@ paths: description: Response content: application/json: - schema: &512 + schema: &507 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -73873,8 +73157,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *327 - - *328 + - *325 + - *326 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -73897,7 +73181,7 @@ paths: description: Response content: application/json: - schema: *512 + schema: *507 examples: default-response: summary: Default response @@ -73956,8 +73240,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -73967,7 +73251,7 @@ paths: application/json: schema: type: array - items: &513 + items: &508 title: Webhook description: Webhooks for repositories. type: object @@ -74021,7 +73305,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &748 + last_response: &742 title: Hook Response type: object properties: @@ -74095,8 +73379,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: false content: @@ -74148,9 +73432,9 @@ paths: description: Response content: application/json: - schema: *513 + schema: *508 examples: - default: &514 + default: &509 value: type: Repository id: 12345678 @@ -74198,17 +73482,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *327 - - *328 + - *325 + - *326 - *196 responses: '200': description: Response content: application/json: - schema: *513 + schema: *508 examples: - default: *514 + default: *509 '404': *6 x-github: githubCloudOnly: false @@ -74228,8 +73512,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *327 - - *328 + - *325 + - *326 - *196 requestBody: required: true @@ -74275,9 +73559,9 @@ paths: description: Response content: application/json: - schema: *513 + schema: *508 examples: - default: *514 + default: *509 '422': *15 '404': *6 x-github: @@ -74298,8 +73582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *327 - - *328 + - *325 + - *326 - *196 responses: '204': @@ -74324,8 +73608,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *196 responses: '200': @@ -74353,8 +73637,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *196 requestBody: required: false @@ -74399,8 +73683,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *327 - - *328 + - *325 + - *326 - *196 - *17 - *197 @@ -74432,8 +73716,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *327 - - *328 + - *325 + - *326 - *196 - *16 responses: @@ -74462,8 +73746,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *327 - - *328 + - *325 + - *326 - *196 - *16 responses: @@ -74487,8 +73771,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *327 - - *328 + - *325 + - *326 - *196 responses: '204': @@ -74514,8 +73798,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *327 - - *328 + - *325 + - *326 - *196 responses: '204': @@ -74539,8 +73823,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response if immutable releases are enabled @@ -74586,8 +73870,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': *175 '409': *47 @@ -74607,8 +73891,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': *175 '409': *47 @@ -74665,14 +73949,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: &515 + schema: &510 title: Import description: A repository import from an external source. type: object @@ -74771,7 +74055,7 @@ paths: - html_url - authors_url examples: - default: &518 + default: &513 value: vcs: subversion use_lfs: true @@ -74787,7 +74071,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &516 + '503': &511 description: Unavailable due to service under maintenance. content: application/json: @@ -74816,8 +74100,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -74865,7 +74149,7 @@ paths: description: Response content: application/json: - schema: *515 + schema: *510 examples: default: value: @@ -74890,7 +74174,7 @@ paths: type: string '422': *15 '404': *6 - '503': *516 + '503': *511 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74918,8 +74202,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: false content: @@ -74968,7 +74252,7 @@ paths: description: Response content: application/json: - schema: *515 + schema: *510 examples: example-1: summary: Example 1 @@ -75016,7 +74300,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *516 + '503': *511 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75039,12 +74323,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response - '503': *516 + '503': *511 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75070,9 +74354,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *327 - - *328 - - &691 + - *325 + - *326 + - &685 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -75086,7 +74370,7 @@ paths: application/json: schema: type: array - items: &517 + items: &512 title: Porter Author description: Porter Author type: object @@ -75140,7 +74424,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *516 + '503': *511 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75165,8 +74449,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *327 - - *328 + - *325 + - *326 - name: author_id in: path required: true @@ -75196,7 +74480,7 @@ paths: description: Response content: application/json: - schema: *517 + schema: *512 examples: default: value: @@ -75209,7 +74493,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *516 + '503': *511 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75233,8 +74517,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -75275,7 +74559,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *516 + '503': *511 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75303,8 +74587,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -75331,11 +74615,11 @@ paths: description: Response content: application/json: - schema: *515 + schema: *510 examples: - default: *518 + default: *513 '422': *15 - '503': *516 + '503': *511 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75358,8 +74642,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -75367,8 +74651,8 @@ paths: application/json: schema: *22 examples: - default: *519 - '301': *334 + default: *514 + '301': *329 '404': *6 x-github: githubCloudOnly: false @@ -75388,8 +74672,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -75402,7 +74686,7 @@ paths: properties: {} additionalProperties: false examples: - default: &521 + default: &516 value: limit: collaborators_only origin: repository @@ -75427,13 +74711,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: application/json: - schema: *520 + schema: *515 examples: default: summary: Example request body @@ -75447,7 +74731,7 @@ paths: application/json: schema: *214 examples: - default: *521 + default: *516 '409': description: Response x-github: @@ -75469,8 +74753,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -75493,8 +74777,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -75504,9 +74788,9 @@ paths: application/json: schema: type: array - items: *522 + items: *517 examples: - default: &684 + default: &678 value: - id: 1 repository: @@ -75637,8 +74921,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *327 - - *328 + - *325 + - *326 - *218 requestBody: required: false @@ -75668,7 +74952,7 @@ paths: description: Response content: application/json: - schema: *522 + schema: *517 examples: default: value: @@ -75799,8 +75083,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *327 - - *328 + - *325 + - *326 - *218 responses: '204': @@ -75832,8 +75116,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *327 - - *328 + - *325 + - *326 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -75906,7 +75190,7 @@ paths: type: array items: *82 examples: - default: &532 + default: &527 value: - id: 1 node_id: MDU6SXNzdWUx @@ -76054,7 +75338,7 @@ paths: state_reason: completed headers: Link: *54 - '301': *334 + '301': *329 '422': *15 '404': *6 x-github: @@ -76083,8 +75367,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -76168,7 +75452,7 @@ paths: application/json: schema: *82 examples: - default: &529 + default: &524 value: id: 1 node_id: MDU6SXNzdWUx @@ -76324,7 +75608,7 @@ paths: '422': *15 '503': *104 '404': *6 - '410': *523 + '410': *518 x-github: triggersNotification: true githubCloudOnly: false @@ -76352,8 +75636,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *92 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -76374,9 +75658,9 @@ paths: application/json: schema: type: array - items: *524 + items: *519 examples: - default: &531 + default: &526 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -76434,17 +75718,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 responses: '200': description: Response content: application/json: - schema: *524 + schema: *519 examples: - default: &525 + default: &520 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -76498,8 +75782,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 requestBody: required: true @@ -76522,9 +75806,9 @@ paths: description: Response content: application/json: - schema: *524 + schema: *519 examples: - default: *525 + default: *520 '422': *15 x-github: githubCloudOnly: false @@ -76542,8 +75826,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 responses: '204': @@ -76564,8 +75848,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -76615,8 +75899,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 requestBody: required: true @@ -76680,8 +75964,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *327 - - *328 + - *325 + - *326 - *81 - *323 responses: @@ -76703,8 +75987,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -76714,7 +75998,7 @@ paths: application/json: schema: type: array - items: &528 + items: &523 title: Issue Event description: Issue Event type: object @@ -76757,8 +76041,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *526 - required: *527 + properties: *521 + required: *522 nullable: true label: title: Issue Event Label @@ -77065,8 +76349,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *327 - - *328 + - *325 + - *326 - name: event_id in: path required: true @@ -77077,7 +76361,7 @@ paths: description: Response content: application/json: - schema: *528 + schema: *523 examples: default: value: @@ -77270,7 +76554,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *523 + '410': *518 '403': *29 x-github: githubCloudOnly: false @@ -77304,9 +76588,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *327 - - *328 - - &530 + - *325 + - *326 + - &525 name: issue_number description: The number that identifies the issue. in: path @@ -77320,10 +76604,10 @@ paths: application/json: schema: *82 examples: - default: *529 - '301': *334 + default: *524 + '301': *329 '404': *6 - '410': *523 + '410': *518 '304': *37 x-github: githubCloudOnly: false @@ -77348,9 +76632,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: false content: @@ -77456,13 +76740,13 @@ paths: application/json: schema: *82 examples: - default: *529 + default: *524 '422': *15 '503': *104 '403': *29 - '301': *334 + '301': *329 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77480,9 +76764,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: false content: @@ -77510,7 +76794,7 @@ paths: application/json: schema: *82 examples: - default: *529 + default: *524 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77526,9 +76810,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: content: application/json: @@ -77555,7 +76839,7 @@ paths: application/json: schema: *82 examples: - default: *529 + default: *524 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77577,9 +76861,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - name: assignee in: path required: true @@ -77619,9 +76903,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - *72 - *17 - *19 @@ -77632,13 +76916,13 @@ paths: application/json: schema: type: array - items: *524 + items: *519 examples: - default: *531 + default: *526 headers: Link: *54 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77667,9 +76951,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: true content: @@ -77691,16 +76975,16 @@ paths: description: Response content: application/json: - schema: *524 + schema: *519 examples: - default: *525 + default: *520 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *523 + '410': *518 '422': *15 '404': *6 x-github: @@ -77728,9 +77012,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - *17 - *19 responses: @@ -77742,12 +77026,12 @@ paths: type: array items: *82 examples: - default: *532 + default: *527 headers: Link: *54 - '301': *334 + '301': *329 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77775,9 +77059,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: true content: @@ -77801,15 +77085,15 @@ paths: application/json: schema: *82 examples: - default: *529 + default: *524 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *334 + '301': *329 '403': *29 - '410': *523 + '410': *518 '422': *15 '404': *6 x-github: @@ -77840,9 +77124,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -77856,13 +77140,13 @@ paths: application/json: schema: *82 examples: - default: *529 - '301': *334 + default: *524 + '301': *329 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *523 + '410': *518 x-github: triggersNotification: true githubCloudOnly: false @@ -77888,9 +77172,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - *17 - *19 responses: @@ -77902,12 +77186,12 @@ paths: type: array items: *82 examples: - default: *532 + default: *527 headers: Link: *54 - '301': *334 + '301': *329 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77924,9 +77208,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - *17 - *19 responses: @@ -77940,7 +77224,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &535 + - &530 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -77994,7 +77278,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &536 + - &531 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -78130,7 +77414,7 @@ paths: - performed_via_github_app - assignee - assigner - - &537 + - &532 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -78181,7 +77465,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &538 + - &533 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -78232,7 +77516,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &539 + - &534 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -78286,7 +77570,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &540 + - &535 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -78333,7 +77617,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &541 + - &536 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -78380,7 +77664,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &542 + - &537 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -78440,7 +77724,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &543 + - &538 title: Locked Issue Event description: Locked Issue Event type: object @@ -78488,7 +77772,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &544 + - &539 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -78554,7 +77838,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &545 + - &540 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -78620,7 +77904,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &546 + - &541 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -78686,7 +77970,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &547 + - &542 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -78777,7 +78061,7 @@ paths: color: red headers: Link: *54 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78794,9 +78078,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - *17 - *19 responses: @@ -78806,7 +78090,7 @@ paths: application/json: schema: type: array - items: &533 + items: &528 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -78853,7 +78137,7 @@ paths: - color - default examples: - default: &534 + default: &529 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -78871,9 +78155,9 @@ paths: default: false headers: Link: *54 - '301': *334 + '301': *329 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78890,9 +78174,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: false content: @@ -78951,12 +78235,12 @@ paths: application/json: schema: type: array - items: *533 + items: *528 examples: - default: *534 - '301': *334 + default: *529 + '301': *329 '404': *6 - '410': *523 + '410': *518 '422': *15 x-github: githubCloudOnly: false @@ -78973,9 +78257,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: false content: @@ -79035,12 +78319,12 @@ paths: application/json: schema: type: array - items: *533 + items: *528 examples: - default: *534 - '301': *334 + default: *529 + '301': *329 '404': *6 - '410': *523 + '410': *518 '422': *15 x-github: githubCloudOnly: false @@ -79057,15 +78341,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 responses: '204': description: Response - '301': *334 + '301': *329 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79084,9 +78368,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - name: name in: path required: true @@ -79099,7 +78383,7 @@ paths: application/json: schema: type: array - items: *533 + items: *528 examples: default: value: @@ -79110,9 +78394,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *334 + '301': *329 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79132,9 +78416,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: false content: @@ -79162,7 +78446,7 @@ paths: '204': description: Response '403': *29 - '410': *523 + '410': *518 '404': *6 '422': *15 x-github: @@ -79180,9 +78464,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 responses: '204': description: Response @@ -79212,9 +78496,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 responses: '200': description: Response @@ -79222,10 +78506,10 @@ paths: application/json: schema: *82 examples: - default: *529 - '301': *334 + default: *524 + '301': *329 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79242,9 +78526,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -79276,7 +78560,7 @@ paths: headers: Link: *54 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79294,9 +78578,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: true content: @@ -79359,9 +78643,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - *323 responses: '204': @@ -79391,9 +78675,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: true content: @@ -79417,7 +78701,7 @@ paths: application/json: schema: *82 examples: - default: *529 + default: *524 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -79450,9 +78734,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - *17 - *19 responses: @@ -79464,11 +78748,11 @@ paths: type: array items: *82 examples: - default: *532 + default: *527 headers: Link: *54 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79496,9 +78780,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: true content: @@ -79527,14 +78811,14 @@ paths: application/json: schema: *82 examples: - default: *529 + default: *524 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *523 + '410': *518 '422': *15 '404': *6 x-github: @@ -79554,9 +78838,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 requestBody: required: true content: @@ -79589,7 +78873,7 @@ paths: application/json: schema: *82 examples: - default: *529 + default: *524 '403': *29 '404': *6 '422': *7 @@ -79611,9 +78895,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *327 - - *328 - - *530 + - *325 + - *326 + - *525 - *17 - *19 responses: @@ -79628,6 +78912,11 @@ paths: description: Timeline Event type: object anyOf: + - *530 + - *531 + - *532 + - *533 + - *534 - *535 - *536 - *537 @@ -79636,11 +78925,6 @@ paths: - *540 - *541 - *542 - - *543 - - *544 - - *545 - - *546 - - *547 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -79949,7 +79233,7 @@ paths: type: string comments: type: array - items: &569 + items: &564 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -80158,7 +79442,7 @@ paths: type: string comments: type: array - items: *457 + items: *452 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -80447,7 +79731,7 @@ paths: headers: Link: *54 '404': *6 - '410': *523 + '410': *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80464,8 +79748,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -80475,7 +79759,7 @@ paths: application/json: schema: type: array - items: &548 + items: &543 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -80541,8 +79825,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -80578,9 +79862,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *543 examples: - default: &549 + default: &544 value: id: 1 key: ssh-rsa AAA... @@ -80614,9 +79898,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *327 - - *328 - - &550 + - *325 + - *326 + - &545 name: key_id description: The unique identifier of the key. in: path @@ -80628,9 +79912,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *543 examples: - default: *549 + default: *544 '404': *6 x-github: githubCloudOnly: false @@ -80648,9 +79932,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *327 - - *328 - - *550 + - *325 + - *326 + - *545 responses: '204': description: Response @@ -80670,8 +79954,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -80681,9 +79965,9 @@ paths: application/json: schema: type: array - items: *533 + items: *528 examples: - default: *534 + default: *529 headers: Link: *54 '404': *6 @@ -80704,8 +79988,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -80741,9 +80025,9 @@ paths: description: Response content: application/json: - schema: *533 + schema: *528 examples: - default: &551 + default: &546 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -80775,8 +80059,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *327 - - *328 + - *325 + - *326 - name: name in: path required: true @@ -80787,9 +80071,9 @@ paths: description: Response content: application/json: - schema: *533 + schema: *528 examples: - default: *551 + default: *546 '404': *6 x-github: githubCloudOnly: false @@ -80806,8 +80090,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *327 - - *328 + - *325 + - *326 - name: name in: path required: true @@ -80846,7 +80130,7 @@ paths: description: Response content: application/json: - schema: *533 + schema: *528 examples: default: value: @@ -80872,8 +80156,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *327 - - *328 + - *325 + - *326 - name: name in: path required: true @@ -80899,8 +80183,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -80939,9 +80223,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *327 - - *328 - - *433 + - *325 + - *326 + - *428 responses: '200': description: Response @@ -81086,8 +80370,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -81152,8 +80436,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -81187,9 +80471,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *458 + schema: *453 examples: - default: *552 + default: *547 '204': description: Response when already merged '404': @@ -81214,8 +80498,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *327 - - *328 + - *325 + - *326 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -81256,7 +80540,7 @@ paths: application/json: schema: type: array - items: &553 + items: &548 title: Milestone description: A collection of related issues and pull requests. type: object @@ -81317,8 +80601,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -81358,9 +80642,9 @@ paths: description: Response content: application/json: - schema: *553 + schema: *548 examples: - default: &554 + default: &549 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -81419,9 +80703,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *327 - - *328 - - &555 + - *325 + - *326 + - &550 name: milestone_number description: The number that identifies the milestone. in: path @@ -81433,9 +80717,9 @@ paths: description: Response content: application/json: - schema: *553 + schema: *548 examples: - default: *554 + default: *549 '404': *6 x-github: githubCloudOnly: false @@ -81452,9 +80736,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *327 - - *328 - - *555 + - *325 + - *326 + - *550 requestBody: required: false content: @@ -81492,9 +80776,9 @@ paths: description: Response content: application/json: - schema: *553 + schema: *548 examples: - default: *554 + default: *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81510,9 +80794,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *327 - - *328 - - *555 + - *325 + - *326 + - *550 responses: '204': description: Response @@ -81533,9 +80817,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *327 - - *328 - - *555 + - *325 + - *326 + - *550 - *17 - *19 responses: @@ -81545,9 +80829,9 @@ paths: application/json: schema: type: array - items: *533 + items: *528 examples: - default: *534 + default: *529 headers: Link: *54 x-github: @@ -81566,12 +80850,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *327 - - *328 - - *556 - - *557 + - *325 + - *326 + - *551 + - *552 - *72 - - *558 + - *553 - *17 - *19 responses: @@ -81583,7 +80867,7 @@ paths: type: array items: *95 examples: - default: *559 + default: *554 headers: Link: *54 x-github: @@ -81607,8 +80891,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: false content: @@ -81666,14 +80950,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: &560 + schema: &555 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -81798,7 +81082,7 @@ paths: - custom_404 - public examples: - default: &561 + default: &556 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -81839,8 +81123,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -81894,9 +81178,9 @@ paths: description: Response content: application/json: - schema: *560 + schema: *555 examples: - default: *561 + default: *556 '422': *15 '409': *47 x-github: @@ -81919,8 +81203,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -82019,8 +81303,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -82046,8 +81330,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -82057,7 +81341,7 @@ paths: application/json: schema: type: array - items: &562 + items: &557 title: Page Build description: Page Build type: object @@ -82151,8 +81435,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *327 - - *328 + - *325 + - *326 responses: '201': description: Response @@ -82197,16 +81481,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *562 + schema: *557 examples: - default: &563 + default: &558 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -82254,8 +81538,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *327 - - *328 + - *325 + - *326 - name: build_id in: path required: true @@ -82266,9 +81550,9 @@ paths: description: Response content: application/json: - schema: *562 + schema: *557 examples: - default: *563 + default: *558 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82288,8 +81572,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -82394,9 +81678,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *327 - - *328 - - &564 + - *325 + - *326 + - &559 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -82454,9 +81738,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *327 - - *328 - - *564 + - *325 + - *326 + - *559 responses: '204': *175 '404': *6 @@ -82483,8 +81767,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -82742,8 +82026,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Private vulnerability reporting status @@ -82780,8 +82064,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': *175 '422': *14 @@ -82802,8 +82086,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': *175 '422': *14 @@ -82825,8 +82109,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -82836,7 +82120,7 @@ paths: type: array items: *102 examples: - default: *565 + default: *560 '403': *29 '404': *6 x-github: @@ -82858,8 +82142,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -82875,7 +82159,7 @@ paths: required: - properties examples: - default: *566 + default: *561 responses: '204': description: No Content when custom property values are successfully created @@ -82913,8 +82197,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *327 - - *328 + - *325 + - *326 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -82974,9 +82258,9 @@ paths: application/json: schema: type: array - items: *462 + items: *457 examples: - default: *567 + default: *562 headers: Link: *54 '304': *37 @@ -83008,8 +82292,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -83074,7 +82358,7 @@ paths: description: Response content: application/json: - schema: &571 + schema: &566 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -83288,7 +82572,7 @@ paths: - review_comment - self author_association: *69 - auto_merge: *568 + auto_merge: *563 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -83380,7 +82664,7 @@ paths: - merged_by - review_comments examples: - default: &572 + default: &567 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -83907,8 +83191,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - name: sort in: query required: false @@ -83937,9 +83221,9 @@ paths: application/json: schema: type: array - items: *569 + items: *564 examples: - default: &574 + default: &569 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -84016,17 +83300,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 + - *325 + - *326 - *81 responses: '200': description: Response content: application/json: - schema: *569 + schema: *564 examples: - default: &570 + default: &565 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -84101,8 +83385,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 + - *325 + - *326 - *81 requestBody: required: true @@ -84125,9 +83409,9 @@ paths: description: Response content: application/json: - schema: *569 + schema: *564 examples: - default: *570 + default: *565 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84143,8 +83427,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 + - *325 + - *326 - *81 responses: '204': @@ -84166,8 +83450,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -84217,8 +83501,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *327 - - *328 + - *325 + - *326 - *81 requestBody: required: true @@ -84282,8 +83566,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *327 - - *328 + - *325 + - *326 - *81 - *323 responses: @@ -84328,9 +83612,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *327 - - *328 - - &573 + - *325 + - *326 + - &568 name: pull_number description: The number that identifies the pull request. in: path @@ -84343,9 +83627,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *571 + schema: *566 examples: - default: *572 + default: *567 '304': *37 '404': *6 '406': @@ -84380,9 +83664,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 requestBody: required: false content: @@ -84424,9 +83708,9 @@ paths: description: Response content: application/json: - schema: *571 + schema: *566 examples: - default: *572 + default: *567 '422': *15 '403': *29 x-github: @@ -84448,9 +83732,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 requestBody: required: true content: @@ -84512,7 +83796,7 @@ paths: application/json: schema: *224 examples: - default: *447 + default: *442 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -84520,7 +83804,7 @@ paths: application/json: schema: *224 examples: - default: *447 + default: *442 '401': *25 '403': *29 '404': *6 @@ -84550,9 +83834,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 - *92 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -84573,9 +83857,9 @@ paths: application/json: schema: type: array - items: *569 + items: *564 examples: - default: *574 + default: *569 headers: Link: *54 x-github: @@ -84608,9 +83892,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 requestBody: required: true content: @@ -84715,7 +83999,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *564 examples: example-for-a-multi-line-comment: value: @@ -84803,9 +84087,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 - *81 requestBody: required: true @@ -84828,7 +84112,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *564 examples: default: value: @@ -84914,9 +84198,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 - *17 - *19 responses: @@ -84926,9 +84210,9 @@ paths: application/json: schema: type: array - items: *458 + items: *453 examples: - default: *575 + default: *570 headers: Link: *54 x-github: @@ -84958,9 +84242,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 - *17 - *19 responses: @@ -84970,7 +84254,7 @@ paths: application/json: schema: type: array - items: *471 + items: *466 examples: default: value: @@ -85008,9 +84292,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 responses: '204': description: Response if pull request has been merged @@ -85033,9 +84317,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 requestBody: required: false content: @@ -85146,9 +84430,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 responses: '200': description: Response @@ -85223,9 +84507,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 requestBody: required: false content: @@ -85262,7 +84546,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *457 examples: default: value: @@ -85798,9 +85082,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 requestBody: required: true content: @@ -85834,7 +85118,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *457 examples: default: value: @@ -86339,9 +85623,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 - *17 - *19 responses: @@ -86351,7 +85635,7 @@ paths: application/json: schema: type: array - items: &576 + items: &571 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -86502,9 +85786,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 requestBody: required: false content: @@ -86590,9 +85874,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *571 examples: - default: &578 + default: &573 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -86655,10 +85939,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 - - &577 + - *325 + - *326 + - *568 + - &572 name: review_id description: The unique identifier of the review. in: path @@ -86670,9 +85954,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *571 examples: - default: &579 + default: &574 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -86731,10 +86015,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 - - *577 + - *325 + - *326 + - *568 + - *572 requestBody: required: true content: @@ -86757,7 +86041,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *571 examples: default: value: @@ -86819,18 +86103,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 - - *577 + - *325 + - *326 + - *568 + - *572 responses: '200': description: Response content: application/json: - schema: *576 + schema: *571 examples: - default: *578 + default: *573 '422': *7 '404': *6 x-github: @@ -86857,10 +86141,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *327 - - *328 - - *573 - - *577 + - *325 + - *326 + - *568 + - *572 - *17 - *19 responses: @@ -87095,10 +86379,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 - - *577 + - *325 + - *326 + - *568 + - *572 requestBody: required: true content: @@ -87126,7 +86410,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *571 examples: default: value: @@ -87189,10 +86473,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 - - *577 + - *325 + - *326 + - *568 + - *572 requestBody: required: true content: @@ -87227,9 +86511,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *571 examples: - default: *579 + default: *574 '404': *6 '422': *7 '403': *29 @@ -87251,9 +86535,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *327 - - *328 - - *573 + - *325 + - *326 + - *568 requestBody: required: false content: @@ -87316,8 +86600,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *327 - - *328 + - *325 + - *326 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -87330,9 +86614,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *575 examples: - default: &581 + default: &576 value: type: file encoding: base64 @@ -87374,8 +86658,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *327 - - *328 + - *325 + - *326 - name: dir description: The alternate path to look for a README file in: path @@ -87395,9 +86679,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *575 examples: - default: *581 + default: *576 '404': *6 '422': *15 x-github: @@ -87419,8 +86703,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -87430,7 +86714,7 @@ paths: application/json: schema: type: array - items: &582 + items: &577 title: Release description: A release. type: object @@ -87501,7 +86785,7 @@ paths: author: *4 assets: type: array - items: &583 + items: &578 title: Release Asset description: Data related to a release. type: object @@ -87688,8 +86972,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -87765,9 +87049,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *577 examples: - default: &586 + default: &581 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -87872,9 +87156,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *327 - - *328 - - &584 + - *325 + - *326 + - &579 name: asset_id description: The unique identifier of the asset. in: path @@ -87886,9 +87170,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *578 examples: - default: &585 + default: &580 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -87923,7 +87207,7 @@ paths: type: User site_admin: false '404': *6 - '302': *473 + '302': *468 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87939,9 +87223,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *327 - - *328 - - *584 + - *325 + - *326 + - *579 requestBody: required: false content: @@ -87969,9 +87253,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *578 examples: - default: *585 + default: *580 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87987,9 +87271,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *327 - - *328 - - *584 + - *325 + - *326 + - *579 responses: '204': description: Response @@ -88013,8 +87297,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -88099,16 +87383,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *582 + schema: *577 examples: - default: *586 + default: *581 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88125,8 +87409,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *327 - - *328 + - *325 + - *326 - name: tag description: tag parameter in: path @@ -88139,9 +87423,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *577 examples: - default: *586 + default: *581 '404': *6 x-github: githubCloudOnly: false @@ -88163,9 +87447,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *327 - - *328 - - &587 + - *325 + - *326 + - &582 name: release_id description: The unique identifier of the release. in: path @@ -88179,9 +87463,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *582 + schema: *577 examples: - default: *586 + default: *581 '401': description: Unauthorized x-github: @@ -88199,9 +87483,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *327 - - *328 - - *587 + - *325 + - *326 + - *582 requestBody: required: false content: @@ -88265,9 +87549,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *577 examples: - default: *586 + default: *581 '404': description: Not Found if the discussion category name is invalid content: @@ -88288,9 +87572,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *327 - - *328 - - *587 + - *325 + - *326 + - *582 responses: '204': description: Response @@ -88310,9 +87594,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *327 - - *328 - - *587 + - *325 + - *326 + - *582 - *17 - *19 responses: @@ -88322,7 +87606,7 @@ paths: application/json: schema: type: array - items: *583 + items: *578 examples: default: value: @@ -88403,9 +87687,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *327 - - *328 - - *587 + - *325 + - *326 + - *582 - name: name in: query required: true @@ -88431,7 +87715,7 @@ paths: description: Response for successful upload content: application/json: - schema: *583 + schema: *578 examples: response-for-successful-upload: value: @@ -88486,9 +87770,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *327 - - *328 - - *587 + - *325 + - *326 + - *582 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -88535,9 +87819,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *327 - - *328 - - *587 + - *325 + - *326 + - *582 requestBody: required: true content: @@ -88598,9 +87882,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *327 - - *328 - - *587 + - *325 + - *326 + - *582 - *323 responses: '204': @@ -88625,9 +87909,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *327 - - *328 - - *395 + - *325 + - *326 + - *390 - *17 - *19 responses: @@ -88644,7 +87928,7 @@ paths: oneOf: - allOf: - *278 - - &588 + - &583 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -88665,67 +87949,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *279 - - *588 + - *583 - allOf: - *280 - - *588 + - *583 - allOf: - *281 - - *588 + - *583 - allOf: - - *589 - - *588 + - *584 + - *583 - allOf: - *282 - - *588 + - *583 - allOf: - *283 - - *588 + - *583 - allOf: - *284 - - *588 + - *583 - allOf: - *285 - - *588 + - *583 - allOf: - *286 - - *588 + - *583 - allOf: - *287 - - *588 + - *583 - allOf: - *288 - - *588 + - *583 - allOf: - *289 - - *588 + - *583 - allOf: - *290 - - *588 + - *583 - allOf: - *291 - - *588 + - *583 - allOf: - *292 - - *588 + - *583 - allOf: - *293 - - *588 + - *583 - allOf: - *294 - - *588 + - *583 - allOf: - *295 - - *588 + - *583 - allOf: - *296 - - *588 + - *583 - allOf: - *297 - - *588 + - *583 - allOf: - - *590 - - *588 + - *585 + - *583 examples: default: value: @@ -88764,8 +88048,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 - name: includes_parents @@ -88776,7 +88060,7 @@ paths: schema: type: boolean default: true - - *591 + - *586 responses: '200': description: Response @@ -88831,8 +88115,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *325 + - *326 requestBody: description: Request body required: true @@ -88861,7 +88145,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *592 + items: *587 required: - name - enforcement @@ -88894,7 +88178,7 @@ paths: application/json: schema: *298 examples: - default: &602 + default: &597 value: id: 42 name: super cool ruleset @@ -88941,12 +88225,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *327 - - *328 - - *593 - - *594 - - *595 - - *596 + - *325 + - *326 + - *588 + - *589 + - *590 + - *591 - *17 - *19 responses: @@ -88954,9 +88238,9 @@ paths: description: Response content: application/json: - schema: *597 + schema: *592 examples: - default: *598 + default: *593 '404': *6 '500': *103 x-github: @@ -88977,17 +88261,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *327 - - *328 - - *599 + - *325 + - *326 + - *594 responses: '200': description: Response content: application/json: - schema: *600 + schema: *595 examples: - default: *601 + default: *596 '404': *6 '500': *103 x-github: @@ -89015,8 +88299,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *325 + - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89038,7 +88322,7 @@ paths: application/json: schema: *298 examples: - default: *602 + default: *597 '404': *6 '500': *103 put: @@ -89056,8 +88340,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *325 + - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89091,7 +88375,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *592 + items: *587 examples: default: value: @@ -89121,7 +88405,7 @@ paths: application/json: schema: *298 examples: - default: *602 + default: *597 '404': *6 '500': *103 delete: @@ -89139,8 +88423,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *325 + - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89163,8 +88447,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 - name: ruleset_id @@ -89182,7 +88466,7 @@ paths: type: array items: *301 examples: - default: *603 + default: *598 '404': *6 '500': *103 x-github: @@ -89201,8 +88485,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *327 - - *328 + - *325 + - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89220,7 +88504,7 @@ paths: description: Response content: application/json: - schema: *604 + schema: *599 examples: default: value: @@ -89275,21 +88559,22 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 + - *600 + - *601 + - *602 + - *603 + - *604 + - *48 + - *19 + - *17 - *605 - *606 - *607 - *608 - - *48 - - *19 - - *17 - *609 - *610 - - *611 - - *612 - - *613 - - *614 responses: '200': description: Response @@ -89297,7 +88582,7 @@ paths: application/json: schema: type: array - items: &618 + items: &614 type: object properties: number: *161 @@ -89316,8 +88601,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *615 - resolution: *616 + state: *611 + resolution: *612 resolved_at: type: string format: date-time @@ -89413,7 +88698,7 @@ paths: pull request. ' - oneOf: *617 + oneOf: *613 nullable: true has_more_locations: type: boolean @@ -89562,16 +88847,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *327 - - *328 - - *427 - - *614 + - *325 + - *326 + - *422 + - *610 responses: '200': description: Response content: application/json: - schema: *618 + schema: *614 examples: default: value: @@ -89613,6 +88898,8 @@ paths: description: |- Updates the status of a secret scanning alert in an eligible repository. + You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. 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. @@ -89623,9 +88910,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *327 - - *328 - - *427 + - *325 + - *326 + - *422 requestBody: required: true content: @@ -89633,27 +88920,42 @@ paths: schema: type: object properties: - state: *615 - resolution: *616 + state: *611 + resolution: *612 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: string nullable: true + assignee: + description: The username of the user to assign to the alert. Set + to `null` to unassign the alert. + type: string + nullable: true anyOf: - required: - state + - required: + - assignee examples: default: value: state: resolved resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: responses: '200': description: Response content: application/json: - schema: *618 + schema: *614 examples: default: value: @@ -89698,6 +89000,25 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false '400': description: Bad request, resolution comment is invalid or the resolution was not changed. @@ -89705,7 +89026,8 @@ paths: description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': - description: State does not match the resolution or resolution comment + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository '503': *104 x-github: enabledForGitHubApps: true @@ -89728,9 +89050,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *327 - - *328 - - *427 + - *325 + - *326 + - *422 - *19 - *17 responses: @@ -89741,7 +89063,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &770 + items: &764 type: object properties: type: @@ -89767,6 +89089,10 @@ paths: example: commit details: oneOf: + - *615 + - *616 + - *617 + - *618 - *619 - *620 - *621 @@ -89776,10 +89102,6 @@ paths: - *625 - *626 - *627 - - *628 - - *629 - - *630 - - *631 examples: default: value: @@ -89865,8 +89187,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -89874,14 +89196,14 @@ paths: schema: type: object properties: - reason: &633 + reason: &629 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *632 + placeholder_id: *628 required: - reason - placeholder_id @@ -89898,7 +89220,7 @@ paths: schema: type: object properties: - reason: *633 + reason: *629 expire_at: type: string format: date-time @@ -89944,8 +89266,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -89960,7 +89282,7 @@ paths: properties: incremental_scans: type: array - items: &634 + items: &630 description: Information on a single scan performed by secret scanning on the repository type: object @@ -89986,15 +89308,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *634 + items: *630 backfill_scans: type: array - items: *634 + items: *630 custom_pattern_backfill_scans: type: array items: allOf: - - *634 + - *630 - type: object properties: pattern_name: @@ -90064,8 +89386,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *327 - - *328 + - *325 + - *326 - *48 - name: sort description: The property to sort the results by. @@ -90109,9 +89431,9 @@ paths: application/json: schema: type: array - items: *635 + items: *631 examples: - default: *636 + default: *632 '400': *14 '404': *6 x-github: @@ -90134,8 +89456,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -90295,9 +89617,9 @@ paths: description: Response content: application/json: - schema: *635 + schema: *631 examples: - default: &638 + default: &634 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -90530,8 +89852,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -90635,7 +89957,7 @@ paths: description: Response content: application/json: - schema: *635 + schema: *631 examples: default: value: @@ -90782,17 +90104,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *327 - - *328 - - *637 + - *325 + - *326 + - *633 responses: '200': description: Response content: application/json: - schema: *635 + schema: *631 examples: - default: *638 + default: *634 '403': *29 '404': *6 x-github: @@ -90816,9 +90138,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *327 - - *328 - - *637 + - *325 + - *326 + - *633 requestBody: required: true content: @@ -90977,10 +90299,10 @@ paths: description: Response content: application/json: - schema: *635 + schema: *631 examples: - default: *638 - add_credit: *638 + default: *634 + add_credit: *634 '403': *29 '404': *6 '422': @@ -91018,9 +90340,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *327 - - *328 - - *637 + - *325 + - *326 + - *633 responses: '202': *39 '400': *14 @@ -91047,17 +90369,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *327 - - *328 - - *637 + - *325 + - *326 + - *633 responses: '202': description: Response content: application/json: - schema: *333 + schema: *328 examples: - default: *335 + default: *330 '400': *14 '422': *15 '403': *29 @@ -91083,8 +90405,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -91183,8 +90505,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -91193,7 +90515,7 @@ paths: application/json: schema: type: array - items: &639 + items: &635 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -91226,8 +90548,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -91303,8 +90625,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -91400,8 +90722,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -91555,8 +90877,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -91566,7 +90888,7 @@ paths: application/json: schema: type: array - items: *639 + items: *635 examples: default: value: @@ -91599,8 +90921,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *327 - - *328 + - *325 + - *326 - name: sha in: path required: true @@ -91654,7 +90976,7 @@ paths: description: Response content: application/json: - schema: *640 + schema: *636 examples: default: value: @@ -91708,8 +91030,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -91741,14 +91063,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &641 + schema: &637 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -91816,8 +91138,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: false content: @@ -91843,7 +91165,7 @@ paths: description: Response content: application/json: - schema: *641 + schema: *637 examples: default: value: @@ -91870,8 +91192,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -91891,8 +91213,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -91971,8 +91293,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -91980,7 +91302,7 @@ paths: application/json: schema: type: array - items: &642 + items: &638 title: Tag protection description: Tag protection type: object @@ -92032,8 +91354,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -92056,7 +91378,7 @@ paths: description: Response content: application/json: - schema: *642 + schema: *638 examples: default: value: @@ -92087,8 +91409,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -92125,8 +91447,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *327 - - *328 + - *325 + - *326 - name: ref in: path required: true @@ -92162,8 +91484,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *327 - - *328 + - *325 + - *326 - *17 - *19 responses: @@ -92195,8 +91517,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *327 - - *328 + - *325 + - *326 - *19 - *17 responses: @@ -92204,7 +91526,7 @@ paths: description: Response content: application/json: - schema: &643 + schema: &639 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -92216,7 +91538,7 @@ paths: required: - names examples: - default: &644 + default: &640 value: names: - octocat @@ -92239,8 +91561,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -92271,9 +91593,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *639 examples: - default: *644 + default: *640 '404': *6 '422': *7 x-github: @@ -92294,9 +91616,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *327 - - *328 - - &645 + - *325 + - *326 + - &641 name: per description: The time frame to display results for. in: query @@ -92325,7 +91647,7 @@ paths: example: 128 clones: type: array - items: &646 + items: &642 title: Traffic type: object properties: @@ -92412,8 +91734,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -92503,8 +91825,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *327 - - *328 + - *325 + - *326 responses: '200': description: Response @@ -92564,9 +91886,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *327 - - *328 - - *645 + - *325 + - *326 + - *641 responses: '200': description: Response @@ -92585,7 +91907,7 @@ paths: example: 3782 views: type: array - items: *646 + items: *642 required: - uniques - count @@ -92662,8 +91984,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *327 - - *328 + - *325 + - *326 requestBody: required: true content: @@ -92937,8 +92259,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -92961,8 +92283,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -92984,8 +92306,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -93011,8 +92333,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *327 - - *328 + - *325 + - *326 - name: ref in: path required: true @@ -93104,9 +92426,9 @@ paths: description: Response content: application/json: - schema: *333 + schema: *328 examples: - default: *335 + default: *330 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -93354,7 +92676,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &647 + text_matches: &643 title: Search Result Text Matches type: array items: @@ -93516,7 +92838,7 @@ paths: enum: - author-date - committer-date - - &648 + - &644 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -93587,7 +92909,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *393 + properties: *388 nullable: true comment_count: type: integer @@ -93607,7 +92929,7 @@ paths: url: type: string format: uri - verification: *509 + verification: *504 required: - author - committer @@ -93626,7 +92948,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *393 + properties: *388 nullable: true parents: type: array @@ -93644,7 +92966,7 @@ paths: type: number node_id: type: string - text_matches: *647 + text_matches: *643 required: - sha - node_id @@ -93836,7 +93158,7 @@ paths: - interactions - created - updated - - *648 + - *644 - *17 - *19 - name: advanced_search @@ -93933,11 +93255,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: type: string state_reason: @@ -93969,7 +93291,7 @@ paths: type: string format: date-time nullable: true - text_matches: *647 + text_matches: *643 pull_request: type: object properties: @@ -94194,7 +93516,7 @@ paths: enum: - created - updated - - *648 + - *644 - *17 - *19 responses: @@ -94238,7 +93560,7 @@ paths: nullable: true score: type: number - text_matches: *647 + text_matches: *643 required: - id - node_id @@ -94323,7 +93645,7 @@ paths: - forks - help-wanted-issues - updated - - *648 + - *644 - *17 - *19 responses: @@ -94562,7 +93884,7 @@ paths: - admin - pull - push - text_matches: *647 + text_matches: *643 temp_clone_token: type: string allow_merge_commit: @@ -94862,7 +94184,7 @@ paths: type: string format: uri nullable: true - text_matches: *647 + text_matches: *643 related: type: array nullable: true @@ -95053,7 +94375,7 @@ paths: - followers - repositories - joined - - *648 + - *644 - *17 - *19 responses: @@ -95157,7 +94479,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *647 + text_matches: *643 blog: type: string nullable: true @@ -95236,7 +94558,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &652 + - &648 name: team_id description: The unique identifier of the team. in: path @@ -95277,7 +94599,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *652 + - *648 requestBody: required: true content: @@ -95377,7 +94699,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *652 + - *648 responses: '204': description: Response @@ -95408,7 +94730,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *652 + - *648 - *48 - *17 - *19 @@ -95421,7 +94743,7 @@ paths: type: array items: *314 examples: - default: *653 + default: *649 headers: Link: *54 x-github: @@ -95450,7 +94772,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *652 + - *648 requestBody: required: true content: @@ -95513,7 +94835,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *652 + - *648 - *316 responses: '200': @@ -95547,7 +94869,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *652 + - *648 - *316 requestBody: required: false @@ -95573,7 +94895,7 @@ paths: application/json: schema: *314 examples: - default: *654 + default: *650 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95598,7 +94920,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *652 + - *648 - *316 responses: '204': @@ -95628,7 +94950,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *652 + - *648 - *316 - *48 - *17 @@ -95642,7 +94964,7 @@ paths: type: array items: *317 examples: - default: *655 + default: *651 headers: Link: *54 x-github: @@ -95671,7 +94993,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *652 + - *648 - *316 requestBody: required: true @@ -95723,7 +95045,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *652 + - *648 - *316 - *319 responses: @@ -95758,7 +95080,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *652 + - *648 - *316 - *319 requestBody: @@ -95784,7 +95106,7 @@ paths: application/json: schema: *317 examples: - default: *656 + default: *652 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95809,7 +95131,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *652 + - *648 - *316 - *319 responses: @@ -95840,7 +95162,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *652 + - *648 - *316 - *319 - name: content @@ -95899,7 +95221,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *652 + - *648 - *316 - *319 requestBody: @@ -95961,7 +95283,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *652 + - *648 - *316 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -96019,7 +95341,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *652 + - *648 - *316 requestBody: required: true @@ -96078,7 +95400,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *652 + - *648 - *17 - *19 responses: @@ -96116,7 +95438,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *652 + - *648 - name: role description: Filters members returned by their role in the team. in: query @@ -96167,7 +95489,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *652 + - *648 - *59 responses: '204': @@ -96204,7 +95526,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *652 + - *648 - *59 responses: '204': @@ -96244,7 +95566,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *652 + - *648 - *59 responses: '204': @@ -96281,7 +95603,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *652 + - *648 - *59 responses: '200': @@ -96290,7 +95612,7 @@ paths: application/json: schema: *324 examples: - response-if-user-is-a-team-maintainer: *657 + response-if-user-is-a-team-maintainer: *653 '404': *6 x-github: githubCloudOnly: false @@ -96323,7 +95645,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *652 + - *648 - *59 requestBody: required: false @@ -96351,7 +95673,7 @@ paths: application/json: schema: *324 examples: - response-if-users-membership-with-team-is-now-pending: *658 + response-if-users-membership-with-team-is-now-pending: *654 '403': description: Forbidden if team synchronization is set up '422': @@ -96385,7 +95707,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *652 + - *648 - *59 responses: '204': @@ -96400,174 +95722,6 @@ paths: category: teams subcategory: members deprecated: true - "/teams/{team_id}/projects": - get: - summary: List team projects (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/list-projects-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy - parameters: - - *652 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *325 - examples: - default: *659 - headers: - Link: *54 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - "/teams/{team_id}/projects/{project_id}": - get: - summary: Check team permissions for a project (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/check-permissions-for-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy - parameters: - - *652 - - *326 - responses: - '200': - description: Response - content: - application/json: - schema: *325 - examples: - default: *660 - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - put: - summary: Add or update team project permissions (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/add-or-update-project-permissions-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy - parameters: - - *652 - - *326 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - examples: - default: - summary: Example of setting permission to read - value: - permission: read - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - delete: - summary: Remove a project from a team (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/remove-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy - parameters: - - *652 - - *326 - responses: - '204': - description: Response - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true "/teams/{team_id}/repos": get: summary: List team repositories (Legacy) @@ -96581,7 +95735,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *652 + - *648 - *17 - *19 responses: @@ -96623,15 +95777,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *652 - - *327 - - *328 + - *648 + - *325 + - *326 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *661 + schema: *655 examples: alternative-response-with-extra-repository-information: value: @@ -96782,9 +95936,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *652 - - *327 - - *328 + - *648 + - *325 + - *326 requestBody: required: false content: @@ -96834,9 +95988,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *652 - - *327 - - *328 + - *648 + - *325 + - *326 responses: '204': description: Response @@ -96861,7 +96015,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *652 + - *648 - *17 - *19 responses: @@ -96873,7 +96027,7 @@ paths: type: array items: *181 examples: - response-if-child-teams-exist: *662 + response-if-child-teams-exist: *656 headers: Link: *54 '404': *6 @@ -96906,7 +96060,7 @@ paths: application/json: schema: oneOf: - - &664 + - &658 title: Private User description: Private User type: object @@ -97109,7 +96263,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *663 + - *657 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -97262,7 +96416,7 @@ paths: description: Response content: application/json: - schema: *664 + schema: *658 examples: default: value: @@ -97608,7 +96762,7 @@ paths: application/json: schema: *224 examples: - default: *447 + default: *442 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -97616,7 +96770,7 @@ paths: application/json: schema: *224 examples: - default: *447 + default: *442 '401': *25 '403': *29 '404': *6 @@ -97660,7 +96814,7 @@ paths: type: integer secrets: type: array - items: &665 + items: &659 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -97700,7 +96854,7 @@ paths: - visibility - selected_repositories_url examples: - default: *450 + default: *445 headers: Link: *54 x-github: @@ -97776,7 +96930,7 @@ paths: description: Response content: application/json: - schema: *665 + schema: *659 examples: default: value: @@ -97922,7 +97076,7 @@ paths: type: array items: *143 examples: - default: *666 + default: *660 '401': *25 '403': *29 '404': *6 @@ -98074,7 +97228,7 @@ paths: application/json: schema: *224 examples: - default: *447 + default: *442 '304': *37 '500': *103 '401': *25 @@ -98132,7 +97286,7 @@ paths: application/json: schema: *224 examples: - default: *447 + default: *442 '401': *25 '403': *29 '404': *6 @@ -98189,7 +97343,7 @@ paths: description: Response content: application/json: - schema: &667 + schema: &661 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -98230,7 +97384,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &668 + default: &662 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -98275,9 +97429,9 @@ paths: description: Response content: application/json: - schema: *667 + schema: *661 examples: - default: *668 + default: *662 '404': *6 x-github: githubCloudOnly: false @@ -98314,9 +97468,9 @@ paths: type: integer machines: type: array - items: *669 + items: *663 examples: - default: *670 + default: *664 '304': *37 '500': *103 '401': *25 @@ -98395,13 +97549,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *333 + repository: *328 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *448 - required: *449 + properties: *443 + required: *444 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -99183,7 +98337,7 @@ paths: application/json: schema: *224 examples: - default: *447 + default: *442 '304': *37 '500': *103 '400': *14 @@ -99223,7 +98377,7 @@ paths: application/json: schema: *224 examples: - default: *447 + default: *442 '500': *103 '401': *25 '403': *29 @@ -99255,7 +98409,7 @@ paths: type: array items: *237 examples: - default: &681 + default: &675 value: - id: 197 name: hello_docker @@ -99356,7 +98510,7 @@ paths: application/json: schema: type: array - items: &671 + items: &665 title: Email description: Email type: object @@ -99421,9 +98575,9 @@ paths: application/json: schema: type: array - items: *671 + items: *665 examples: - default: &683 + default: &677 value: - email: octocat@github.com verified: true @@ -99498,7 +98652,7 @@ paths: application/json: schema: type: array - items: *671 + items: *665 examples: default: value: @@ -99754,7 +98908,7 @@ paths: application/json: schema: type: array - items: &672 + items: &666 title: GPG Key description: A unique encryption key type: object @@ -99885,7 +99039,7 @@ paths: - subkeys - revoked examples: - default: &697 + default: &691 value: - id: 3 name: Octocat's GPG Key @@ -99970,9 +99124,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *666 examples: - default: &673 + default: &667 value: id: 3 name: Octocat's GPG Key @@ -100029,7 +99183,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &674 + - &668 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -100041,9 +99195,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *666 examples: - default: *673 + default: *667 '404': *6 '304': *37 '403': *29 @@ -100066,7 +99220,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *674 + - *668 responses: '204': description: Response @@ -100371,7 +99525,7 @@ paths: required: true content: application/json: - schema: *520 + schema: *515 examples: default: value: @@ -100521,7 +99675,7 @@ paths: application/json: schema: type: array - items: &675 + items: &669 title: Key description: Key type: object @@ -100622,9 +99776,9 @@ paths: description: Response content: application/json: - schema: *675 + schema: *669 examples: - default: &676 + default: &670 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -100657,15 +99811,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *550 + - *545 responses: '200': description: Response content: application/json: - schema: *675 + schema: *669 examples: - default: *676 + default: *670 '404': *6 '304': *37 '403': *29 @@ -100688,7 +99842,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *550 + - *545 responses: '204': description: Response @@ -100721,7 +99875,7 @@ paths: application/json: schema: type: array - items: &677 + items: &671 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -100789,7 +99943,7 @@ paths: - account - plan examples: - default: &678 + default: &672 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -100851,9 +100005,9 @@ paths: application/json: schema: type: array - items: *677 + items: *671 examples: - default: *678 + default: *672 headers: Link: *54 '304': *37 @@ -101848,7 +101002,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *231 - - *679 + - *673 responses: '204': description: Response @@ -101963,7 +101117,7 @@ paths: - docker - nuget - container - - *680 + - *674 - *19 - *17 responses: @@ -101975,8 +101129,8 @@ paths: type: array items: *237 examples: - default: *681 - '400': *682 + default: *675 + '400': *676 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -102005,7 +101159,7 @@ paths: application/json: schema: *237 examples: - default: &698 + default: &692 value: id: 40201 name: octo-name @@ -102367,9 +101521,9 @@ paths: application/json: schema: type: array - items: *671 + items: *665 examples: - default: *683 + default: *677 headers: Link: *54 '304': *37 @@ -102482,7 +101636,7 @@ paths: type: array items: *66 examples: - default: &690 + default: &684 summary: Default response value: - id: 1296269 @@ -102786,9 +101940,9 @@ paths: description: Response content: application/json: - schema: *333 + schema: *328 examples: - default: *335 + default: *330 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -102826,9 +101980,9 @@ paths: application/json: schema: type: array - items: *522 + items: *517 examples: - default: *684 + default: *678 headers: Link: *54 '304': *37 @@ -102907,7 +102061,7 @@ paths: application/json: schema: type: array - items: &685 + items: &679 title: Social account description: Social media account type: object @@ -102922,7 +102076,7 @@ paths: - provider - url examples: - default: &686 + default: &680 value: - provider: twitter url: https://twitter.com/github @@ -102984,9 +102138,9 @@ paths: application/json: schema: type: array - items: *685 + items: *679 examples: - default: *686 + default: *680 '422': *15 '304': *37 '404': *6 @@ -103073,7 +102227,7 @@ paths: application/json: schema: type: array - items: &687 + items: &681 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -103093,7 +102247,7 @@ paths: - title - created_at examples: - default: &706 + default: &700 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -103157,9 +102311,9 @@ paths: description: Response content: application/json: - schema: *687 + schema: *681 examples: - default: &688 + default: &682 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -103189,7 +102343,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &689 + - &683 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -103201,9 +102355,9 @@ paths: description: Response content: application/json: - schema: *687 + schema: *681 examples: - default: *688 + default: *682 '404': *6 '304': *37 '403': *29 @@ -103226,7 +102380,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *689 + - *683 responses: '204': description: Response @@ -103255,7 +102409,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &707 + - &701 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -103280,11 +102434,11 @@ paths: type: array items: *66 examples: - default-response: *690 + default-response: *684 application/vnd.github.v3.star+json: schema: type: array - items: &708 + items: &702 title: Starred Repository description: Starred Repository type: object @@ -103440,8 +102594,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response if this repository is starred by you @@ -103469,8 +102623,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -103494,8 +102648,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *327 - - *328 + - *325 + - *326 responses: '204': description: Response @@ -103653,10 +102807,10 @@ paths: application/json: schema: oneOf: - - *664 - - *663 + - *658 + - *657 examples: - default-response: &692 + default-response: &686 summary: Default response value: login: octocat @@ -103691,7 +102845,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &693 + response-with-git-hub-plan-information: &687 summary: Response with GitHub plan information value: login: octocat @@ -103813,7 +102967,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *691 + - *685 - *17 responses: '200': @@ -103862,11 +103016,11 @@ paths: application/json: schema: oneOf: - - *664 - - *663 + - *658 + - *657 examples: - default-response: *692 - response-with-git-hub-plan-information: *693 + default-response: *686 + response-with-git-hub-plan-information: *687 '404': *6 x-github: githubCloudOnly: false @@ -103916,8 +103070,8 @@ paths: required: - subject_digests examples: - default: *694 - withPredicateType: *695 + default: *688 + withPredicateType: *689 responses: '200': description: Response @@ -103970,7 +103124,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *696 + default: *690 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104175,7 +103329,7 @@ paths: initiator: type: string examples: - default: *389 + default: *384 '201': description: Response content: @@ -104216,7 +103370,7 @@ paths: type: array items: *237 examples: - default: *681 + default: *675 '403': *29 '401': *25 x-github: @@ -104600,9 +103754,9 @@ paths: application/json: schema: type: array - items: *672 + items: *666 examples: - default: *697 + default: *691 headers: Link: *54 x-github: @@ -104706,7 +103860,7 @@ paths: application/json: schema: *22 examples: - default: *519 + default: *514 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104830,7 +103984,7 @@ paths: - docker - nuget - container - - *680 + - *674 - *59 - *19 - *17 @@ -104843,10 +103997,10 @@ paths: type: array items: *237 examples: - default: *681 + default: *675 '403': *29 '401': *25 - '400': *682 + '400': *676 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104876,7 +104030,7 @@ paths: application/json: schema: *237 examples: - default: *698 + default: *692 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105225,7 +104379,7 @@ paths: type: array items: *259 examples: - default: *699 + default: *693 headers: Link: *54 '304': *37 @@ -105236,6 +104390,257 @@ paths: enabledForGitHubApps: true category: projects subcategory: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project + parameters: + - *59 + - *255 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + - single_select + - iteration + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + iteration_configuration: + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: The duration of the iteration in days. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + properties: + title: + type: string + description: The title for the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + required: + - name + - data_type + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + iteration_field: + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + responses: + '201': + description: Response + content: + application/json: + schema: *259 + examples: + text_field: + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + number_field: + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + date_field: + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + single_select_field: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + iteration_field: + value: + id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' + '304': *37 + '403': *29 + '401': *25 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields "/users/{username}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for user @@ -105248,7 +104653,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *255 - - *700 + - *694 - *59 responses: '200': @@ -105257,7 +104662,7 @@ paths: application/json: schema: *259 examples: - default: *701 + default: *695 headers: Link: *54 '304': *37 @@ -105788,7 +105193,7 @@ paths: - *106 - *108 - *107 - - *702 + - *696 - *109 responses: '200': @@ -105919,7 +105324,7 @@ paths: parameters: - *59 - *106 - - *703 + - *697 - *107 responses: '200': @@ -106018,9 +105423,9 @@ paths: - *106 - *108 - *107 - - *704 + - *698 - *109 - - *705 + - *699 responses: '200': description: Response when getting a billing usage summary @@ -106154,9 +105559,9 @@ paths: application/json: schema: type: array - items: *685 + items: *679 examples: - default: *686 + default: *680 headers: Link: *54 x-github: @@ -106186,9 +105591,9 @@ paths: application/json: schema: type: array - items: *687 + items: *681 examples: - default: *706 + default: *700 headers: Link: *54 x-github: @@ -106213,7 +105618,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *59 - - *707 + - *701 - *48 - *17 - *19 @@ -106225,11 +105630,11 @@ paths: schema: anyOf: - type: array - items: *708 + items: *702 - type: array items: *66 examples: - default-response: *690 + default-response: *684 headers: Link: *54 x-github: @@ -106388,7 +105793,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &709 + enterprise: &703 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -106446,7 +105851,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &710 + installation: &704 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -106465,7 +105870,7 @@ x-webhooks: required: - id - node_id - organization: &711 + organization: &705 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -106525,13 +105930,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &712 + repository: &706 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &742 + properties: &736 id: description: Unique identifier of the repository example: 42 @@ -107214,7 +106619,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &743 + required: &737 - archive_url - assignees_url - blobs_url @@ -107365,10 +106770,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -107444,11 +106849,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - rule: &713 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + rule: &707 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -107671,11 +107076,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - rule: *713 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + rule: *707 sender: *4 required: - action @@ -107858,11 +107263,11 @@ x-webhooks: - everyone required: - from - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - rule: *713 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + rule: *707 sender: *4 required: - action @@ -107946,7 +107351,7 @@ x-webhooks: type: string enum: - completed - check_run: &715 + check_run: &709 title: CheckRun description: A check performed on the code of a given code change type: object @@ -107999,7 +107404,7 @@ x-webhooks: type: string pull_requests: type: array - items: *406 + items: *401 repository: *143 status: example: completed @@ -108037,7 +107442,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *714 + deployment: *708 details_url: example: https://example.com type: string @@ -108087,7 +107492,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *406 + items: *401 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -108122,10 +107527,10 @@ x-webhooks: - output - app - pull_requests - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + installation: *704 + enterprise: *703 + organization: *705 + repository: *706 sender: *4 required: - check_run @@ -108518,11 +107923,11 @@ x-webhooks: type: string enum: - created - check_run: *715 - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + check_run: *709 + installation: *704 + enterprise: *703 + organization: *705 + repository: *706 sender: *4 required: - check_run @@ -108918,11 +108323,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *715 - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + check_run: *709 + installation: *704 + enterprise: *703 + organization: *705 + repository: *706 requested_action: description: The action requested by the user. type: object @@ -109327,11 +108732,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *715 - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + check_run: *709 + installation: *704 + enterprise: *703 + organization: *705 + repository: *706 sender: *4 required: - check_run @@ -110308,10 +109713,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -110584,6 +109989,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -110996,10 +110406,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -111267,6 +110677,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -111678,10 +111093,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -111847,7 +111262,7 @@ x-webhooks: required: - login - id - dismissed_comment: *422 + dismissed_comment: *417 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -111992,20 +111407,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &716 + commit_oid: &710 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *709 - installation: *710 - organization: *711 - ref: &717 + enterprise: *703 + installation: *704 + organization: *705 + ref: &711 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *712 + repository: *706 sender: *4 required: - action @@ -112170,7 +111585,7 @@ x-webhooks: required: - login - id - dismissed_comment: *422 + dismissed_comment: *417 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -112400,12 +111815,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *710 + enterprise: *703 + installation: *704 + organization: *705 + ref: *711 + repository: *706 sender: *4 required: - action @@ -112500,7 +111915,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *422 + dismissed_comment: *417 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -112671,12 +112086,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *710 + enterprise: *703 + installation: *704 + organization: *705 + ref: *711 + repository: *706 sender: *4 required: - action @@ -112842,7 +112257,7 @@ x-webhooks: required: - login - id - dismissed_comment: *422 + dismissed_comment: *417 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -113008,12 +112423,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *710 + enterprise: *703 + installation: *704 + organization: *705 + ref: *711 + repository: *706 sender: *4 required: - action @@ -113113,7 +112528,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *422 + dismissed_comment: *417 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -113281,16 +112696,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *712 + repository: *706 sender: *4 required: - action @@ -113387,7 +112802,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *422 + dismissed_comment: *417 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -113527,12 +112942,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *710 + enterprise: *703 + installation: *704 + organization: *705 + ref: *711 + repository: *706 sender: *4 required: - action @@ -113789,10 +113204,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -113872,18 +113287,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *711 - pusher_type: &718 + organization: *705 + pusher_type: &712 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &719 + ref: &713 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -113893,7 +113308,7 @@ x-webhooks: enum: - tag - branch - repository: *712 + repository: *706 sender: *4 required: - ref @@ -113976,9 +113391,9 @@ x-webhooks: enum: - created definition: *266 - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 sender: *4 required: - action @@ -114063,9 +113478,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 sender: *4 required: - action @@ -114143,9 +113558,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *266 - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 sender: *4 required: - action @@ -114223,9 +113638,9 @@ x-webhooks: enum: - updated definition: *266 - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 sender: *4 required: - action @@ -114302,10 +113717,10 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - repository: *712 - organization: *711 + enterprise: *703 + installation: *704 + repository: *706 + organization: *705 sender: *4 new_property_values: type: array @@ -114390,18 +113805,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - pusher_type: *718 - ref: *719 + enterprise: *703 + installation: *704 + organization: *705 + pusher_type: *712 + ref: *713 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *712 + repository: *706 sender: *4 required: - ref @@ -114485,11 +113900,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *473 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *4 required: - action @@ -114573,11 +113988,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *473 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *4 required: - action @@ -114661,11 +114076,11 @@ x-webhooks: type: string enum: - created - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *473 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *4 required: - action @@ -114747,11 +114162,11 @@ x-webhooks: type: string enum: - dismissed - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *473 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *4 required: - action @@ -114833,11 +114248,11 @@ x-webhooks: type: string enum: - fixed - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *473 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *4 required: - action @@ -114920,11 +114335,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *473 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *4 required: - action @@ -115006,11 +114421,11 @@ x-webhooks: type: string enum: - reopened - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *473 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *4 required: - action @@ -115087,9 +114502,9 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - key: &720 + enterprise: *703 + installation: *704 + key: &714 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -115125,8 +114540,8 @@ x-webhooks: - verified - created_at - read_only - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -115203,11 +114618,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - key: *720 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + key: *714 + organization: *705 + repository: *706 sender: *4 required: - action @@ -115768,12 +115183,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - workflow: &724 + workflow: &718 title: Workflow type: object nullable: true @@ -116499,13 +115914,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *484 + deployment: *479 pull_requests: type: array - items: *571 - repository: *712 - organization: *711 - installation: *710 + items: *566 + repository: *706 + organization: *705 + installation: *704 sender: *4 responses: '200': @@ -116576,7 +115991,7 @@ x-webhooks: type: string enum: - approved - approver: &721 + approver: &715 type: object properties: avatar_url: @@ -116619,11 +116034,11 @@ x-webhooks: type: string comment: type: string - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - reviewers: &722 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + reviewers: &716 type: array items: type: object @@ -116702,7 +116117,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &723 + workflow_job_run: &717 type: object properties: conclusion: @@ -117433,18 +116848,18 @@ x-webhooks: type: string enum: - rejected - approver: *721 + approver: *715 comment: type: string - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - reviewers: *722 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + reviewers: *716 sender: *4 since: type: string - workflow_job_run: *723 + workflow_job_run: *717 workflow_job_runs: type: array items: @@ -118148,13 +117563,13 @@ x-webhooks: type: string enum: - requested - enterprise: *709 + enterprise: *703 environment: type: string - installation: *710 - organization: *711 - repository: *712 - requestor: &729 + installation: *704 + organization: *705 + repository: *706 + requestor: &723 title: User type: object nullable: true @@ -120053,12 +119468,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - workflow: *724 + workflow: *718 workflow_run: title: Deployment Workflow Run type: object @@ -120738,7 +120153,7 @@ x-webhooks: type: string enum: - answered - answer: &727 + answer: &721 type: object properties: author_association: @@ -120895,7 +120310,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &725 + discussion: &719 title: Discussion description: A Discussion in a repository. type: object @@ -121181,7 +120596,7 @@ x-webhooks: - id labels: type: array - items: *533 + items: *528 required: - repository_url - category @@ -121203,10 +120618,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -121333,11 +120748,11 @@ x-webhooks: - from required: - category - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -121420,11 +120835,11 @@ x-webhooks: type: string enum: - closed - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -121506,7 +120921,7 @@ x-webhooks: type: string enum: - created - comment: &726 + comment: &720 type: object properties: author_association: @@ -121663,11 +121078,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -121750,12 +121165,12 @@ x-webhooks: type: string enum: - deleted - comment: *726 - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + comment: *720 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -121850,12 +121265,12 @@ x-webhooks: - from required: - body - comment: *726 - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + comment: *720 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -121939,11 +121354,11 @@ x-webhooks: type: string enum: - created - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122025,11 +121440,11 @@ x-webhooks: type: string enum: - deleted - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122129,11 +121544,11 @@ x-webhooks: type: string required: - from - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122215,10 +121630,10 @@ x-webhooks: type: string enum: - labeled - discussion: *725 - enterprise: *709 - installation: *710 - label: &728 + discussion: *719 + enterprise: *703 + installation: *704 + label: &722 title: Label type: object properties: @@ -122250,8 +121665,8 @@ x-webhooks: - color - default - description - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122334,11 +121749,11 @@ x-webhooks: type: string enum: - locked - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122420,11 +121835,11 @@ x-webhooks: type: string enum: - pinned - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122506,11 +121921,11 @@ x-webhooks: type: string enum: - reopened - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122595,16 +122010,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *725 - new_repository: *712 + new_discussion: *719 + new_repository: *706 required: - new_discussion - new_repository - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122687,10 +122102,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *725 - old_answer: *727 - organization: *711 - repository: *712 + discussion: *719 + old_answer: *721 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122772,12 +122187,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *725 - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + label: *722 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122860,11 +122275,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -122946,11 +122361,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *719 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -123023,7 +122438,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *709 + enterprise: *703 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -123683,9 +123098,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *710 - organization: *711 - repository: *712 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - forkee @@ -123831,9 +123246,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 pages: description: The pages that were updated. type: array @@ -123870,7 +123285,7 @@ x-webhooks: - action - sha - html_url - repository: *712 + repository: *706 sender: *4 required: - pages @@ -123946,10 +123361,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 + enterprise: *703 installation: *22 - organization: *711 - repositories: &730 + organization: *705 + repositories: &724 description: An array of repository objects that the installation can access. type: array @@ -123975,8 +123390,8 @@ x-webhooks: - name - full_name - private - repository: *712 - requester: *729 + repository: *706 + requester: *723 sender: *4 required: - action @@ -124051,11 +123466,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 + enterprise: *703 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *705 + repositories: *724 + repository: *706 requester: nullable: true sender: *4 @@ -124131,11 +123546,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *709 + enterprise: *703 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *705 + repositories: *724 + repository: *706 requester: nullable: true sender: *4 @@ -124211,10 +123626,10 @@ x-webhooks: type: string enum: - added - enterprise: *709 + enterprise: *703 installation: *22 - organization: *711 - repositories_added: &731 + organization: *705 + repositories_added: &725 description: An array of repository objects, which were added to the installation. type: array @@ -124260,15 +123675,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *712 - repository_selection: &732 + repository: *706 + repository_selection: &726 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *729 + requester: *723 sender: *4 required: - action @@ -124347,10 +123762,10 @@ x-webhooks: type: string enum: - removed - enterprise: *709 + enterprise: *703 installation: *22 - organization: *711 - repositories_added: *731 + organization: *705 + repositories_added: *725 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -124377,9 +123792,9 @@ x-webhooks: - name - full_name - private - repository: *712 - repository_selection: *732 - requester: *729 + repository: *706 + repository_selection: *726 + requester: *723 sender: *4 required: - action @@ -124458,11 +123873,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *709 + enterprise: *703 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *705 + repositories: *724 + repository: *706 requester: nullable: true sender: *4 @@ -124640,10 +124055,10 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 target_type: type: string @@ -124722,11 +124137,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *709 + enterprise: *703 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *705 + repositories: *724 + repository: *706 requester: nullable: true sender: *4 @@ -124978,8 +124393,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -125773,8 +125188,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 state: description: State of the issue; either 'open' or 'closed' type: string @@ -126123,8 +125538,8 @@ x-webhooks: - state - locked - assignee - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -126204,7 +125619,7 @@ x-webhooks: type: string enum: - deleted - comment: &733 + comment: &727 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -126369,8 +125784,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -127160,8 +126575,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 state: description: State of the issue; either 'open' or 'closed' type: string @@ -127512,8 +126927,8 @@ x-webhooks: - state - locked - assignee - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -127593,7 +127008,7 @@ x-webhooks: type: string enum: - edited - changes: &762 + changes: &756 description: The changes to the comment. type: object properties: @@ -127605,9 +127020,9 @@ x-webhooks: type: string required: - from - comment: *733 - enterprise: *709 - installation: *710 + comment: *727 + enterprise: *703 + installation: *704 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -128400,8 +127815,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128750,8 +128165,8 @@ x-webhooks: - state - locked - assignee - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -128841,9 +128256,9 @@ x-webhooks: type: number blocking_issue: *82 blocking_issue_repo: *66 - installation: *710 - organization: *711 - repository: *712 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -128937,9 +128352,9 @@ x-webhooks: type: number blocking_issue: *82 blocking_issue_repo: *66 - installation: *710 - organization: *711 - repository: *712 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -129032,9 +128447,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -129128,9 +128543,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -129215,10 +128630,10 @@ x-webhooks: type: string enum: - assigned - assignee: *729 - enterprise: *709 - installation: *710 - issue: &736 + assignee: *723 + enterprise: *703 + installation: *704 + issue: &730 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -130007,11 +129422,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130128,8 +129543,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -130209,8 +129624,8 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -131004,11 +130419,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131260,8 +130675,8 @@ x-webhooks: required: - state - closed_at - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -131340,8 +130755,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -132126,11 +131541,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132246,8 +131661,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -132326,8 +131741,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -133134,11 +132549,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133233,7 +132648,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &734 + milestone: &728 title: Milestone description: A collection of related issues and pull requests. type: object @@ -133371,8 +132786,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -133471,8 +132886,8 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -134261,11 +133676,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134382,9 +133797,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *728 - organization: *711 - repository: *712 + label: *722 + organization: *705 + repository: *706 sender: *4 required: - action @@ -134464,8 +133879,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135253,11 +134668,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135374,9 +134789,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *728 - organization: *711 - repository: *712 + label: *722 + organization: *705 + repository: *706 sender: *4 required: - action @@ -135456,8 +134871,8 @@ x-webhooks: type: string enum: - locked - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136269,11 +135684,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136367,8 +135782,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -136447,8 +135862,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -137254,11 +136669,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137352,9 +136767,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *734 - organization: *711 - repository: *712 + milestone: *728 + organization: *705 + repository: *706 sender: *4 required: - action @@ -138222,11 +137637,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138788,8 +138203,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139578,11 +138993,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139698,8 +139113,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -139779,9 +139194,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *709 - installation: *710 - issue: &735 + enterprise: *703 + installation: *704 + issue: &729 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -140564,11 +139979,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140684,8 +140099,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -140764,8 +140179,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141575,11 +140990,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141674,8 +141089,8 @@ x-webhooks: user_view_type: type: string type: *219 - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -142541,11 +141956,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143129,11 +142544,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *709 - installation: *710 - issue: *735 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + issue: *729 + organization: *705 + repository: *706 sender: *4 required: - action @@ -143213,12 +142628,12 @@ x-webhooks: type: string enum: - typed - enterprise: *709 - installation: *710 - issue: *736 + enterprise: *703 + installation: *704 + issue: *730 type: *219 - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -143299,7 +142714,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &765 + assignee: &759 title: User type: object nullable: true @@ -143369,11 +142784,11 @@ x-webhooks: required: - login - id - enterprise: *709 - installation: *710 - issue: *736 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + issue: *730 + organization: *705 + repository: *706 sender: *4 required: - action @@ -143452,12 +142867,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *709 - installation: *710 - issue: *736 - label: *728 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + issue: *730 + label: *722 + organization: *705 + repository: *706 sender: *4 required: - action @@ -143537,8 +142952,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144348,11 +143763,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *645 + issue_dependencies_summary: *646 issue_field_values: type: array - items: *651 + items: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144446,8 +143861,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -144527,11 +143942,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *709 - installation: *710 - issue: *735 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + issue: *729 + organization: *705 + repository: *706 sender: *4 required: - action @@ -144610,12 +144025,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *709 - installation: *710 - issue: *736 + enterprise: *703 + installation: *704 + issue: *730 type: *219 - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -144695,11 +144110,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + label: *722 + organization: *705 + repository: *706 sender: *4 required: - action @@ -144777,11 +144192,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + label: *722 + organization: *705 + repository: *706 sender: *4 required: - action @@ -144891,11 +144306,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + label: *722 + organization: *705 + repository: *706 sender: *4 required: - action @@ -144977,9 +144392,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: &737 + enterprise: *703 + installation: *704 + marketplace_purchase: &731 title: Marketplace Purchase type: object required: @@ -145062,8 +144477,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *711 - previous_marketplace_purchase: &738 + organization: *705 + previous_marketplace_purchase: &732 title: Marketplace Purchase type: object properties: @@ -145143,7 +144558,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *712 + repository: *706 sender: *4 required: - action @@ -145223,10 +144638,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: *737 - organization: *711 + enterprise: *703 + installation: *704 + marketplace_purchase: *731 + organization: *705 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -145309,7 +144724,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *712 + repository: *706 sender: *4 required: - action @@ -145391,10 +144806,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: *737 - organization: *711 + enterprise: *703 + installation: *704 + marketplace_purchase: *731 + organization: *705 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -145476,7 +144891,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *712 + repository: *706 sender: *4 required: - action @@ -145557,8 +144972,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 marketplace_purchase: title: Marketplace Purchase type: object @@ -145640,9 +145055,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *711 - previous_marketplace_purchase: *738 - repository: *712 + organization: *705 + previous_marketplace_purchase: *732 + repository: *706 sender: *4 required: - action @@ -145722,12 +145137,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: *737 - organization: *711 - previous_marketplace_purchase: *738 - repository: *712 + enterprise: *703 + installation: *704 + marketplace_purchase: *731 + organization: *705 + previous_marketplace_purchase: *732 + repository: *706 sender: *4 required: - action @@ -145829,11 +145244,11 @@ x-webhooks: type: string required: - to - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + member: *723 + organization: *705 + repository: *706 sender: *4 required: - action @@ -145933,11 +145348,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + member: *723 + organization: *705 + repository: *706 sender: *4 required: - action @@ -146016,11 +145431,11 @@ x-webhooks: type: string enum: - removed - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + member: *723 + organization: *705 + repository: *706 sender: *4 required: - action @@ -146098,11 +145513,11 @@ x-webhooks: type: string enum: - added - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + member: *723 + organization: *705 + repository: *706 scope: description: The scope of the membership. Currently, can only be `team`. @@ -146178,7 +145593,7 @@ x-webhooks: required: - login - id - team: &739 + team: &733 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -146401,11 +145816,11 @@ x-webhooks: type: string enum: - removed - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + member: *723 + organization: *705 + repository: *706 scope: description: The scope of the membership. Currently, can only be `team`. @@ -146482,7 +145897,7 @@ x-webhooks: required: - login - id - team: *739 + team: *733 required: - action - scope @@ -146564,8 +145979,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *710 - merge_group: &741 + installation: *704 + merge_group: &735 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -146584,15 +145999,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *740 + head_commit: *734 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -146678,10 +146093,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *710 - merge_group: *741 - organization: *711 - repository: *712 + installation: *704 + merge_group: *735 + organization: *705 + repository: *706 sender: *4 required: - action @@ -146754,7 +146169,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 + enterprise: *703 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -146863,16 +146278,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *710 - organization: *711 + installation: *704 + organization: *705 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *736 + required: *737 nullable: true sender: *4 required: @@ -146953,11 +146368,11 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 - milestone: *734 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + milestone: *728 + organization: *705 + repository: *706 sender: *4 required: - action @@ -147036,9 +146451,9 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - milestone: &744 + enterprise: *703 + installation: *704 + milestone: &738 title: Milestone description: A collection of related issues and pull requests. type: object @@ -147175,8 +146590,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -147255,11 +146670,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - milestone: *734 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + milestone: *728 + organization: *705 + repository: *706 sender: *4 required: - action @@ -147369,11 +146784,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - milestone: *734 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + milestone: *728 + organization: *705 + repository: *706 sender: *4 required: - action @@ -147453,11 +146868,11 @@ x-webhooks: type: string enum: - opened - enterprise: *709 - installation: *710 - milestone: *744 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + milestone: *738 + organization: *705 + repository: *706 sender: *4 required: - action @@ -147536,11 +146951,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *729 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + blocked_user: *723 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -147619,11 +147034,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *729 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + blocked_user: *723 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -147702,9 +147117,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - membership: &745 + enterprise: *703 + installation: *704 + membership: &739 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -147811,8 +147226,8 @@ x-webhooks: - role - organization_url - user - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 required: - action @@ -147890,11 +147305,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *709 - installation: *710 - membership: *745 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + membership: *739 + organization: *705 + repository: *706 sender: *4 required: - action @@ -147973,8 +147388,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -148090,10 +147505,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 - user: *729 + user: *723 required: - action - invitation @@ -148171,11 +147586,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *709 - installation: *710 - membership: *745 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + membership: *739 + organization: *705 + repository: *706 sender: *4 required: - action @@ -148262,11 +147677,11 @@ x-webhooks: properties: from: type: string - enterprise: *709 - installation: *710 - membership: *745 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + membership: *739 + organization: *705 + repository: *706 sender: *4 required: - action @@ -148342,9 +147757,9 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 package: description: Information about the package. type: object @@ -148843,7 +148258,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &746 + items: &740 title: Ruby Gems metadata type: object properties: @@ -148938,7 +148353,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *706 sender: *4 required: - action @@ -149014,9 +148429,9 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 package: description: Information about the package. type: object @@ -149369,7 +148784,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *746 + items: *740 source_url: type: string format: uri @@ -149439,7 +148854,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *706 sender: *4 required: - action @@ -149616,12 +149031,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *709 + enterprise: *703 id: type: integer - installation: *710 - organization: *711 - repository: *712 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - id @@ -149698,7 +149113,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &747 + personal_access_token_request: &741 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -149844,10 +149259,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *709 - organization: *711 + enterprise: *703 + organization: *705 sender: *4 - installation: *710 + installation: *704 required: - action - personal_access_token_request @@ -149924,11 +149339,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *747 - enterprise: *709 - organization: *711 + personal_access_token_request: *741 + enterprise: *703 + organization: *705 sender: *4 - installation: *710 + installation: *704 required: - action - personal_access_token_request @@ -150004,11 +149419,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *747 - enterprise: *709 - organization: *711 + personal_access_token_request: *741 + enterprise: *703 + organization: *705 sender: *4 - installation: *710 + installation: *704 required: - action - personal_access_token_request @@ -150083,11 +149498,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *747 - organization: *711 - enterprise: *709 + personal_access_token_request: *741 + organization: *705 + enterprise: *703 sender: *4 - installation: *710 + installation: *704 required: - action - personal_access_token_request @@ -150192,7 +149607,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *748 + last_response: *742 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -150224,8 +149639,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 zen: description: Random string of GitHub zen. @@ -150470,10 +149885,10 @@ x-webhooks: - from required: - note - enterprise: *709 - installation: *710 - organization: *711 - project_card: &749 + enterprise: *703 + installation: *704 + organization: *705 + project_card: &743 title: Project Card type: object properties: @@ -150592,7 +150007,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *712 + repository: *706 sender: *4 required: - action @@ -150673,11 +150088,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - project_card: *749 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + project_card: *743 + repository: *706 sender: *4 required: - action @@ -150757,9 +150172,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 project_card: title: Project Card type: object @@ -150887,8 +150302,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *736 + required: *737 nullable: true sender: *4 required: @@ -150982,11 +150397,11 @@ x-webhooks: - from required: - note - enterprise: *709 - installation: *710 - organization: *711 - project_card: *749 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + project_card: *743 + repository: *706 sender: *4 required: - action @@ -151080,9 +150495,9 @@ x-webhooks: - from required: - column_id - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 project_card: allOf: - title: Project Card @@ -151272,7 +150687,7 @@ x-webhooks: type: string required: - after_id - repository: *712 + repository: *706 sender: *4 required: - action @@ -151352,10 +150767,10 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 - organization: *711 - project: &751 + enterprise: *703 + installation: *704 + organization: *705 + project: &745 title: Project type: object properties: @@ -151479,7 +150894,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *712 + repository: *706 sender: *4 required: - action @@ -151559,10 +150974,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - project_column: &750 + enterprise: *703 + installation: *704 + organization: *705 + project_column: &744 title: Project Column type: object properties: @@ -151601,7 +151016,7 @@ x-webhooks: - name - created_at - updated_at - repository: *712 + repository: *706 sender: *4 required: - action @@ -151680,18 +151095,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - project_column: *750 + enterprise: *703 + installation: *704 + organization: *705 + project_column: *744 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *736 + required: *737 nullable: true sender: *4 required: @@ -151781,11 +151196,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - project_column: *750 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + project_column: *744 + repository: *706 sender: *4 required: - action @@ -151865,11 +151280,11 @@ x-webhooks: type: string enum: - moved - enterprise: *709 - installation: *710 - organization: *711 - project_column: *750 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + project_column: *744 + repository: *706 sender: *4 required: - action @@ -151949,11 +151364,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - project: *751 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + project: *745 + repository: *706 sender: *4 required: - action @@ -152033,18 +151448,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - project: *751 + enterprise: *703 + installation: *704 + organization: *705 + project: *745 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *736 + required: *737 nullable: true sender: *4 required: @@ -152146,11 +151561,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - project: *751 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + project: *745 + repository: *706 sender: *4 required: - action @@ -152229,11 +151644,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *709 - installation: *710 - organization: *711 - project: *751 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + project: *745 + repository: *706 sender: *4 required: - action @@ -152314,8 +151729,8 @@ x-webhooks: type: string enum: - closed - installation: *710 - organization: *711 + installation: *704 + organization: *705 projects_v2: *253 sender: *4 required: @@ -152397,8 +151812,8 @@ x-webhooks: type: string enum: - created - installation: *710 - organization: *711 + installation: *704 + organization: *705 projects_v2: *253 sender: *4 required: @@ -152480,8 +151895,8 @@ x-webhooks: type: string enum: - deleted - installation: *710 - organization: *711 + installation: *704 + organization: *705 projects_v2: *253 sender: *4 required: @@ -152599,8 +152014,8 @@ x-webhooks: type: string to: type: string - installation: *710 - organization: *711 + installation: *704 + organization: *705 projects_v2: *253 sender: *4 required: @@ -152684,7 +152099,7 @@ x-webhooks: type: string enum: - archived - changes: &755 + changes: &749 type: object properties: archived_at: @@ -152698,9 +152113,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *710 - organization: *711 - projects_v2_item: &752 + installation: *704 + organization: *705 + projects_v2_item: &746 title: Projects v2 Item description: An item belonging to a project type: object @@ -152835,9 +152250,9 @@ x-webhooks: nullable: true to: type: string - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *704 + organization: *705 + projects_v2_item: *746 sender: *4 required: - action @@ -152919,9 +152334,9 @@ x-webhooks: type: string enum: - created - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *704 + organization: *705 + projects_v2_item: *746 sender: *4 required: - action @@ -153002,9 +152417,9 @@ x-webhooks: type: string enum: - deleted - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *704 + organization: *705 + projects_v2_item: *746 sender: *4 required: - action @@ -153110,7 +152525,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &753 + - &747 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -153132,7 +152547,7 @@ x-webhooks: required: - id - name - - &754 + - &748 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -153166,8 +152581,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *753 - - *754 + - *747 + - *748 required: - field_value - type: object @@ -153183,9 +152598,9 @@ x-webhooks: nullable: true required: - body - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *704 + organization: *705 + projects_v2_item: *746 sender: *4 required: - action @@ -153280,9 +152695,9 @@ x-webhooks: to: type: string nullable: true - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *704 + organization: *705 + projects_v2_item: *746 sender: *4 required: - action @@ -153365,10 +152780,10 @@ x-webhooks: type: string enum: - restored - changes: *755 - installation: *710 - organization: *711 - projects_v2_item: *752 + changes: *749 + installation: *704 + organization: *705 + projects_v2_item: *746 sender: *4 required: - action @@ -153450,8 +152865,8 @@ x-webhooks: type: string enum: - reopened - installation: *710 - organization: *711 + installation: *704 + organization: *705 projects_v2: *253 sender: *4 required: @@ -153533,14 +152948,14 @@ x-webhooks: type: string enum: - created - installation: *710 - organization: *711 - projects_v2_status_update: &758 + installation: *704 + organization: *705 + projects_v2_status_update: &752 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *756 - required: *757 + properties: *750 + required: *751 sender: *4 required: - action @@ -153621,9 +153036,9 @@ x-webhooks: type: string enum: - deleted - installation: *710 - organization: *711 - projects_v2_status_update: *758 + installation: *704 + organization: *705 + projects_v2_status_update: *752 sender: *4 required: - action @@ -153759,9 +153174,9 @@ x-webhooks: type: string format: date nullable: true - installation: *710 - organization: *711 - projects_v2_status_update: *758 + installation: *704 + organization: *705 + projects_v2_status_update: *752 sender: *4 required: - action @@ -153832,10 +153247,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - repository @@ -153912,13 +153327,13 @@ x-webhooks: type: string enum: - assigned - assignee: *729 - enterprise: *709 - installation: *710 - number: &759 + assignee: *723 + enterprise: *703 + installation: *704 + number: &753 description: The pull request number. type: integer - organization: *711 + organization: *705 pull_request: title: Pull Request type: object @@ -156201,7 +155616,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 sender: *4 required: - action @@ -156283,11 +155698,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 number: type: integer - organization: *711 + organization: *705 pull_request: title: Pull Request type: object @@ -158565,7 +157980,7 @@ x-webhooks: - draft reason: type: string - repository: *712 + repository: *706 sender: *4 required: - action @@ -158647,11 +158062,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 number: type: integer - organization: *711 + organization: *705 pull_request: title: Pull Request type: object @@ -160929,7 +160344,7 @@ x-webhooks: - draft reason: type: string - repository: *712 + repository: *706 sender: *4 required: - action @@ -161011,13 +160426,13 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: &760 + enterprise: *703 + installation: *704 + number: *753 + organization: *705 + pull_request: &754 allOf: - - *571 + - *566 - type: object properties: allow_auto_merge: @@ -161079,7 +160494,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *712 + repository: *706 sender: *4 required: - action @@ -161160,12 +160575,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *703 + installation: *704 + number: *753 + organization: *705 + pull_request: *754 + repository: *706 sender: *4 required: - action @@ -161245,11 +160660,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *709 - milestone: *553 - number: *759 - organization: *711 - pull_request: &761 + enterprise: *703 + milestone: *548 + number: *753 + organization: *705 + pull_request: &755 title: Pull Request type: object properties: @@ -163512,7 +162927,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 sender: *4 required: - action @@ -163591,11 +163006,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 number: type: integer - organization: *711 + organization: *705 pull_request: title: Pull Request type: object @@ -165877,7 +165292,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *712 + repository: *706 sender: *4 required: - action @@ -166001,12 +165416,12 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *703 + installation: *704 + number: *753 + organization: *705 + pull_request: *754 + repository: *706 sender: *4 required: - action @@ -166086,11 +165501,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 number: type: integer - organization: *711 + organization: *705 pull_request: title: Pull Request type: object @@ -168357,7 +167772,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 sender: *4 required: - action @@ -168437,11 +167852,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *709 - installation: *710 - label: *728 - number: *759 - organization: *711 + enterprise: *703 + installation: *704 + label: *722 + number: *753 + organization: *705 pull_request: title: Pull Request type: object @@ -170723,7 +170138,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 sender: *4 required: - action @@ -170804,10 +170219,10 @@ x-webhooks: type: string enum: - locked - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + enterprise: *703 + installation: *704 + number: *753 + organization: *705 pull_request: title: Pull Request type: object @@ -173087,7 +172502,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 sender: *4 required: - action @@ -173167,12 +172582,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *709 - milestone: *553 - number: *759 - organization: *711 - pull_request: *761 - repository: *712 + enterprise: *703 + milestone: *548 + number: *753 + organization: *705 + pull_request: *755 + repository: *706 sender: *4 required: - action @@ -173251,12 +172666,12 @@ x-webhooks: type: string enum: - opened - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *703 + installation: *704 + number: *753 + organization: *705 + pull_request: *754 + repository: *706 sender: *4 required: - action @@ -173337,12 +172752,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *703 + installation: *704 + number: *753 + organization: *705 + pull_request: *754 + repository: *706 sender: *4 required: - action @@ -173422,12 +172837,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *703 + installation: *704 + number: *753 + organization: *705 + pull_request: *754 + repository: *706 sender: *4 required: - action @@ -173793,9 +173208,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 pull_request: type: object properties: @@ -175965,7 +175380,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *712 + repository: *706 sender: *4 required: - action @@ -176045,7 +175460,7 @@ x-webhooks: type: string enum: - deleted - comment: &763 + comment: &757 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -176330,9 +175745,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 pull_request: type: object properties: @@ -178490,7 +177905,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *712 + repository: *706 sender: *4 required: - action @@ -178570,11 +177985,11 @@ x-webhooks: type: string enum: - edited - changes: *762 - comment: *763 - enterprise: *709 - installation: *710 - organization: *711 + changes: *756 + comment: *757 + enterprise: *703 + installation: *704 + organization: *705 pull_request: type: object properties: @@ -180735,7 +180150,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *712 + repository: *706 sender: *4 required: - action @@ -180816,9 +180231,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 pull_request: title: Simple Pull Request type: object @@ -182991,7 +182406,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 + repository: *706 review: description: The review that was affected. type: object @@ -183238,9 +182653,9 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 pull_request: title: Simple Pull Request type: object @@ -185294,8 +184709,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 - review: &764 + repository: *706 + review: &758 description: The review that was affected. type: object properties: @@ -185528,12 +184943,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 number: description: The pull request number. type: integer - organization: *711 + organization: *705 pull_request: title: Pull Request type: object @@ -187816,7 +187231,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 requested_reviewer: title: User type: object @@ -187900,12 +187315,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 number: description: The pull request number. type: integer - organization: *711 + organization: *705 pull_request: title: Pull Request type: object @@ -190195,7 +189610,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 requested_team: title: Team description: Groups of organization members that gives permissions @@ -190387,12 +189802,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 number: description: The pull request number. type: integer - organization: *711 + organization: *705 pull_request: title: Pull Request type: object @@ -192677,7 +192092,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 requested_reviewer: title: User type: object @@ -192762,12 +192177,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *709 - installation: *710 + enterprise: *703 + installation: *704 number: description: The pull request number. type: integer - organization: *711 + organization: *705 pull_request: title: Pull Request type: object @@ -195043,7 +194458,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 requested_team: title: Team description: Groups of organization members that gives permissions @@ -195224,9 +194639,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 pull_request: title: Simple Pull Request type: object @@ -197401,8 +196816,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 - review: *764 + repository: *706 + review: *758 sender: *4 required: - action @@ -197482,9 +196897,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 pull_request: title: Simple Pull Request type: object @@ -199554,7 +198969,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 + repository: *706 sender: *4 thread: type: object @@ -199941,9 +199356,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 pull_request: title: Simple Pull Request type: object @@ -201999,7 +201414,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 + repository: *706 sender: *4 thread: type: object @@ -202389,10 +201804,10 @@ x-webhooks: type: string before: type: string - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + enterprise: *703 + installation: *704 + number: *753 + organization: *705 pull_request: title: Pull Request type: object @@ -204663,7 +204078,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 sender: *4 required: - action @@ -204745,11 +204160,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *765 - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + assignee: *759 + enterprise: *703 + installation: *704 + number: *753 + organization: *705 pull_request: title: Pull Request type: object @@ -207032,7 +206447,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 sender: *4 required: - action @@ -207111,11 +206526,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *709 - installation: *710 - label: *728 - number: *759 - organization: *711 + enterprise: *703 + installation: *704 + label: *722 + number: *753 + organization: *705 pull_request: title: Pull Request type: object @@ -209388,7 +208803,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 sender: *4 required: - action @@ -209469,10 +208884,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + enterprise: *703 + installation: *704 + number: *753 + organization: *705 pull_request: title: Pull Request type: object @@ -211737,7 +211152,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *706 sender: *4 required: - action @@ -211937,7 +211352,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *709 + enterprise: *703 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -212029,8 +211444,8 @@ x-webhooks: - url - author - committer - installation: *710 - organization: *711 + installation: *704 + organization: *705 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -212605,9 +212020,9 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 registry_package: type: object properties: @@ -213053,7 +212468,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *746 + items: *740 summary: type: string tag_name: @@ -213107,7 +212522,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *706 sender: *4 required: - action @@ -213185,9 +212600,9 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 registry_package: type: object properties: @@ -213495,7 +212910,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *746 + items: *740 summary: type: string tag_name: @@ -213544,7 +212959,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *706 sender: *4 required: - action @@ -213621,10 +213036,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - release: &766 + enterprise: *703 + installation: *704 + organization: *705 + release: &760 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -213942,7 +213357,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *712 + repository: *706 sender: *4 required: - action @@ -214019,11 +213434,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - release: *766 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + release: *760 + repository: *706 sender: *4 required: - action @@ -214140,11 +213555,11 @@ x-webhooks: type: boolean required: - to - enterprise: *709 - installation: *710 - organization: *711 - release: *766 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + release: *760 + repository: *706 sender: *4 required: - action @@ -214222,9 +213637,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -214546,7 +213961,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *712 + repository: *706 sender: *4 required: - action @@ -214622,10 +214037,10 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 - release: &767 + enterprise: *703 + installation: *704 + organization: *705 + release: &761 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -214944,7 +214359,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *712 + repository: *706 sender: *4 required: - action @@ -215020,11 +214435,11 @@ x-webhooks: type: string enum: - released - enterprise: *709 - installation: *710 - organization: *711 - release: *766 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + release: *760 + repository: *706 sender: *4 required: - action @@ -215100,11 +214515,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *709 - installation: *710 - organization: *711 - release: *767 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + release: *761 + repository: *706 sender: *4 required: - action @@ -215180,11 +214595,11 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - repository_advisory: *635 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + repository_advisory: *631 sender: *4 required: - action @@ -215260,11 +214675,11 @@ x-webhooks: type: string enum: - reported - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - repository_advisory: *635 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + repository_advisory: *631 sender: *4 required: - action @@ -215340,10 +214755,10 @@ x-webhooks: type: string enum: - archived - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -215420,10 +214835,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -215501,10 +214916,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -215588,10 +215003,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -215703,10 +215118,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -215778,10 +215193,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 status: type: string @@ -215862,10 +215277,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -215942,10 +215357,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -216039,10 +215454,10 @@ x-webhooks: - name required: - repository - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -216122,10 +215537,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 repository_ruleset: *298 sender: *4 required: @@ -216204,10 +215619,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 repository_ruleset: *298 sender: *4 required: @@ -216286,10 +215701,10 @@ x-webhooks: type: string enum: - edited - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 repository_ruleset: *298 changes: type: object @@ -216351,16 +215766,16 @@ x-webhooks: properties: added: type: array - items: *592 + items: *587 deleted: type: array - items: *592 + items: *587 updated: type: array items: type: object properties: - rule: *592 + rule: *587 changes: type: object properties: @@ -216594,10 +216009,10 @@ x-webhooks: - from required: - owner - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -216675,10 +216090,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -216756,7 +216171,7 @@ x-webhooks: type: string enum: - create - alert: &768 + alert: &762 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -216877,10 +216292,10 @@ x-webhooks: type: string enum: - open - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -217086,10 +216501,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -217167,11 +216582,11 @@ x-webhooks: type: string enum: - reopen - alert: *768 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *762 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -217370,10 +216785,10 @@ x-webhooks: enum: - fixed - open - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -217391,7 +216806,7 @@ x-webhooks: supported-webhook-types: - repository - organization - secret-scanning-alert-created: + secret-scanning-alert-assigned: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -217399,8 +216814,8 @@ x-webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was created. - operationId: secret-scanning-alert/created + description: A secret scanning alert was assigned. + operationId: secret-scanning-alert/assigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -217444,14 +216859,14 @@ x-webhooks: content: application/json: schema: - title: secret_scanning_alert created event + title: secret_scanning_alert assigned event type: object properties: action: type: string enum: - - created - alert: &769 + - assigned + alert: &763 type: object properties: number: *161 @@ -217569,10 +216984,93 @@ x-webhooks: properties: *20 required: *21 nullable: true - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + assignee: *4 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-created: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was created. + operationId: secret-scanning-alert/created + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: secret_scanning_alert created event + type: object + properties: + action: + type: string + enum: + - created + alert: *763 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -217653,11 +217151,11 @@ x-webhooks: type: string enum: - created - alert: *769 - installation: *710 - location: *770 - organization: *711 - repository: *712 + alert: *763 + installation: *704 + location: *764 + organization: *705 + repository: *706 sender: *4 required: - location @@ -217895,11 +217393,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *763 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -217977,11 +217475,11 @@ x-webhooks: type: string enum: - reopened - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *763 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -218059,11 +217557,94 @@ x-webhooks: type: string enum: - resolved - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *763 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-unassigned: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was unassigned. + operationId: secret-scanning-alert/unassigned + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: secret_scanning_alert unassigned event + type: object + properties: + action: + type: string + enum: + - unassigned + alert: *763 + assignee: *4 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -218141,11 +217722,11 @@ x-webhooks: type: string enum: - validated - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *763 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -218271,10 +217852,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *712 - enterprise: *709 - installation: *710 - organization: *711 + repository: *706 + enterprise: *703 + installation: *704 + organization: *705 sender: *4 required: - action @@ -218352,11 +217933,11 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - security_advisory: &771 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + security_advisory: &765 description: The details of the security advisory, including summary, description, and severity. type: object @@ -218539,11 +218120,11 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - security_advisory: *771 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + security_advisory: *765 sender: *4 required: - action @@ -218616,10 +218197,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -218804,10 +218385,10 @@ x-webhooks: type: object properties: security_and_analysis: *272 - enterprise: *709 - installation: *710 - organization: *711 - repository: *333 + enterprise: *703 + installation: *704 + organization: *705 + repository: *328 sender: *4 required: - changes @@ -218885,12 +218466,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - sponsorship: &772 + sponsorship: &766 type: object properties: created_at: @@ -219191,12 +218772,12 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - sponsorship: *772 + sponsorship: *766 required: - action - sponsorship @@ -219284,12 +218865,12 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - sponsorship: *772 + sponsorship: *766 required: - action - changes @@ -219366,17 +218947,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &773 + effective_date: &767 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - sponsorship: *772 + sponsorship: *766 required: - action - sponsorship @@ -219450,7 +219031,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &774 + changes: &768 type: object properties: tier: @@ -219494,13 +219075,13 @@ x-webhooks: - from required: - tier - effective_date: *773 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + effective_date: *767 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - sponsorship: *772 + sponsorship: *766 required: - action - changes @@ -219577,13 +219158,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *774 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + changes: *768 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - sponsorship: *772 + sponsorship: *766 required: - action - changes @@ -219657,10 +219238,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -219743,10 +219324,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -220166,15 +219747,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *709 + enterprise: *703 id: description: The unique identifier of the status. type: integer - installation: *710 + installation: *704 name: type: string - organization: *711 - repository: *712 + organization: *705 + repository: *706 sender: *4 sha: description: The Commit SHA. @@ -220289,9 +219870,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -220381,9 +219962,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -220473,9 +220054,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -220565,9 +220146,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -220644,12 +220225,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - team: &775 + team: &769 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -220872,9 +220453,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 repository: title: Repository description: A git repository @@ -221332,7 +220913,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *769 required: - action - team @@ -221408,9 +220989,9 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 repository: title: Repository description: A git repository @@ -221868,7 +221449,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *769 required: - action - team @@ -221945,9 +221526,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 repository: title: Repository description: A git repository @@ -222405,7 +221986,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *769 required: - action - team @@ -222549,9 +222130,9 @@ x-webhooks: - from required: - permissions - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 repository: title: Repository description: A git repository @@ -223009,7 +222590,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *769 required: - action - changes @@ -223087,9 +222668,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *703 + installation: *704 + organization: *705 repository: title: Repository description: A git repository @@ -223547,7 +223128,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *769 required: - action - team @@ -223623,10 +223204,10 @@ x-webhooks: type: string enum: - started - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 required: - action @@ -223699,16 +223280,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *709 + enterprise: *703 inputs: type: object nullable: true additionalProperties: true - installation: *710 - organization: *711 + installation: *704 + organization: *705 ref: type: string - repository: *712 + repository: *706 sender: *4 workflow: type: string @@ -223790,10 +223371,10 @@ x-webhooks: type: string enum: - completed - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 workflow_job: allOf: @@ -224030,7 +223611,7 @@ x-webhooks: type: string required: - conclusion - deployment: *484 + deployment: *479 required: - action - repository @@ -224109,10 +223690,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 workflow_job: allOf: @@ -224372,7 +223953,7 @@ x-webhooks: required: - status - steps - deployment: *484 + deployment: *479 required: - action - repository @@ -224451,10 +224032,10 @@ x-webhooks: type: string enum: - queued - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 workflow_job: type: object @@ -224589,7 +224170,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *484 + deployment: *479 required: - action - repository @@ -224668,10 +224249,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 workflow_job: type: object @@ -224807,7 +224388,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *484 + deployment: *479 required: - action - repository @@ -224887,12 +224468,12 @@ x-webhooks: type: string enum: - completed - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - workflow: *724 + workflow: *718 workflow_run: title: Workflow Run type: object @@ -225891,12 +225472,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - workflow: *724 + workflow: *718 workflow_run: title: Workflow Run type: object @@ -226880,12 +226461,12 @@ x-webhooks: type: string enum: - requested - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *4 - workflow: *724 + workflow: *718 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index cf7f65190..3224a3dee 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -104,10 +104,6 @@ "name": "packages", "description": "Manage packages for authenticated users and organizations." }, - { - "name": "projects-classic", - "description": "Interact with GitHub Projects (classic)." - }, { "name": "pulls", "description": "Interact with GitHub Pull Requests." @@ -4734,6 +4730,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -5735,6 +5739,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -6590,6 +6602,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -7076,6 +7096,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -9117,6 +9145,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -10169,6 +10205,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -11138,6 +11182,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -11818,6 +11870,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -27409,6 +27469,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -28205,6 +28273,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -29157,6 +29233,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -30500,6 +30584,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -59354,6 +59446,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "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.", @@ -63078,226 +63193,20 @@ "update-budget": { "value": { "message": "Budget successfully updated.", - "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" - } - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Budget not found or feature not enabled", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - }, - "examples": { - "budget-not-found": { - "value": { - "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - }, - "feature-not-enabled": { - "value": { - "message": "Not Found", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } + "budget": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "org-name/example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] } } } @@ -63306,146 +63215,367 @@ } } }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - }, - "examples": { - "server-error": { - "value": { - "message": "Unable to retrieve budget.", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - }, - "examples": { - "server-error": { - "value": { - "message": "Unable to update budget.", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": false, - "category": "billing", - "subcategory": "budgets" - } - }, - "delete": { - "summary": "Delete a budget", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDeletes a budget by ID. The authenticated user must be an enterprise admin.", - "tags": [ - "billing" - ], - "operationId": "billing/delete-budget", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#delete-a-budget" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "budget_id", - "description": "The ID corresponding to the budget.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response when deleting a budget", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "A message indicating the result of the deletion operation" - }, - "id": { - "type": "string", - "description": "The ID of the deleted budget" - } - }, - "required": [ - "message", - "id" - ] - }, - "examples": { - "default": { - "value": { - "message": "Budget successfully deleted.", - "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" - } - } - } - } - } - }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Budget not found or feature not enabled", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "budget-not-found": { + "value": { + "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + }, + "feature-not-enabled": { + "value": { + "message": "Not Found", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to retrieve budget.", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to update budget.", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "budgets" + } + }, + "delete": { + "summary": "Delete a budget", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDeletes a budget by ID. The authenticated user must be an enterprise admin.", + "tags": [ + "billing" + ], + "operationId": "billing/delete-budget", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#delete-a-budget" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "budget_id", + "description": "The ID corresponding to the budget.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response when deleting a budget", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the result of the deletion operation" + }, + "id": { + "type": "string", + "description": "The ID of the deleted budget" + } + }, + "required": [ + "message", + "id" + ] + }, + "examples": { + "default": { + "value": { + "message": "Budget successfully deleted.", + "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" + } + } + } + } + } + }, "400": { "description": "Bad Request", "content": { @@ -151668,6 +151798,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -152684,6 +152822,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -189145,21 +189291,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -218162,6 +218326,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "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.", @@ -235193,17 +235380,17 @@ } } }, - "/orgs/{org}/teams/{team_slug}/projects": { + "/orgs/{org}/teams/{team_slug}/repos": { "get": { - "summary": "List team projects", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "List team repositories", + "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", "tags": [ "teams" ], - "operationId": "teams/list-projects-in-org", + "operationId": "teams/list-repos-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories" }, "parameters": [ { @@ -235251,42 +235438,28 @@ "schema": { "type": "array", "items": { - "title": "Team Project", - "description": "A team's access to a project.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, "id": { - "type": "integer" + "type": "integer", + "format": "int64", + "example": 1296269 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { - "type": "string" - }, - "body": { "type": "string", - "nullable": true - }, - "number": { - "type": "integer" + "example": "Hello-World" }, - "state": { - "type": "string" + "full_name": { + "type": "string", + "example": "octocat/Hello-World" }, - "creator": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -235410,55 +235583,550 @@ "url" ] }, - "created_at": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, - "updated_at": { + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { "type": "string" }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { "type": "string" }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { "type": "boolean" }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, "permissions": { "type": "object", "properties": { - "read": { + "admin": { "type": "boolean" }, - "write": { + "maintain": { "type": "boolean" }, - "admin": { + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { "type": "boolean" } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + } }, "required": [ - "read", - "write", - "admin" + "url", + "html_url", + "key", + "name" ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_validity_checks": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ - "owner_url", - "url", + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", - "columns_url", "id", "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] } }, @@ -235466,17 +236134,11 @@ "default": { "value": [ { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -235496,1397 +236158,97 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": "string", - "nullable": true - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - } - } - } - } - }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - }, - "nullable": true - }, - "examples": { - "default": { - "summary": "Updates the permissions for the team to write for the project", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/teams/{team_slug}/repos": { - "get": { - "summary": "List team repositories", - "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", - "tags": [ - "teams" - ], - "operationId": "teams/list-repos-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_validity_checks": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_validity_checks": { - "status": "disabled" - } + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_validity_checks": { + "status": "disabled" + } } } ] @@ -238650,327 +238012,463 @@ "deprecated": true } }, - "/projects/columns/cards/{card_id}": { + "/rate_limit": { "get": { - "summary": "Get a project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "Get rate limit status for the authenticated user", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ - "projects-classic" + "rate-limit" ], - "operationId": "projects-classic/get-card", + "operationId": "rate-limit/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], + "parameters": [], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Rate Limit Overview", + "description": "Rate Limit Overview", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" - }, - "id": { - "description": "The project card's ID", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" - }, - "note": { - "type": "string", - "example": "Add payload for delete Project column", - "nullable": true - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", + "resources": { "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "core": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "graphql": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "code_search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "source_import": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "integration_manifest": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "code_scanning_upload": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "actions_runner_registration": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "scim": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "dependency_snapshots": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "dependency_sbom": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "type": { - "type": "string", - "example": "User" + "code_scanning_autofix": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + } + }, + "required": [ + "core", + "search" + ] + }, + "rate": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" }, - "site_admin": { - "type": "boolean" + "remaining": { + "type": "integer" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "reset": { + "type": "integer" }, - "user_view_type": { - "type": "string", - "example": "public" + "used": { + "type": "integer" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:21:06Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:20:22Z" - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "content_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" + "limit", + "remaining", + "reset", + "used" + ] } }, "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" + "rate", + "resources" ] }, "examples": { "default": { "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "resources": { + "core": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691591363 + }, + "search": { + "limit": 30, + "used": 12, + "remaining": 18, + "reset": 1691591091 + }, + "graphql": { + "limit": 5000, + "used": 7, + "remaining": 4993, + "reset": 1691593228 + }, + "integration_manifest": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691594631 + }, + "source_import": { + "limit": 100, + "used": 1, + "remaining": 99, + "reset": 1691591091 + }, + "code_scanning_upload": { + "limit": 500, + "used": 1, + "remaining": 499, + "reset": 1691594631 + }, + "actions_runner_registration": { + "limit": 10000, + "used": 0, + "remaining": 10000, + "reset": 1691594631 + }, + "scim": { + "limit": 15000, + "used": 0, + "remaining": 15000, + "reset": 1691594631 + }, + "dependency_snapshots": { + "limit": 100, + "used": 0, + "remaining": 100, + "reset": 1691591091 + }, + "code_search": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + } }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" + "rate": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1372700873 + } } } } } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { + }, + "headers": { + "X-RateLimit-Limit": { + "example": 5000, "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } + "type": "integer" } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { + }, + "X-RateLimit-Remaining": { + "example": 4999, "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } + "type": "integer" + } + }, + "X-RateLimit-Reset": { + "example": 1590701888, + "schema": { + "type": "integer", + "format": "timestamp" } } } }, + "304": { + "description": "Not modified" + }, "404": { "description": "Resource not found", "content": { @@ -238999,99 +238497,73 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update an existing project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "category": "rate-limit", + "subcategory": "rate-limit" + } + } + }, + "/repos/{owner}/{repo}": { + "get": { + "summary": "Get a repository", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.", "tags": [ - "projects-classic" + "repos" ], - "operationId": "projects-classic/update-card", + "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository" }, "parameters": [ { - "name": "card_id", - "description": "The unique identifier of the card.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "note": { - "description": "The project card's note", - "example": "Update all gems", - "type": "string", - "nullable": true - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - } - } - }, - "examples": { - "default": { - "summary": "Change the note on the card", - "value": { - "note": "Add payload for delete Project column" - } - } - } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Full Repository", + "description": "Full Repository", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" - }, "id": { - "description": "The project card's ID", - "example": 42, "type": "integer", - "format": "int64" + "format": "int64", + "example": 1296269 }, "node_id": { "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "note": { + "name": { "type": "string", - "example": "Add payload for delete Project column", - "nullable": true + "example": "Hello-World" }, - "creator": { + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -239213,2994 +238685,1194 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ] }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:21:06Z" + "private": { + "type": "boolean" }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:20:22Z" + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_name": { - "type": "string" + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true }, - "project_id": { - "type": "string" + "fork": { + "type": "boolean" }, - "column_url": { + "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367" + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "content_url": { + "archive_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "project_url": { + "assignees_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - "documentation_url": { - "type": "string" + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/delete-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card" - }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - "documentation_url": { - "type": "string" + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, - "documentation_url": { - "type": "string" + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, - "url": { - "type": "string" + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "documentation_url": { - "type": "string" + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "url": { - "type": "string" + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/cards/{card_id}/moves": { - "post": { - "summary": "Move a project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/move-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card" - }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.", - "example": "bottom", - "type": "string", - "pattern": "^(?:top|bottom|after:\\d+)$" - }, - "column_id": { - "description": "The unique identifier of the column the card should be moved to", - "example": 42, - "type": "integer" - } - }, - "required": [ - "position" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Move the card to the bottom of the column", - "value": { - "column_id": 42, - "position": "bottom" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - "documentation_url": { - "type": "string" + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "resource": { - "type": "string" - }, - "field": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - "documentation_url": { - "type": "string" + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - "url": { - "type": "string" + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "503": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" }, - "message": { - "type": "string" + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - "documentation_url": { - "type": "string" + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, - "documentation_url": { - "type": "string" + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/{column_id}": { - "get": { - "summary": "Get a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { + "labels_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, - "project_url": { + "languages_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/120" + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, - "cards_url": { + "merges_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" - }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, - "node_id": { + "milestones_url": { "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" - }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, - "created_at": { + "notifications_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, - "updated_at": { + "pulls_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:22:28Z" - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, - "url": { - "type": "string" + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" }, - "documentation_url": { - "type": "string" + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, - "url": { - "type": "string" + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update an existing project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/update-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Rename the project column", - "value": { - "name": "To Do" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { + "subscribers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367" + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, - "project_url": { + "subscription_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/120" + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, - "cards_url": { + "tags_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" - }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" + "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, - "node_id": { + "teams_url": { "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, - "created_at": { + "clone_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" + "example": "https://github.com/octocat/Hello-World.git" }, - "updated_at": { + "mirror_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:22:28Z" - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true }, - "documentation_url": { - "type": "string" + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, - "url": { - "type": "string" + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true }, - "documentation_url": { - "type": "string" + "language": { + "type": "string", + "nullable": true }, - "url": { - "type": "string" + "forks_count": { + "type": "integer", + "example": 9 }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/delete-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#delete-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "stargazers_count": { + "type": "integer", + "example": 80 }, - "documentation_url": { - "type": "string" + "watchers_count": { + "type": "integer", + "example": 80 }, - "url": { - "type": "string" + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "default_branch": { + "type": "string", + "example": "master" }, - "documentation_url": { - "type": "string" + "open_issues_count": { + "type": "integer", + "example": 0 }, - "url": { - "type": "string" + "is_template": { + "type": "boolean", + "example": true }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/{column_id}/cards": { - "get": { - "summary": "List project cards", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/list-cards", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "archived_state", - "description": "Filters the project cards that are returned by the card's state.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "archived", - "not_archived" - ], - "default": "not_archived" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" - }, - "id": { - "description": "The project card's ID", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" - }, - "note": { - "type": "string", - "example": "Add payload for delete Project column", - "nullable": true - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:21:06Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:20:22Z" - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_name": { - "type": "string" - }, - "project_id": { + "topics": { + "type": "array", + "items": { "type": "string" }, - "column_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "content_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - } + "example": [ + "octocat", + "atom", + "electron", + "API" + ] }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "has_issues": { + "type": "boolean", + "example": true }, - "documentation_url": { - "type": "string" + "has_projects": { + "type": "boolean", + "example": true }, - "url": { - "type": "string" + "has_wiki": { + "type": "boolean", + "example": true }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "has_pages": { + "type": "boolean" }, - "documentation_url": { - "type": "string" + "has_downloads": { + "type": "boolean", + "example": true }, - "url": { - "type": "string" + "has_discussions": { + "type": "boolean", + "example": true }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "post": { - "summary": "Create a project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/create-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "note": { - "description": "The project card's note", - "example": "Update all gems", - "type": "string", - "nullable": true - } + "archived": { + "type": "boolean" }, - "required": [ - "note" - ] - }, - { - "type": "object", - "properties": { - "content_id": { - "description": "The unique identifier of the content associated with the card", - "example": 42, - "type": "integer" - }, - "content_type": { - "description": "The piece of content associated with the card", - "example": "PullRequest", - "type": "string" - } + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." }, - "required": [ - "content_id", - "content_type" - ] - } - ] - }, - "examples": { - "default": { - "summary": "Create a new card", - "value": { - "note": "Add payload for delete Project column" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { + "visibility": { + "description": "The repository visibility: public, private, or internal.", "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" + "example": "public" }, - "id": { - "description": "The project card's ID", - "example": 42, - "type": "integer", - "format": "int64" + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z" }, - "node_id": { + "created_at": { "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" + "format": "date-time", + "example": "2011-01-26T19:01:12Z" }, - "note": { + "updated_at": { "type": "string", - "example": "Add payload for delete Project column", - "nullable": true + "format": "date-time", + "example": "2011-01-26T19:14:43Z" }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", + "permissions": { "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" + "admin": { + "type": "boolean" }, - "email": { - "nullable": true, - "type": "string" + "maintain": { + "type": "boolean" }, - "login": { - "type": "string", - "example": "octocat" + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" }, + "pull": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "allow_rebase_merge": { + "type": "boolean", + "example": true + }, + "template_repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer", - "format": "int64", - "example": 1 + "format": "int64" }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "avatar_url": { + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "example": "https://github.com/octocat/Hello-World" }, - "gravatar_id": { + "description": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", + "example": "This your first repo!", "nullable": true }, + "fork": { + "type": "boolean" + }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "html_url": { + "archive_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "followers_url": { + "assignees_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, - "following_url": { + "blobs_url": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - "gists_url": { + "branches_url": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - "starred_url": { + "collaborators_url": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - "subscriptions_url": { + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "organizations_url": { + "deployments_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "repos_url": { + "downloads_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - "received_events_url": { + "forks_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - "type": { + "git_commits_url": { "type": "string", - "example": "User" + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - "site_admin": { - "type": "boolean" + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - "starred_at": { + "git_tags_url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, - "user_view_type": { + "git_url": { "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:21:06Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:20:22Z" - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "content_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "example": "git:github.com/octocat/Hello-World.git" }, - "documentation_url": { - "type": "string" + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - }, - { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, - "documentation_url": { - "type": "string" + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ] - } - } - } - }, - "503": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { "type": "string" } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/{column_id}/moves": { - "post": { - "summary": "Move a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/move-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#move-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "example": "last", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$" - } - }, - "required": [ - "position" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Move the column to the end of the board", - "value": { - "position": "last" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators": { - "get": { - "summary": "List project collaborators", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/list-collaborators", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#list-project-collaborators" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "affiliation", - "description": "Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "outside", - "direct", - "all" - ], - "default": "all" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } } } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}": { - "put": { - "summary": "Add project collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/add-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#add-project-collaborator" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "example": "write", - "type": "string" - } - }, - "nullable": true - }, - "examples": { - "default": { - "summary": "Applying write permissions for the new collaborator", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "nullable": true }, - "documentation_url": { - "type": "string" + "temp_clone_token": { + "type": "string", + "nullable": true }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "allow_squash_merge": { + "type": "boolean", + "example": true }, - "documentation_url": { - "type": "string" + "allow_auto_merge": { + "type": "boolean", + "example": false }, - "url": { - "type": "string" + "delete_branch_on_merge": { + "type": "boolean", + "example": false }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "allow_merge_commit": { + "type": "boolean", + "example": true }, - "documentation_url": { - "type": "string" + "allow_update_branch": { + "type": "boolean", + "example": true }, - "url": { - "type": "string" + "use_squash_pr_title_as_default": { + "type": "boolean", + "example": false }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove user as a collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/remove-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#remove-user-as-a-collaborator" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "squash_merge_commit_title": { + "type": "string", + "example": "PR_TITLE", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, - "documentation_url": { - "type": "string" + "squash_merge_commit_message": { + "type": "string", + "example": "PR_BODY", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, - "url": { - "type": "string" + "merge_commit_title": { + "type": "string", + "example": "PR_TITLE", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "merge_commit_message": { + "type": "string", + "example": "PR_BODY", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, - "documentation_url": { - "type": "string" + "allow_forking": { + "type": "boolean", + "example": true }, - "url": { - "type": "string" + "web_commit_signoff_required": { + "type": "boolean", + "example": false }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "subscribers_count": { + "type": "integer", + "example": 42 }, - "documentation_url": { - "type": "string" + "network_count": { + "type": "integer", + "example": 0 }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" } - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}/permission": { - "get": { - "summary": "Get project permission for a user", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-permission-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#get-project-permission-for-a-user" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", - "type": "object", - "properties": { - "permission": { - "type": "string" + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true }, - "user": { + "organization": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -242324,2406 +239996,223 @@ "url" ], "nullable": true - } - }, - "required": [ - "permission", - "user" - ] - }, - "examples": { - "default": { - "value": { - "permission": "admin", - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/rate_limit": { - "get": { - "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", - "tags": [ - "rate-limit" - ], - "operationId": "rate-limit/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" - }, - "parameters": [], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Rate Limit Overview", - "description": "Rate Limit Overview", - "type": "object", - "properties": { - "resources": { + "parent": { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { - "core": { - "title": "Rate Limit", + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" + "key": { + "type": "string", + "example": "mit" }, - "reset": { - "type": "integer" + "name": { + "type": "string", + "example": "MIT License" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "graphql": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" }, - "remaining": { - "type": "integer" + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" }, - "reset": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" }, - "used": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "limit", - "remaining", - "reset", - "used" - ] + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true }, - "search": { - "title": "Rate Limit", + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", "properties": { - "limit": { - "type": "integer" + "admin": { + "type": "boolean" }, - "remaining": { - "type": "integer" + "pull": { + "type": "boolean" }, - "reset": { - "type": "integer" + "triage": { + "type": "boolean" }, - "used": { - "type": "integer" + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" } }, "required": [ - "limit", - "remaining", - "reset", - "used" + "admin", + "pull", + "push" ] }, - "code_search": { - "title": "Rate Limit", + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "limit": { - "type": "integer" + "name": { + "nullable": true, + "type": "string" }, - "remaining": { - "type": "integer" + "email": { + "nullable": true, + "type": "string" }, - "reset": { - "type": "integer" + "login": { + "type": "string", + "example": "octocat" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "source_import": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "remaining": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "reset": { - "type": "integer" + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "integration_manifest": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "remaining": { - "type": "integer" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "reset": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_upload": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "remaining": { - "type": "integer" + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "reset": { - "type": "integer" + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "actions_runner_registration": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "remaining": { - "type": "integer" + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "reset": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "scim": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" }, - "remaining": { - "type": "integer" + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "reset": { - "type": "integer" + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_snapshots": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "type": { + "type": "string", + "example": "User" }, - "remaining": { - "type": "integer" + "site_admin": { + "type": "boolean" }, - "reset": { - "type": "integer" + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" }, - "used": { - "type": "integer" + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_sbom": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_autofix": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - } - }, - "required": [ - "core", - "search" - ] - }, - "rate": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - } - }, - "required": [ - "rate", - "resources" - ] - }, - "examples": { - "default": { - "value": { - "resources": { - "core": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691591363 - }, - "search": { - "limit": 30, - "used": 12, - "remaining": 18, - "reset": 1691591091 - }, - "graphql": { - "limit": 5000, - "used": 7, - "remaining": 4993, - "reset": 1691593228 - }, - "integration_manifest": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691594631 - }, - "source_import": { - "limit": 100, - "used": 1, - "remaining": 99, - "reset": 1691591091 - }, - "code_scanning_upload": { - "limit": 500, - "used": 1, - "remaining": 499, - "reset": 1691594631 - }, - "actions_runner_registration": { - "limit": 10000, - "used": 0, - "remaining": 10000, - "reset": 1691594631 - }, - "scim": { - "limit": 15000, - "used": 0, - "remaining": 15000, - "reset": 1691594631 - }, - "dependency_snapshots": { - "limit": 100, - "used": 0, - "remaining": 100, - "reset": 1691591091 - }, - "code_search": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - }, - "code_scanning_autofix": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - } - }, - "rate": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1372700873 - } - } - } - } - } - }, - "headers": { - "X-RateLimit-Limit": { - "example": 5000, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Remaining": { - "example": 4999, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Reset": { - "example": 1590701888, - "schema": { - "type": "integer", - "format": "timestamp" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "rate-limit", - "subcategory": "rate-limit" - } - } - }, - "/repos/{owner}/{repo}": { - "get": { - "summary": "Get a repository", - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.", - "tags": [ - "repos" - ], - "operationId": "repos/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Full Repository", - "description": "Full Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "octocat", - "atom", - "electron", - "API" - ] - }, - "has_issues": { - "type": "boolean", - "example": true - }, - "has_projects": { - "type": "boolean", - "example": true - }, - "has_wiki": { - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean", - "example": true - }, - "has_discussions": { - "type": "boolean", - "example": true - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string", - "example": "public" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { - "type": "boolean", - "example": true - }, - "template_repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "example": false - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ], - "nullable": true - }, - "temp_clone_token": { - "type": "string", - "nullable": true - }, - "allow_squash_merge": { - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "type": "boolean", - "example": false - }, - "allow_merge_commit": { - "type": "boolean", - "example": true - }, - "allow_update_branch": { - "type": "boolean", - "example": true - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "example": false - }, - "squash_merge_commit_title": { - "type": "string", - "example": "PR_TITLE", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "example": "PR_BODY", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "example": "PR_TITLE", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "example": "PR_BODY", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_forking": { - "type": "boolean", - "example": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "subscribers_count": { - "type": "integer", - "example": 42 - }, - "network_count": { - "type": "integer", - "example": 0 - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "organization": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "parent": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, "private": { @@ -277562,6 +273051,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -277582,6 +273072,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -295780,6 +291271,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -295800,6 +291292,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -333647,6 +329140,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -333667,6 +329161,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -339401,6 +334896,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -339421,6 +334917,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -344754,6 +340251,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -344774,6 +340272,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345300,6 +340799,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345320,6 +340820,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345870,6 +341371,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345890,6 +341392,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -381848,6 +377351,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -464232,6 +459743,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -464252,6 +459764,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -495105,6 +490618,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -495125,6 +490639,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -526189,6 +521704,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "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.", @@ -528429,7 +523967,7 @@ }, "patch": { "summary": "Update a secret scanning alert", - "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "operationId": "secret-scanning/update-alert", "tags": [ "secret-scanning" @@ -528499,6 +524037,11 @@ "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", "type": "string", "nullable": true + }, + "assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true } }, "anyOf": [ @@ -528506,6 +524049,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -528515,6 +524063,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -529491,7 +525051,27 @@ "resolution_comment": "Example comment", "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://alambic.github.com/avatars/u/1?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } } } @@ -529505,7 +525085,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment" + "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" }, "503": { "description": "Service unavailable", @@ -566791,6 +562371,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -567003,6 +562584,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -579973,17 +575555,17 @@ "deprecated": true } }, - "/teams/{team_id}/projects": { + "/teams/{team_id}/repos": { "get": { - "summary": "List team projects (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "List team repositories (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories) endpoint.", "tags": [ "teams" ], - "operationId": "teams/list-projects-legacy", + "operationId": "teams/list-repos-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy" }, "parameters": [ { @@ -580022,42 +575604,28 @@ "schema": { "type": "array", "items": { - "title": "Team Project", - "description": "A team's access to a project.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, "id": { - "type": "integer" + "type": "integer", + "format": "int64", + "example": 1296269 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { - "type": "string" - }, - "body": { "type": "string", - "nullable": true - }, - "number": { - "type": "integer" + "example": "Hello-World" }, - "state": { - "type": "string" + "full_name": { + "type": "string", + "example": "octocat/Hello-World" }, - "creator": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -580181,55 +575749,550 @@ "url" ] }, - "created_at": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, - "updated_at": { + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { "type": "string" }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { "type": "string" }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { "type": "boolean" }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, "permissions": { "type": "object", "properties": { - "read": { + "admin": { "type": "boolean" }, - "write": { + "maintain": { "type": "boolean" }, - "admin": { + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { "type": "boolean" } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + } }, "required": [ - "read", - "write", - "admin" + "url", + "html_url", + "key", + "name" ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_validity_checks": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ - "owner_url", - "url", + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", - "columns_url", "id", "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] } }, @@ -580237,17 +576300,11 @@ "default": { "value": [ { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -580267,1576 +576324,97 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, - "/teams/{team_id}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-project-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": "string", - "nullable": true - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - } - } - } - } - }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - } - }, - "examples": { - "default": { - "summary": "Example of setting permission to read", - "value": { - "permission": "read" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, - "/teams/{team_id}/repos": { - "get": { - "summary": "List team repositories (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories) endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/list-repos-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_validity_checks": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_validity_checks": { - "status": "disabled" - } + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_validity_checks": { + "status": "disabled" + } } } ] @@ -608846,6 +603424,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -657687,6 +652273,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -664124,6 +658718,675 @@ "category": "projects", "subcategory": "fields" } + }, + "post": { + "summary": "Add field to user owned project", + "description": "Add a field to a specified user owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/add-field-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-field-to-user-owned-project" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_number", + "description": "The project's number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date", + "single_select", + "iteration" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "description": "The color associated with the option.", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + "description": { + "type": "string", + "description": "The description of the option." + } + } + } + }, + "iteration_configuration": { + "type": "object", + "description": "The configuration for iteration fields.", + "properties": { + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the first iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "description": "Zero or more iterations for the field.", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title for the iteration." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + } + } + } + } + } + } + }, + "required": [ + "name", + "data_type" + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "summary": "Create a single select field", + "value": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + } + }, + "iteration_field": { + "summary": "Create an iteration field", + "value": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "example": "https://api.github.com/projects/1" + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was last updated." + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + }, + "examples": { + "text_field": { + "value": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + } + }, + "number_field": { + "value": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + } + }, + "date_field": { + "value": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + } + }, + "single_select_field": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + }, + "iteration_field": { + "value": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" + } } }, "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { @@ -664369,21 +659632,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -724616,6 +719897,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -726997,6 +722285,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -858270,6 +853565,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -860878,6 +856181,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -863393,6 +858704,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -865908,6 +861227,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -868555,6 +863882,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -871209,6 +866544,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -875486,6 +870829,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1270976,949 +1266327,4357 @@ ] } }, - "updated": { + "updated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "rule": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "automatic_copilot_code_review_enabled": { + "type": "boolean", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + } + ] + }, + "changes": { + "type": "object", + "properties": { + "configuration": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "rule_type": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "pattern": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-transferred": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", + "operationId": "repository/transferred", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "repository transferred event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "transferred" + ] + }, + "changes": { + "type": "object", + "properties": { + "owner": { + "type": "object", + "properties": { + "from": { + "type": "object", + "properties": { + "organization": { + "title": "Organization", + "type": "object", + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issues_url": { + "type": "string", + "format": "uri" + }, + "login": { + "type": "string" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "node_id": { + "type": "string" + }, + "public_members_url": { + "type": "string", + "format": "uri-template" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id", + "node_id", + "url", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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": [ + "from" + ] + } + }, + "required": [ + "owner" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "changes", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-unarchived": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "repository unarchived event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unarchived" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { "type": "array", "items": { - "type": "object", - "properties": { - "rule": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "merge_queue" - ] - }, - "parameters": { - "type": "object", - "properties": { - "check_response_timeout_minutes": { - "type": "integer", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", - "minimum": 1, - "maximum": 360 - }, - "grouping_strategy": { - "type": "string", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - "max_entries_to_build": { - "type": "integer", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", - "minimum": 0, - "maximum": 100 - }, - "max_entries_to_merge": { - "type": "integer", - "description": "The maximum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "merge_method": { - "type": "string", - "description": "Method to use when merging changes from queued pull requests.", - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - "min_entries_to_merge": { - "type": "integer", - "description": "The minimum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "min_entries_to_merge_wait_minutes": { - "type": "integer", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", - "minimum": 0, - "maximum": 360 - } - }, - "required": [ - "check_response_timeout_minutes", - "grouping_strategy", - "max_entries_to_build", - "max_entries_to_merge", - "merge_method", - "min_entries_to_merge", - "min_entries_to_merge_wait_minutes" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "automatic_copilot_code_review_enabled": { - "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - }, - "required_reviewers": { - "type": "array", - "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", - "items": { - "title": "RequiredReviewerConfiguration", - "description": "A reviewing team, and file patterns describing which files they must approve changes to.", - "type": "object", - "properties": { - "file_patterns": { - "type": "array", - "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", - "items": { - "type": "string" - } - }, - "minimum_approvals": { - "type": "integer", - "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." - }, - "reviewer": { - "title": "Reviewer", - "description": "A required reviewing team", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "ID of the reviewer which must review changes to matching files." - }, - "type": { - "type": "string", - "description": "The type of the reviewer", - "enum": [ - "Team" - ] - } - }, - "required": [ - "id", - "type" - ] - } - }, - "required": [ - "file_patterns", - "minimum_approvals", - "reviewer" - ] - } - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } - } - ] - }, - "changes": { - "type": "object", - "properties": { - "configuration": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "rule_type": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "pattern": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - } - } - } + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" } } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" } } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } - } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] }, "sender": { "title": "Simple User", @@ -1272047,7 +1270806,7 @@ }, "required": [ "action", - "repository_ruleset", + "repository", "sender" ] } @@ -1272062,8 +1270821,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -1272071,13 +1270831,13 @@ } } }, - "repository-transferred": { + "repository-vulnerability-alert-create": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", - "operationId": "repository/transferred", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1272142,200 +1270902,180 @@ "content": { "application/json": { "schema": { - "title": "repository transferred event", + "title": "repository_vulnerability_alert create event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "transferred" + "create" ] }, - "changes": { + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], "properties": { - "owner": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "issues_url": { - "type": "string", - "format": "uri" - }, - "login": { - "type": "string" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "node_id": { - "type": "string" - }, - "public_members_url": { - "type": "string", - "format": "uri-template" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id", - "node_id", - "url", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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" - ] - } - } + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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" } - }, - "required": [ - "from" + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open" ] } - }, - "required": [ - "owner" - ] + } }, "enterprise": { "title": "Enterprise", @@ -1273843,7 +1272583,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1273859,23 +1272599,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-unarchived": { + "repository-vulnerability-alert-dismiss": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1273940,15 +1272678,191 @@ "content": { "application/json": { "schema": { - "title": "repository unarchived event", + "title": "repository_vulnerability_alert dismiss event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unarchived" + "dismiss" ] }, + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", + "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "dismiss_reason", + "dismissed_at", + "dismisser", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], + "properties": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_comment": { + "type": "string", + "nullable": true + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "dismissed" + ] + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", @@ -1275455,6 +1274369,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1275470,21 +1274385,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-vulnerability-alert-create": { + "repository-vulnerability-alert-reopen": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was created.", - "operationId": "repository-vulnerability-alert/create", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1275551,13 +1274464,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert create event", + "title": "repository_vulnerability_alert reopen event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "create" + "reopen" ] }, "alert": { @@ -1277256,11 +1276169,11 @@ } } }, - "repository-vulnerability-alert-dismiss": { + "repository-vulnerability-alert-resolve": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was dismissed.", - "operationId": "repository-vulnerability-alert/dismiss", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1277327,13 +1276240,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert dismiss event", + "title": "repository_vulnerability_alert resolve event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "dismiss" + "resolve" ] }, "alert": { @@ -1277344,9 +1276257,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1277366,10 +1276276,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": "string", - "nullable": true - }, "dismiss_reason": { "type": "string" }, @@ -1277465,9 +1276371,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1277507,7 +1276410,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1279014,279 +1277918,855 @@ "type", "url" ] - } - }, - "required": [ - "action", - "alert", - "repository", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "repository_vulnerability_alert", - "supported-webhook-types": [ - "repository", - "organization" - ] - } - } - }, - "repository-vulnerability-alert-reopen": { - "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "repository_vulnerability_alert reopen event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "reopen" - ] - }, - "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", - "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], - "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "dismiss_reason": { - "type": "string" - }, - "dismissed_at": { - "type": "string" - }, - "dismisser": { - "title": "User", - "type": "object", - "nullable": true, - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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" - } - } - }, - "external_identifier": { - "type": "string" - }, - "external_reference": { - "type": "string", - "nullable": true, - "format": "uri" - }, - "fix_reason": { - "type": "string" - }, - "fixed_at": { - "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "severity": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "open" - ] - } - } + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_vulnerability_alert", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "secret-scanning-alert-assigned": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "secret_scanning_alert assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { + "type": "string", + "description": "The reason for resolving the alert.", + "nullable": true, + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true + }, + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, "enterprise": { "title": "Enterprise", @@ -1280795,8 +1280275,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1280810,21 +1280289,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-resolve": { + "secret-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was marked as resolved.", - "operationId": "repository-vulnerability-alert/resolve", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was created.", + "operationId": "secret-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1280889,179 +1280369,630 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert resolve event", + "title": "secret_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolve" + "created" ] }, "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, "created_at": { - "type": "string" + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "dismiss_reason": { - "type": "string" + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", - "type": "object", + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { + "type": "string", + "description": "The reason for resolving the alert.", "nullable": true, - "required": [ - "login", - "id" - ], + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "format": "uri" + "example": "octocat" }, - "deleted": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "email": { + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "events_url": { + "url": { "type": "string", - "format": "uri-template" + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "gravatar_id": { - "type": "string" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "html_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "id": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "login": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { "name": { + "nullable": true, "type": "string" }, - "node_id": { + "email": { + "nullable": true, "type": "string" }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "repos_url": { + "type": { "type": "string", - "format": "uri" + "example": "User" }, "site_admin": { "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, "starred_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "example": "User" }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } - } - }, - "external_identifier": { - "type": "string" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "external_reference": { + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "nullable": true, - "format": "uri" - }, - "fix_reason": { - "type": "string" + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true }, - "fixed_at": { + "push_protection_bypass_request_comment": { "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true }, - "node_id": { - "type": "string" + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true }, - "number": { - "type": "integer" + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true }, - "severity": { - "type": "string" + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" - ] + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true } } }, @@ -1282572,8 +1282503,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1282587,21 +1282517,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "secret-scanning-alert-created": { + "secret-scanning-alert-location-created": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was created.", - "operationId": "secret-scanning-alert/created", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", + "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -1282666,7 +1282597,7 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { @@ -1283293,74 +1283224,6 @@ } } }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1283382,6 +1283245,314 @@ "node_id" ] }, + "location": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "commit", + "wiki_commit", + "issue_title", + "issue_body", + "issue_comment", + "discussion_title", + "discussion_body", + "discussion_comment", + "pull_request_title", + "pull_request_body", + "pull_request_comment", + "pull_request_review", + "pull_request_review_comment" + ], + "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", + "example": "commit" + }, + "details": { + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/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", + "example": "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", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/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", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ] + } + } + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", @@ -1284798,10 +1284969,185 @@ } }, "required": [ - "action", + "location", "alert", - "repository" + "repository", + "sender" + ] + }, + "examples": { + "default": { + "value": { + "action": "created", + "alert": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "updated_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", + "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", + "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "publicly_leaked": false, + "multi_repo": false + }, + "location": { + "type": "commit", + "details": { + "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-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + } + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "hello-world", + "full_name": "octocat-repo/hello-world", + "private": false, + "owner": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/octocat-repo/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octocat-repo/hello-world", + "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", + "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", + "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", + "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", + "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", + "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", + "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", + "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", + "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", + "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", + "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", + "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", + "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", + "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", + "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", + "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", + "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", + "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", + "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:21:03Z", + "pushed_at": "2019-05-15T15:20:57Z", + "git_url": "git://github.com/octocat-repo/hello-world.git", + "ssh_url": "git@github.com:octocat-repo/hello-world.git", + "clone_url": "https://github.com/octocat-repo/hello-world.git", + "svn_url": "https://github.com/octocat-repo/hello-world", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false + }, + "sender": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Secret Scanning Alert Location Created Event", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" ] + }, + "examples": { + "default": { + "value": { + "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" + } + } } } } @@ -1284813,8 +1285159,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1284823,13 +1285170,13 @@ } } }, - "secret-scanning-alert-location-created": { + "secret-scanning-alert-publicly-leaked": { "post": { - "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", - "operationId": "secret-scanning-alert-location/created", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1284894,13 +1285241,13 @@ "content": { "application/json": { "schema": { - "title": "Secret Scanning Alert Location Created Event", + "title": "secret_scanning_alert publicly leaked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "publicly_leaked" ] }, "alert": { @@ -1285521,6 +1285868,74 @@ } } }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1285542,314 +1285957,6 @@ "node_id" ] }, - "location": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "commit", - "wiki_commit", - "issue_title", - "issue_body", - "issue_comment", - "discussion_title", - "discussion_body", - "discussion_comment", - "pull_request_title", - "pull_request_body", - "pull_request_comment", - "pull_request_review", - "pull_request_review_comment" - ], - "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", - "example": "commit" - }, - "details": { - "oneOf": [ - { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "example": "/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", - "example": "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", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "example": "/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", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_title_url" - ] - }, - { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_body_url" - ] - }, - { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "issue_comment_url" - ] - }, - { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082" - } - }, - "required": [ - "discussion_title_url" - ] - }, - { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussion-4566270" - } - }, - "required": [ - "discussion_body_url" - ] - }, - { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - } - }, - "required": [ - "discussion_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_title_url" - ] - }, - { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_body_url" - ] - }, - { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - } - }, - "required": [ - "pull_request_review_url" - ] - }, - { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } - ] - } - } - }, "organization": { "title": "Organization Simple", "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", @@ -1287266,185 +1287373,10 @@ } }, "required": [ - "location", + "action", "alert", - "repository", - "sender" - ] - }, - "examples": { - "default": { - "value": { - "action": "created", - "alert": { - "number": 42, - "created_at": "2020-11-06T18:18:30Z", - "updated_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", - "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", - "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", - "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, - "secret_type": "mailchimp_api_key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "publicly_leaked": false, - "multi_repo": false - }, - "location": { - "type": "commit", - "details": { - "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-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - } - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "hello-world", - "full_name": "octocat-repo/hello-world", - "private": false, - "owner": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/octocat-repo/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octocat-repo/hello-world", - "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", - "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", - "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", - "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", - "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", - "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", - "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", - "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", - "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", - "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", - "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", - "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", - "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", - "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", - "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", - "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", - "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", - "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", - "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:03Z", - "pushed_at": "2019-05-15T15:20:57Z", - "git_url": "git://github.com/octocat-repo/hello-world.git", - "ssh_url": "git@github.com:octocat-repo/hello-world.git", - "clone_url": "https://github.com/octocat-repo/hello-world.git", - "svn_url": "https://github.com/octocat-repo/hello-world", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false - }, - "sender": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "title": "Secret Scanning Alert Location Created Event", - "type": "object", - "properties": { - "payload": { - "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", - "type": "string" - } - }, - "required": [ - "payload" + "repository" ] - }, - "examples": { - "default": { - "value": { - "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" - } - } } } } @@ -1287456,9 +1287388,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1287467,11 +1287398,11 @@ } } }, - "secret-scanning-alert-publicly-leaked": { + "secret-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was detected in a public repo.", - "operationId": "secret-scanning-alert/publicly-leaked", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1287538,13 +1287469,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert publicly leaked event", + "title": "secret_scanning_alert reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "publicly_leaked" + "reopened" ] }, "alert": { @@ -1289695,11 +1289626,11 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-resolved": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1289766,13 +1289697,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert reopened event", + "title": "secret_scanning_alert resolved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "resolved" ] }, "alert": { @@ -1291923,11 +1291854,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-unassigned": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1291994,13 +1291925,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert resolved event", + "title": "secret_scanning_alert unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolved" + "unassigned" ] }, "alert": { @@ -1292621,6 +1292552,130 @@ } } }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index e891ea64d..24ac26fc0 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -57,8 +57,6 @@ tags: description: Interact with organizations. - name: packages description: Manage packages for authenticated users and organizations. -- name: projects-classic - description: Interact with GitHub Projects (classic). - name: pulls description: Interact with GitHub Pull Requests. - name: rate-limit @@ -865,7 +863,7 @@ paths: - subscriptions_url - type - url - type: &428 + type: &429 type: string description: The type of credit the user is receiving. enum: @@ -1031,7 +1029,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &750 + - &743 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1715,7 +1713,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &760 + schema: &753 title: Scim Error description: Scim Error type: object @@ -2217,6 +2215,13 @@ paths: enum: - read - write + artifact_metadata: + type: string + description: The level of permission to grant the access + token to create and retrieve build artifact metadata records. + enum: + - read + - write attestations: type: string description: The level of permission to create and retrieve @@ -8740,7 +8745,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &761 + '401': &754 description: Authorization failure '404': *6 x-github: @@ -12943,7 +12948,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &535 + instances_url: &528 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -12978,7 +12983,7 @@ paths: format: date-time readOnly: true nullable: true - dismissed_reason: &536 + dismissed_reason: &529 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -12987,13 +12992,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &537 + dismissed_comment: &530 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &538 + rule: &531 type: object properties: id: @@ -13046,7 +13051,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &539 + tool: &532 type: object properties: name: *107 @@ -13056,15 +13061,15 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *108 - most_recent_instance: &540 + most_recent_instance: &533 type: object properties: - ref: &533 + ref: &526 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &550 + analysis_key: &543 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -13075,7 +13080,7 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &551 + category: &544 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -16764,7 +16769,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &590 + - &583 name: has in: query description: |- @@ -16877,7 +16882,7 @@ paths: - unknown - direct - transitive - security_advisory: &591 + security_advisory: &584 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -17109,7 +17114,7 @@ paths: nullable: true maxLength: 280 fixed_at: *133 - auto_dismissed_at: &592 + auto_dismissed_at: &585 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -18247,7 +18252,7 @@ paths: - name - created_on examples: - default: &433 + default: &434 value: total_count: 2 network_configurations: @@ -18470,7 +18475,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - *41 - - &434 + - &435 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -18482,7 +18487,7 @@ paths: description: Response content: application/json: - schema: &435 + schema: &436 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -18516,7 +18521,7 @@ paths: - subnet_id - region examples: - default: &436 + default: &437 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -20522,7 +20527,7 @@ paths: - *160 rules: type: array - items: &716 + items: &709 title: Repository Rule type: object description: A repository rule. @@ -20531,7 +20536,7 @@ paths: - *166 - *167 - *168 - - &713 + - &706 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -20625,7 +20630,7 @@ paths: - *182 - *183 - *184 - - &714 + - &707 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. @@ -21020,6 +21025,25 @@ paths: schema: type: string - &419 + name: assignee + in: query + description: Filters alerts by assignee. Use `*` to get all assigned alerts, + `none` to get all unassigned alerts, or a GitHub username to get alerts + assigned to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: "*" + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts + - &420 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. @@ -21035,7 +21059,7 @@ paths: - *17 - *104 - *105 - - &420 + - &421 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -21044,7 +21068,7 @@ paths: required: false schema: type: string - - &421 + - &422 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -21053,7 +21077,7 @@ paths: schema: type: boolean default: false - - &422 + - &423 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -21062,7 +21086,7 @@ paths: schema: type: boolean default: false - - &423 + - &424 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -21078,7 +21102,7 @@ paths: application/json: schema: type: array - items: &424 + items: &425 type: object properties: number: *123 @@ -21097,14 +21121,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &728 + state: &721 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &729 + resolution: &722 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -21211,8 +21235,8 @@ paths: pull request. ' - oneOf: &730 - - &732 + oneOf: &723 + - &725 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -21264,7 +21288,7 @@ paths: - blob_url - commit_sha - commit_url - - &733 + - &726 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. @@ -21319,7 +21343,7 @@ paths: - page_url - commit_sha - commit_url - - &734 + - &727 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -21333,7 +21357,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &735 + - &728 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -21347,7 +21371,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &736 + - &729 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -21361,7 +21385,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &737 + - &730 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -21375,7 +21399,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &738 + - &731 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -21389,7 +21413,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &739 + - &732 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -21403,7 +21427,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &740 + - &733 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. @@ -21417,7 +21441,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &741 + - &734 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. @@ -21431,7 +21455,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &742 + - &735 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. @@ -21445,7 +21469,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &743 + - &736 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. @@ -21459,7 +21483,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &744 + - &737 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. @@ -21486,7 +21510,7 @@ paths: required: *21 nullable: true examples: - default: &425 + default: &426 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -21695,7 +21719,7 @@ paths: description: Response content: application/json: - schema: &426 + schema: &427 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. @@ -21778,7 +21802,7 @@ paths: description: Overrides for custom patterns defined by the organization. items: *191 examples: - default: &427 + default: &428 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -21914,7 +21938,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *41 - - &430 + - &431 name: advanced_security_product in: query description: | @@ -21934,7 +21958,7 @@ paths: description: Success content: application/json: - schema: &431 + schema: &432 type: object properties: total_advanced_security_committers: @@ -21989,7 +22013,7 @@ paths: required: - repositories examples: - default: &432 + default: &433 value: total_advanced_security_committers: 2 total_count: 2 @@ -22615,7 +22639,19 @@ paths: update-budget: value: message: Budget successfully updated. - budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa '400': *14 '401': *25 '403': *29 @@ -24702,7 +24738,7 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &650 + properties: &643 id: type: integer format: int64 @@ -25074,7 +25110,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &788 + sub_issues_summary: &781 title: Sub-issues Summary type: object properties: @@ -25094,7 +25130,7 @@ paths: type: string format: uri nullable: true - issue_dependencies_summary: &789 + issue_dependencies_summary: &782 title: Issue Dependencies Summary type: object properties: @@ -25113,7 +25149,7 @@ paths: - total_blocking issue_field_values: type: array - items: &790 + items: &783 title: Issue Field Value description: A value assigned to an issue field type: object @@ -25173,7 +25209,7 @@ paths: - node_id - data_type - value - required: &651 + required: &644 - assignee - closed_at - comments @@ -25194,7 +25230,7 @@ paths: - user - created_at - updated_at - comment: &648 + comment: &641 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -25752,7 +25788,7 @@ paths: url: type: string format: uri - user: &802 + user: &793 title: Public User description: Public User type: object @@ -29057,14 +29093,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &456 + - &455 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &457 + - &456 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -29126,7 +29162,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &468 + '301': &461 description: Moved permanently content: application/json: @@ -29148,7 +29184,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &680 + - &673 name: all description: If `true`, show notifications marked as read. in: query @@ -29156,7 +29192,7 @@ paths: schema: type: boolean default: false - - &681 + - &674 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -29166,7 +29202,7 @@ paths: type: boolean default: false - *217 - - &682 + - &675 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -29648,7 +29684,7 @@ paths: - url - subscription_url examples: - default: &683 + default: &676 value: - id: '1' repository: @@ -30619,7 +30655,7 @@ paths: type: array items: *151 examples: - default: &689 + default: &682 value: - property_name: environment value: production @@ -30669,7 +30705,7 @@ paths: required: - properties examples: - default: &690 + default: &683 value: properties: - property_name: environment @@ -31482,7 +31518,7 @@ paths: type: integer repository_cache_usages: type: array - items: &473 + items: &466 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -33596,7 +33632,7 @@ paths: type: array items: *274 examples: - default: &805 + default: &796 value: total_count: 1 repositories: @@ -34638,7 +34674,7 @@ paths: description: Response content: application/json: - schema: &493 + schema: &486 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -34667,7 +34703,7 @@ paths: - key_id - key examples: - default: &494 + default: &487 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -35080,7 +35116,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - *83 - - &478 + - &471 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -36262,12 +36298,12 @@ paths: required: - subject_digests examples: - default: &833 + default: &824 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &834 + withPredicateType: &825 value: subject_digests: - sha256:abc123 @@ -36325,7 +36361,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &835 + default: &826 value: attestations_subject_digests: - sha256:abc: @@ -36674,7 +36710,7 @@ paths: initiator: type: string examples: - default: &507 + default: &500 value: attestations: - bundle: @@ -37591,7 +37627,7 @@ paths: be returned. in: query required: false - schema: &534 + schema: &527 type: string description: Severity of a code scanning alert. enum: @@ -38637,7 +38673,7 @@ paths: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &563 + properties: &556 name: type: string description: The name of the machine. @@ -38679,7 +38715,7 @@ paths: - ready - in_progress nullable: true - required: &564 + required: &557 - name - display_name - operating_system @@ -39547,7 +39583,7 @@ paths: - updated_at - visibility examples: - default: &565 + default: &558 value: total_count: 2 secrets: @@ -39585,7 +39621,7 @@ paths: description: Response content: application/json: - schema: &566 + schema: &559 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -39614,7 +39650,7 @@ paths: - key_id - key examples: - default: &567 + default: &560 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -39646,7 +39682,7 @@ paths: application/json: schema: *318 examples: - default: &569 + default: &562 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -41355,7 +41391,7 @@ paths: description: Response content: application/json: - schema: &595 + schema: &588 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -41372,7 +41408,7 @@ paths: - key_id - key examples: - default: &596 + default: &589 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -41702,7 +41738,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *83 - - &604 + - &597 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -41710,7 +41746,7 @@ paths: required: false schema: type: string - - &605 + - &598 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -41718,7 +41754,7 @@ paths: required: false schema: type: string - - &606 + - &599 name: time_period description: |- The time period to filter by. @@ -41734,7 +41770,7 @@ paths: - week - month default: month - - &607 + - &600 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -41759,7 +41795,7 @@ paths: application/json: schema: type: array - items: &608 + items: &601 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -41915,7 +41951,7 @@ paths: format: uri example: https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &609 + default: &602 value: - id: 21 number: 42 @@ -42006,7 +42042,7 @@ paths: - *99 - *100 - *101 - - &610 + - &603 name: request_status description: The status of the dismissal request to filter on. When specified, only requests with this status will be returned. @@ -42032,7 +42068,7 @@ paths: application/json: schema: type: array - items: &611 + items: &604 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -42153,7 +42189,7 @@ paths: format: uri example: https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &612 + default: &605 value: - id: 21 number: 42 @@ -42498,7 +42534,7 @@ paths: description: Response content: application/json: - schema: &451 + schema: &452 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -42579,7 +42615,7 @@ paths: example: mona_lisa@github.com type: string examples: - default: &452 + default: &453 value: group_id: '123' group_name: Octocat admins @@ -42634,7 +42670,7 @@ paths: description: Response content: application/json: - schema: &449 + schema: &450 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -42671,7 +42707,7 @@ paths: example: 2019-06-03 22:27:15:000 -700 type: string examples: - default: &450 + default: &451 value: groups: - group_id: '123' @@ -43973,7 +44009,7 @@ paths: application/json: schema: *22 examples: - default: &643 + default: &636 value: id: 1 account: @@ -44198,7 +44234,7 @@ paths: required: true content: application/json: - schema: &644 + schema: &637 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -45059,7 +45095,7 @@ paths: application/json: schema: *365 examples: - default: &562 + default: &555 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -46304,7 +46340,7 @@ paths: parameters: - *83 - *371 - - &818 + - &809 name: repo_name description: repo_name parameter in: path @@ -47336,7 +47372,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &429 + items: &430 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -47630,7 +47666,7 @@ paths: - nuget - container - *83 - - &819 + - &810 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -47671,7 +47707,7 @@ paths: default: *377 '403': *29 '401': *25 - '400': &821 + '400': &812 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -49463,7 +49499,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &898 + properties: &889 id: type: number description: The unique identifier of the status update. @@ -49511,7 +49547,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &899 + required: &890 - id - node_id - created_at @@ -49725,7 +49761,7 @@ paths: content: oneOf: - *227 - - &577 + - &570 title: Pull Request Simple description: Pull Request Simple type: object @@ -49954,7 +49990,7 @@ paths: - review_comment - self author_association: *214 - auto_merge: &692 + auto_merge: &685 title: Auto merge description: The status of auto merging a pull request. type: object @@ -50329,7 +50365,7 @@ paths: - updated_at - project_url examples: - default: &838 + default: &829 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -50461,7 +50497,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization parameters: - *394 - - &839 + - &830 name: field_id description: The unique identifier of the field. in: path @@ -50476,7 +50512,7 @@ paths: application/json: schema: *398 examples: - default: &840 + default: &831 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -50485,17 +50521,29 @@ paths: project_url: https://api.github.com/projects/67890 options: - id: option_1 - name: Low + name: + html: Low + raw: Low color: GREEN - description: Low priority items + description: + html: Low priority items + raw: Low priority items - id: option_2 - name: Medium + name: + html: Medium + raw: Medium color: YELLOW - description: Medium priority items + description: + html: Medium priority items + raw: Medium priority items - id: option_3 - name: High + name: + html: High + raw: High color: RED - description: High priority items + description: + html: High priority items + raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' headers: @@ -52251,7 +52299,7 @@ paths: description: Response content: application/json: - schema: &467 + schema: &460 title: Full Repository description: Full Repository type: object @@ -52644,7 +52692,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &582 + properties: &575 url: type: string format: uri @@ -52660,7 +52708,7 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &583 + required: &576 - url - key - name @@ -52749,7 +52797,7 @@ paths: - network_count - subscribers_count examples: - default: &469 + default: &462 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -53302,7 +53350,7 @@ paths: - *83 - *17 - *19 - - &715 + - &708 name: targets description: | A comma-separated list of rule targets to filter by. @@ -53516,7 +53564,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - *83 - - &717 + - &710 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -53528,14 +53576,14 @@ paths: x-multi-segment: true - *300 - *101 - - &718 + - &711 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &719 + - &712 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -53555,7 +53603,7 @@ paths: description: Response content: application/json: - schema: &720 + schema: &713 title: Rule Suites description: Response type: array @@ -53610,7 +53658,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &721 + default: &714 value: - id: 21 actor_id: 12 @@ -53654,7 +53702,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *83 - - &722 + - &715 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -53670,7 +53718,7 @@ paths: description: Response content: application/json: - schema: &723 + schema: &716 title: Rule Suite description: Response type: object @@ -53769,7 +53817,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &724 + default: &717 value: id: 21 actor_id: 12 @@ -54097,10 +54145,11 @@ paths: - *417 - *418 - *419 + - *420 - *106 - *19 - *17 - - &726 + - &719 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -54110,7 +54159,7 @@ paths: required: false schema: type: string - - &727 + - &720 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -54120,10 +54169,10 @@ paths: required: false schema: type: string - - *420 - *421 - *422 - *423 + - *424 responses: '200': description: Response @@ -54131,9 +54180,9 @@ paths: application/json: schema: type: array - items: *424 + items: *425 examples: - default: *425 + default: *426 headers: Link: *43 '404': *6 @@ -54168,9 +54217,9 @@ paths: description: Response content: application/json: - schema: *426 + schema: *427 examples: - default: *427 + default: *428 '403': *29 '404': *6 patch: @@ -54323,7 +54372,7 @@ paths: application/json: schema: type: array - items: &748 + items: &741 description: A repository security advisory. type: object properties: @@ -54543,7 +54592,7 @@ paths: login: type: string description: The username of the user credited. - type: *428 + type: *429 credits_detailed: type: array nullable: true @@ -54553,7 +54602,7 @@ paths: type: object properties: user: *4 - type: *428 + type: *429 state: type: string description: The state of the user's acceptance of the @@ -54614,7 +54663,7 @@ paths: - private_fork additionalProperties: false examples: - default: &749 + default: &742 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -55001,7 +55050,7 @@ paths: application/json: schema: type: array - items: *429 + items: *430 examples: default: *375 x-github: @@ -55085,7 +55134,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - *83 - - *430 + - *431 - *17 - *19 responses: @@ -55093,9 +55142,9 @@ paths: description: Success content: application/json: - schema: *431 + schema: *432 examples: - default: *432 + default: *433 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -55376,7 +55425,7 @@ paths: type: array items: *143 examples: - default: *433 + default: *434 headers: Link: *43 x-github: @@ -55577,15 +55626,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - *83 - - *434 + - *435 responses: '200': description: Response content: application/json: - schema: *435 + schema: *436 examples: - default: *436 + default: *437 headers: Link: *43 x-github: @@ -55623,7 +55672,7 @@ paths: description: Response content: application/json: - schema: &458 + schema: &457 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -55669,7 +55718,7 @@ paths: type: string nullable: true examples: - default: &459 + default: &458 value: groups: - group_id: '123' @@ -55877,7 +55926,7 @@ paths: description: Response content: application/json: - schema: &437 + schema: &438 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -56204,7 +56253,7 @@ paths: - repos_count - organization examples: - default: &438 + default: &439 value: id: 1 node_id: MDQ6VGVhbTE= @@ -56281,9 +56330,9 @@ paths: description: Response content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '404': *6 x-github: githubCloudOnly: false @@ -56367,16 +56416,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '201': description: Response content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '404': *6 '422': *15 '403': *29 @@ -56446,7 +56495,7 @@ paths: application/json: schema: type: array - items: &439 + items: &440 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -56545,7 +56594,7 @@ paths: - updated_at - url examples: - default: &792 + default: &785 value: - author: login: octocat @@ -56654,9 +56703,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: &440 + default: &441 value: author: login: octocat @@ -56730,7 +56779,7 @@ paths: parameters: - *83 - *210 - - &441 + - &442 name: discussion_number description: The number that identifies the discussion. in: path @@ -56742,9 +56791,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: *440 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56768,7 +56817,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 requestBody: required: false content: @@ -56791,9 +56840,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: &793 + default: &786 value: author: login: octocat @@ -56865,7 +56914,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 responses: '204': description: Response @@ -56893,7 +56942,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 - *106 - *17 - *19 @@ -56904,7 +56953,7 @@ paths: application/json: schema: type: array - items: &442 + items: &443 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -56976,7 +57025,7 @@ paths: - updated_at - url examples: - default: &794 + default: &787 value: - author: login: octocat @@ -57046,7 +57095,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 requestBody: required: true content: @@ -57068,9 +57117,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: &443 + default: &444 value: author: login: octocat @@ -57138,8 +57187,8 @@ paths: parameters: - *83 - *210 - - *441 - - &444 + - *442 + - &445 name: comment_number description: The number that identifies the comment. in: path @@ -57151,9 +57200,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: *443 + default: *444 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57177,8 +57226,8 @@ paths: parameters: - *83 - *210 - - *441 - - *444 + - *442 + - *445 requestBody: required: true content: @@ -57200,9 +57249,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: &795 + default: &788 value: author: login: octocat @@ -57268,8 +57317,8 @@ paths: parameters: - *83 - *210 - - *441 - - *444 + - *442 + - *445 responses: '204': description: Response @@ -57297,8 +57346,8 @@ paths: parameters: - *83 - *210 - - *441 - - *444 + - *442 + - *445 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -57324,7 +57373,7 @@ paths: application/json: schema: type: array - items: &445 + items: &446 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -57367,7 +57416,7 @@ paths: - content - created_at examples: - default: &447 + default: &448 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -57419,8 +57468,8 @@ paths: parameters: - *83 - *210 - - *441 - - *444 + - *442 + - *445 requestBody: required: true content: @@ -57453,9 +57502,9 @@ paths: team discussion comment content: application/json: - schema: *445 + schema: *446 examples: - default: &446 + default: &447 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -57484,9 +57533,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57511,9 +57560,9 @@ paths: parameters: - *83 - *210 - - *441 - - *444 - - &448 + - *442 + - *445 + - &449 name: reaction_id description: The unique identifier of the reaction. in: path @@ -57547,7 +57596,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -57573,9 +57622,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 x-github: @@ -57603,7 +57652,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 requestBody: required: true content: @@ -57635,16 +57684,16 @@ paths: description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57669,8 +57718,8 @@ paths: parameters: - *83 - *210 - - *441 - - *448 + - *442 + - *449 responses: '204': description: Response @@ -57700,9 +57749,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *450 examples: - default: *450 + default: *451 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -57745,9 +57794,9 @@ paths: description: Response content: application/json: - schema: *451 + schema: *452 examples: - default: *452 + default: *453 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -57888,7 +57937,7 @@ paths: description: Response content: application/json: - schema: &453 + schema: &454 title: Team Membership description: Team Membership type: object @@ -57915,7 +57964,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &796 + response-if-user-is-a-team-maintainer: &789 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -57978,9 +58027,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *454 examples: - response-if-users-membership-with-team-is-now-pending: &797 + response-if-users-membership-with-team-is-now-pending: &790 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -58028,322 +58077,6 @@ paths: enabledForGitHubApps: true category: teams subcategory: members - "/orgs/{org}/teams/{team_slug}/projects": - get: - summary: List team projects - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/list-projects-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects - parameters: - - *83 - - *210 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &454 - title: Team Project - description: A team's access to a project. - type: object - properties: - owner_url: - type: string - url: - type: string - html_url: - type: string - columns_url: - type: string - id: - type: integer - node_id: - type: string - name: - type: string - body: - type: string - nullable: true - number: - type: integer - state: - type: string - creator: *4 - created_at: - type: string - updated_at: - type: string - organization_permission: - description: The organization permission for this project. Only - present when owner is an organization. - type: string - private: - description: Whether the project is private or not. Only present - when owner is an organization. - type: boolean - permissions: - type: object - properties: - read: - type: boolean - write: - type: boolean - admin: - type: boolean - required: - - read - - write - - admin - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at - - permissions - examples: - default: &798 - value: - - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false - headers: - Link: *43 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": - get: - summary: Check team permissions for a project - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/check-permissions-for-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project - parameters: - - *83 - - *210 - - &455 - name: project_id - description: The unique identifier of the project. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *454 - examples: - default: &799 - value: - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - put: - summary: Add or update team project permissions - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/add-or-update-project-permissions-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions - parameters: - - *83 - - *210 - - *455 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - nullable: true - examples: - default: - summary: Updates the permissions for the team to write for the project - value: - permission: write - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Remove a project from a team - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/remove-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team - parameters: - - *83 - - *210 - - *455 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/orgs/{org}/teams/{team_slug}/repos": get: summary: List team repositories @@ -58403,14 +58136,14 @@ paths: parameters: - *83 - *210 + - *455 - *456 - - *457 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &800 + schema: &791 title: Team Repository description: A team's access to a repository. type: object @@ -58981,8 +58714,8 @@ paths: parameters: - *83 - *210 + - *455 - *456 - - *457 requestBody: required: false content: @@ -59029,8 +58762,8 @@ paths: parameters: - *83 - *210 + - *455 - *456 - - *457 responses: '204': description: Response @@ -59063,9 +58796,9 @@ paths: description: Response content: application/json: - schema: *458 + schema: *457 examples: - default: *459 + default: *458 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -59131,7 +58864,7 @@ paths: description: Response content: application/json: - schema: *458 + schema: *457 examples: default: value: @@ -59176,7 +58909,7 @@ paths: type: array items: *303 examples: - response-if-child-teams-exist: &801 + response-if-child-teams-exist: &792 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -59289,979 +59022,6 @@ paths: deprecationDate: '2024-07-22' removalDate: '2025-07-22' deprecated: true - "/projects/columns/cards/{card_id}": - get: - summary: Get a project card - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card - parameters: - - &460 - name: card_id - description: The unique identifier of the card. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: &461 - title: Project Card - description: Project cards represent a scope of work. - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/projects/columns/cards/1478 - id: - description: The project card's ID - example: 42 - type: integer - format: int64 - node_id: - type: string - example: MDExOlByb2plY3RDYXJkMTQ3OA== - note: - type: string - example: Add payload for delete Project column - nullable: true - creator: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - created_at: - type: string - format: date-time - example: '2016-09-05T14:21:06Z' - updated_at: - type: string - format: date-time - example: '2016-09-05T14:20:22Z' - archived: - description: Whether or not the card is archived - example: false - type: boolean - column_name: - type: string - project_id: - type: string - column_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367 - content_url: - type: string - format: uri - example: https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: - type: string - format: uri - example: https://api.github.com/projects/120 - required: - - id - - node_id - - note - - url - - column_url - - project_url - - creator - - created_at - - updated_at - examples: - default: &462 - value: - url: https://api.github.com/projects/columns/cards/1478 - id: 1478 - node_id: MDExOlByb2plY3RDYXJkMTQ3OA== - note: Add payload for delete Project column - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2016-09-05T14:21:06Z' - updated_at: '2016-09-05T14:20:22Z' - archived: false - column_url: https://api.github.com/projects/columns/367 - content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: https://api.github.com/projects/120 - '304': *37 - '403': *29 - '401': *25 - '404': *6 - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update an existing project card - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/update-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card - parameters: - - *460 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - note: - description: The project card's note - example: Update all gems - type: string - nullable: true - archived: - description: Whether or not the card is archived - example: false - type: boolean - examples: - default: - summary: Change the note on the card - value: - note: Add payload for delete Project column - responses: - '200': - description: Response - content: - application/json: - schema: *461 - examples: - default: *462 - '304': *37 - '403': *29 - '401': *25 - '404': *6 - '422': *7 - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete a project card - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/delete-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card - parameters: - - *460 - responses: - '204': - description: Response - '304': *37 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': *25 - '404': *6 - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/columns/cards/{card_id}/moves": - post: - summary: Move a project card - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/move-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card - parameters: - - *460 - requestBody: - required: true - content: - application/json: - schema: - properties: - position: - description: 'The position of the card in a column. Can be one of: - `top`, `bottom`, or `after:` to place after the specified - card.' - example: bottom - type: string - pattern: "^(?:top|bottom|after:\\d+)$" - column_id: - description: The unique identifier of the column the card should - be moved to - example: 42 - type: integer - required: - - position - type: object - examples: - default: - summary: Move the card to the bottom of the column - value: - column_id: 42 - position: bottom - responses: - '201': - description: Response - content: - application/json: - schema: - type: object - properties: {} - additionalProperties: false - examples: - default: - value: - '304': *37 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: object - properties: - code: - type: string - message: - type: string - resource: - type: string - field: - type: string - '401': *25 - '503': - description: Response - content: - application/json: - schema: - type: object - properties: - code: - type: string - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: object - properties: - code: - type: string - message: - type: string - '422': *15 - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/columns/{column_id}": - get: - summary: Get a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-column - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column - parameters: - - &463 - name: column_id - description: The unique identifier of the column. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: &464 - title: Project Column - description: Project columns contain cards of work. - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/projects/columns/367 - project_url: - type: string - format: uri - example: https://api.github.com/projects/120 - cards_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367/cards - id: - description: The unique identifier of the project column - example: 42 - type: integer - node_id: - type: string - example: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: - description: Name of the project column - example: Remaining tasks - type: string - created_at: - type: string - format: date-time - example: '2016-09-05T14:18:44Z' - updated_at: - type: string - format: date-time - example: '2016-09-05T14:22:28Z' - required: - - id - - node_id - - url - - project_url - - cards_url - - name - - created_at - - updated_at - examples: - default: &465 - value: - url: https://api.github.com/projects/columns/367 - project_url: https://api.github.com/projects/120 - cards_url: https://api.github.com/projects/columns/367/cards - id: 367 - node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: To Do - created_at: '2016-09-05T14:18:44Z' - updated_at: '2016-09-05T14:22:28Z' - '304': *37 - '403': *29 - '404': *6 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update an existing project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/update-column - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-project-column - parameters: - - *463 - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project column - example: Remaining tasks - type: string - required: - - name - type: object - examples: - default: - summary: Rename the project column - value: - name: To Do - responses: - '200': - description: Response - content: - application/json: - schema: *464 - examples: - default: *465 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/delete-column - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#delete-a-project-column - parameters: - - *463 - responses: - '204': - description: Response - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/columns/{column_id}/cards": - get: - summary: List project cards - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/list-cards - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards - parameters: - - *463 - - name: archived_state - description: Filters the project cards that are returned by the card's state. - in: query - required: false - schema: - type: string - enum: - - all - - archived - - not_archived - default: not_archived - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *461 - examples: - default: - value: - - url: https://api.github.com/projects/columns/cards/1478 - id: 1478 - node_id: MDExOlByb2plY3RDYXJkMTQ3OA== - note: Add payload for delete Project column - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2016-09-05T14:21:06Z' - updated_at: '2016-09-05T14:20:22Z' - archived: false - column_url: https://api.github.com/projects/columns/367 - content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: https://api.github.com/projects/120 - headers: - Link: *43 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - post: - summary: Create a project card - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/create-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card - parameters: - - *463 - requestBody: - required: true - content: - application/json: - schema: - oneOf: - - type: object - properties: - note: - description: The project card's note - example: Update all gems - type: string - nullable: true - required: - - note - - type: object - properties: - content_id: - description: The unique identifier of the content associated with - the card - example: 42 - type: integer - content_type: - description: The piece of content associated with the card - example: PullRequest - type: string - required: - - content_id - - content_type - examples: - default: - summary: Create a new card - value: - note: Add payload for delete Project column - responses: - '201': - description: Response - content: - application/json: - schema: *461 - examples: - default: *462 - '304': *37 - '403': *29 - '401': *25 - '422': - description: Validation failed - content: - application/json: - schema: - oneOf: - - *249 - - *250 - '503': - description: Response - content: - application/json: - schema: - type: object - properties: - code: - type: string - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: object - properties: - code: - type: string - message: - type: string - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/columns/{column_id}/moves": - post: - summary: Move a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/move-column - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#move-a-project-column - parameters: - - *463 - requestBody: - required: true - content: - application/json: - schema: - properties: - position: - description: 'The position of the column in a project. Can be one - of: `first`, `last`, or `after:` to place after the - specified column.' - example: last - type: string - pattern: "^(?:first|last|after:\\d+)$" - required: - - position - type: object - examples: - default: - summary: Move the column to the end of the board - value: - position: last - responses: - '201': - description: Response - content: - application/json: - schema: - type: object - properties: {} - additionalProperties: false - examples: - default: - value: - '304': *37 - '403': *29 - '422': *7 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators": - get: - summary: List project collaborators - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/list-collaborators - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#list-project-collaborators - parameters: - - *455 - - name: affiliation - description: Filters the collaborators by their affiliation. `outside` means - outside collaborators of a project that are not a member of the project's - organization. `direct` means collaborators with permissions to a project, - regardless of organization membership status. `all` means all collaborators - the authenticated user can see. - in: query - required: false - schema: - type: string - enum: - - outside - - direct - - all - default: all - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *207 - headers: - Link: *43 - '404': *6 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators/{username}": - put: - summary: Add project collaborator - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/add-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#add-project-collaborator - parameters: - - *455 - - *138 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - description: The permission to grant the collaborator. - enum: - - read - - write - - admin - default: write - example: write - type: string - nullable: true - examples: - default: - summary: Applying write permissions for the new collaborator - value: - permission: write - responses: - '204': - description: Response - '404': *6 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Remove user as a collaborator - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/remove-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#remove-user-as-a-collaborator - parameters: - - *455 - - *138 - responses: - '204': - description: Response - '304': *37 - '404': *6 - '403': *29 - '422': *15 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators/{username}/permission": - get: - summary: Get project permission for a user - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-permission-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#get-project-permission-for-a-user - parameters: - - *455 - - *138 - responses: - '200': - description: Response - content: - application/json: - schema: - title: Project Collaborator Permission - description: Project Collaborator Permission - type: object - properties: - permission: - type: string - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - required: - - permission - - user - examples: - default: - value: - permission: admin - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - '404': *6 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/rate_limit": get: summary: Get rate limit status for the authenticated user @@ -60303,7 +59063,7 @@ paths: resources: type: object properties: - core: &466 + core: &459 title: Rate Limit type: object properties: @@ -60320,21 +59080,21 @@ paths: - remaining - reset - used - graphql: *466 - search: *466 - code_search: *466 - source_import: *466 - integration_manifest: *466 - code_scanning_upload: *466 - actions_runner_registration: *466 - scim: *466 - dependency_snapshots: *466 - dependency_sbom: *466 - code_scanning_autofix: *466 + graphql: *459 + search: *459 + code_search: *459 + source_import: *459 + integration_manifest: *459 + code_scanning_upload: *459 + actions_runner_registration: *459 + scim: *459 + dependency_snapshots: *459 + dependency_sbom: *459 + code_scanning_autofix: *459 required: - core - search - rate: *466 + rate: *459 required: - rate - resources @@ -60439,14 +59199,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response content: application/json: - schema: *467 + schema: *460 examples: default-response: summary: Default response @@ -60951,7 +59711,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *468 + '301': *461 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60969,8 +59729,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: false content: @@ -61227,10 +59987,10 @@ paths: description: Response content: application/json: - schema: *467 + schema: *460 examples: - default: *469 - '307': &470 + default: *462 + '307': &463 description: Temporary Redirect content: application/json: @@ -61259,8 +60019,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -61282,7 +60042,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository - '307': *470 + '307': *463 '404': *6 '409': *114 x-github: @@ -61306,11 +60066,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: + - *455 - *456 - - *457 - *17 - *19 - - &485 + - &478 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -61333,7 +60093,7 @@ paths: type: integer artifacts: type: array - items: &471 + items: &464 title: Artifact description: An artifact type: object @@ -61411,7 +60171,7 @@ paths: - expires_at - updated_at examples: - default: &486 + default: &479 value: total_count: 2 artifacts: @@ -61472,9 +60232,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: + - *455 - *456 - - *457 - - &472 + - &465 name: artifact_id description: The unique identifier of the artifact. in: path @@ -61486,7 +60246,7 @@ paths: description: Response content: application/json: - schema: *471 + schema: *464 examples: default: value: @@ -61524,9 +60284,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: + - *455 - *456 - - *457 - - *472 + - *465 responses: '204': description: Response @@ -61550,9 +60310,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: + - *455 - *456 - - *457 - - *472 + - *465 - name: archive_format in: path required: true @@ -61566,7 +60326,7 @@ paths: example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': &647 + '410': &640 description: Gone content: application/json: @@ -61593,14 +60353,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response content: application/json: - schema: *473 + schema: *466 examples: default: value: @@ -61626,11 +60386,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-github-actions-caches-for-a-repository parameters: + - *455 - *456 - - *457 - *17 - *19 - - &474 + - &467 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -61664,7 +60424,7 @@ paths: description: Response content: application/json: - schema: &475 + schema: &468 title: Repository actions caches description: Repository actions caches type: object @@ -61706,7 +60466,7 @@ paths: - total_count - actions_caches examples: - default: &476 + default: &469 value: total_count: 1 actions_caches: @@ -61738,23 +60498,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: + - *455 - *456 - - *457 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *474 + - *467 responses: '200': description: Response content: application/json: - schema: *475 + schema: *468 examples: - default: *476 + default: *469 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61774,8 +60534,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: + - *455 - *456 - - *457 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -61806,9 +60566,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: + - *455 - *456 - - *457 - - &477 + - &470 name: job_id description: The unique identifier of the job. in: path @@ -61820,7 +60580,7 @@ paths: description: Response content: application/json: - schema: &489 + schema: &482 title: Job description: Information of a job execution in a workflow run type: object @@ -62127,9 +60887,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: + - *455 - *456 - - *457 - - *477 + - *470 responses: '302': description: Response @@ -62157,9 +60917,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: + - *455 - *456 - - *457 - - *477 + - *470 requestBody: required: false content: @@ -62204,8 +60964,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Status response @@ -62255,8 +61015,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -62319,8 +61079,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -62338,7 +61098,7 @@ paths: type: integer secrets: type: array - items: &491 + items: &484 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -62358,7 +61118,7 @@ paths: - created_at - updated_at examples: - default: &492 + default: &485 value: total_count: 2 secrets: @@ -62391,9 +61151,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: + - *455 - *456 - - *457 - - *478 + - *471 - *19 responses: '200': @@ -62410,7 +61170,7 @@ paths: type: integer variables: type: array - items: &495 + items: &488 title: Actions Variable type: object properties: @@ -62440,7 +61200,7 @@ paths: - created_at - updated_at examples: - default: &496 + default: &489 value: total_count: 2 variables: @@ -62473,8 +61233,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -62483,7 +61243,7 @@ paths: schema: type: object properties: - enabled: &479 + enabled: &472 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *56 @@ -62518,8 +61278,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -62530,7 +61290,7 @@ paths: schema: type: object properties: - enabled: *479 + enabled: *472 allowed_actions: *56 sha_pinning_required: *57 required: @@ -62563,14 +61323,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response content: application/json: - schema: &480 + schema: &473 type: object properties: access_level: @@ -62588,7 +61348,7 @@ paths: required: - access_level examples: - default: &481 + default: &474 value: access_level: organization x-github: @@ -62613,15 +61373,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: application/json: - schema: *480 + schema: *473 examples: - default: *481 + default: *474 responses: '204': description: Response @@ -62645,8 +61405,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -62676,8 +61436,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: + - *455 - *456 - - *457 responses: '204': description: Empty response for successful settings update @@ -62711,8 +61471,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -62739,8 +61499,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -62774,8 +61534,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -62803,8 +61563,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -62835,8 +61595,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -62867,8 +61627,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -62900,8 +61660,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -62930,8 +61690,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: + - *455 - *456 - - *457 responses: '204': description: Success response @@ -62971,8 +61731,8 @@ paths: in: query schema: type: string + - *455 - *456 - - *457 - *17 - *19 responses: @@ -63016,8 +61776,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -63049,8 +61809,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -63124,8 +61884,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: + - *455 - *456 - - *457 responses: '201': description: Response @@ -63161,8 +61921,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: + - *455 - *456 - - *457 responses: '201': description: Response @@ -63192,8 +61952,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: + - *455 - *456 - - *457 - *71 responses: '200': @@ -63223,8 +61983,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: + - *455 - *456 - - *457 - *71 responses: '204': @@ -63251,8 +62011,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: + - *455 - *456 - - *457 - *71 responses: '200': *77 @@ -63277,8 +62037,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: + - *455 - *456 - - *457 - *71 requestBody: required: true @@ -63327,8 +62087,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: + - *455 - *456 - - *457 - *71 requestBody: required: true @@ -63378,8 +62138,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: + - *455 - *456 - - *457 - *71 responses: '200': *281 @@ -63409,8 +62169,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: + - *455 - *456 - - *457 - *71 - *282 responses: @@ -63440,9 +62200,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: + - *455 - *456 - - *457 - - &499 + - &492 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -63450,7 +62210,7 @@ paths: required: false schema: type: string - - &500 + - &493 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -63458,7 +62218,7 @@ paths: required: false schema: type: string - - &501 + - &494 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -63467,7 +62227,7 @@ paths: required: false schema: type: string - - &502 + - &495 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -63494,7 +62254,7 @@ paths: - pending - *17 - *19 - - &503 + - &496 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -63503,7 +62263,7 @@ paths: schema: type: string format: date-time - - &482 + - &475 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -63512,13 +62272,13 @@ paths: schema: type: boolean default: false - - &504 + - &497 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &505 + - &498 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -63541,7 +62301,7 @@ paths: type: integer workflow_runs: type: array - items: &483 + items: &476 title: Workflow Run description: An invocation of a workflow type: object @@ -63636,7 +62396,7 @@ paths: that triggered the run. type: array nullable: true - items: &524 + items: &517 title: Pull Request Minimal type: object properties: @@ -63755,7 +62515,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &528 + properties: &521 id: type: string description: SHA for the commit @@ -63806,7 +62566,7 @@ paths: - name - email nullable: true - required: &529 + required: &522 - id - tree_id - message @@ -63853,7 +62613,7 @@ paths: - workflow_url - pull_requests examples: - default: &506 + default: &499 value: total_count: 1 workflow_runs: @@ -64089,24 +62849,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: + - *455 - *456 - - *457 - - &484 + - &477 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *482 + - *475 responses: '200': description: Response content: application/json: - schema: *483 + schema: *476 examples: - default: &487 + default: &480 value: id: 30433642 name: Build @@ -64347,9 +63107,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: + - *455 - *456 - - *457 - - *484 + - *477 responses: '204': description: Response @@ -64372,9 +63132,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: + - *455 - *456 - - *457 - - *484 + - *477 responses: '200': description: Response @@ -64493,9 +63253,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: + - *455 - *456 - - *457 - - *484 + - *477 responses: '201': description: Response @@ -64528,12 +63288,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: + - *455 - *456 - - *457 - - *484 + - *477 - *17 - *19 - - *485 + - *478 responses: '200': description: Response @@ -64549,9 +63309,9 @@ paths: type: integer artifacts: type: array - items: *471 + items: *464 examples: - default: *486 + default: *479 headers: Link: *43 x-github: @@ -64575,25 +63335,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: + - *455 - *456 - - *457 - - *484 - - &488 + - *477 + - &481 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *482 + - *475 responses: '200': description: Response content: application/json: - schema: *483 + schema: *476 examples: - default: *487 + default: *480 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64616,10 +63376,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: + - *455 - *456 - - *457 - - *484 - - *488 + - *477 + - *481 - *17 - *19 responses: @@ -64637,9 +63397,9 @@ paths: type: integer jobs: type: array - items: *489 + items: *482 examples: - default: &490 + default: &483 value: total_count: 1 jobs: @@ -64752,10 +63512,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: + - *455 - *456 - - *457 - - *484 - - *488 + - *477 + - *481 responses: '302': description: Response @@ -64783,9 +63543,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: + - *455 - *456 - - *457 - - *484 + - *477 responses: '202': description: Response @@ -64818,9 +63578,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: + - *455 - *456 - - *457 - - *484 + - *477 requestBody: required: true content: @@ -64887,9 +63647,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: + - *455 - *456 - - *457 - - *484 + - *477 responses: '202': description: Response @@ -64922,9 +63682,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: + - *455 - *456 - - *457 - - *484 + - *477 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -64954,9 +63714,9 @@ paths: type: integer jobs: type: array - items: *489 + items: *482 examples: - default: *490 + default: *483 headers: Link: *43 x-github: @@ -64981,9 +63741,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: + - *455 - *456 - - *457 - - *484 + - *477 responses: '302': description: Response @@ -65010,9 +63770,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: + - *455 - *456 - - *457 - - *484 + - *477 responses: '204': description: Response @@ -65039,9 +63799,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: + - *455 - *456 - - *457 - - *484 + - *477 responses: '200': description: Response @@ -65101,7 +63861,7 @@ paths: items: type: object properties: - type: &613 + type: &606 type: string description: The type of reviewer. enum: @@ -65186,9 +63946,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: + - *455 - *456 - - *457 - - *484 + - *477 requestBody: required: true content: @@ -65235,7 +63995,7 @@ paths: application/json: schema: type: array - items: &599 + items: &592 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -65341,7 +64101,7 @@ paths: - created_at - updated_at examples: - default: &600 + default: &593 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -65397,9 +64157,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: + - *455 - *456 - - *457 - - *484 + - *477 requestBody: required: false content: @@ -65443,9 +64203,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: + - *455 - *456 - - *457 - - *484 + - *477 requestBody: required: false content: @@ -65499,9 +64259,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: + - *455 - *456 - - *457 - - *484 + - *477 responses: '200': description: Response @@ -65638,8 +64398,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -65657,9 +64417,9 @@ paths: type: integer secrets: type: array - items: *491 + items: *484 examples: - default: *492 + default: *485 headers: Link: *43 x-github: @@ -65684,16 +64444,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: + - *455 - *456 - - *457 responses: '200': description: Response content: application/json: - schema: *493 + schema: *486 examples: - default: *494 + default: *487 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65715,17 +64475,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: + - *455 - *456 - - *457 - *284 responses: '200': description: Response content: application/json: - schema: *491 + schema: *484 examples: - default: &626 + default: &619 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -65751,8 +64511,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: + - *455 - *456 - - *457 - *284 requestBody: required: true @@ -65810,8 +64570,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: + - *455 - *456 - - *457 - *284 responses: '204': @@ -65837,9 +64597,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: + - *455 - *456 - - *457 - - *478 + - *471 - *19 responses: '200': @@ -65856,9 +64616,9 @@ paths: type: integer variables: type: array - items: *495 + items: *488 examples: - default: *496 + default: *489 headers: Link: *43 x-github: @@ -65881,8 +64641,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -65934,17 +64694,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: + - *455 - *456 - - *457 - *287 responses: '200': description: Response content: application/json: - schema: *495 + schema: *488 examples: - default: &627 + default: &620 value: name: USERNAME value: octocat @@ -65970,8 +64730,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: + - *455 - *456 - - *457 - *287 requestBody: required: true @@ -66014,8 +64774,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: + - *455 - *456 - - *457 - *287 responses: '204': @@ -66041,8 +64801,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -66060,7 +64820,7 @@ paths: type: integer workflows: type: array - items: &497 + items: &490 title: Workflow description: A GitHub Actions workflow type: object @@ -66167,9 +64927,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: + - *455 - *456 - - *457 - - &498 + - &491 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -66184,7 +64944,7 @@ paths: description: Response content: application/json: - schema: *497 + schema: *490 examples: default: value: @@ -66217,9 +64977,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: + - *455 - *456 - - *457 - - *498 + - *491 responses: '204': description: Response @@ -66244,9 +65004,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: + - *455 - *456 - - *457 - - *498 + - *491 responses: '204': description: Response @@ -66297,9 +65057,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: + - *455 - *456 - - *457 - - *498 + - *491 responses: '204': description: Response @@ -66326,19 +65086,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: + - *455 - *456 - - *457 - - *498 - - *499 - - *500 - - *501 - - *502 + - *491 + - *492 + - *493 + - *494 + - *495 - *17 - *19 - - *503 - - *482 - - *504 - - *505 + - *496 + - *475 + - *497 + - *498 responses: '200': description: Response @@ -66354,9 +65114,9 @@ paths: type: integer workflow_runs: type: array - items: *483 + items: *476 examples: - default: *506 + default: *499 headers: Link: *43 x-github: @@ -66389,9 +65149,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: + - *455 - *456 - - *457 - - *498 + - *491 responses: '200': description: Response @@ -66452,8 +65212,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: + - *455 - *456 - - *457 - *106 - *17 - *104 @@ -66617,8 +65377,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -66655,8 +65415,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned parameters: + - *455 - *456 - - *457 - name: assignee in: path required: true @@ -66692,8 +65452,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -66805,8 +65565,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: + - *455 - *456 - - *457 - *17 - *104 - *105 @@ -66863,7 +65623,7 @@ paths: initiator: type: string examples: - default: *507 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66883,8 +65643,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -66892,7 +65652,7 @@ paths: application/json: schema: type: array - items: &508 + items: &501 title: Autolink reference description: An autolink reference. type: object @@ -66946,8 +65706,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -66986,9 +65746,9 @@ paths: description: response content: application/json: - schema: *508 + schema: *501 examples: - default: &509 + default: &502 value: id: 1 key_prefix: TICKET- @@ -67019,9 +65779,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: + - *455 - *456 - - *457 - - &510 + - &503 name: autolink_id description: The unique identifier of the autolink. in: path @@ -67033,9 +65793,9 @@ paths: description: Response content: application/json: - schema: *508 + schema: *501 examples: - default: *509 + default: *502 '404': *6 x-github: githubCloudOnly: false @@ -67055,9 +65815,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: + - *455 - *456 - - *457 - - *510 + - *503 responses: '204': description: Response @@ -67081,8 +65841,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response if Dependabot is enabled @@ -67130,8 +65890,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -67152,8 +65912,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -67173,8 +65933,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: + - *455 - *456 - - *457 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -67212,7 +65972,7 @@ paths: - url protected: type: boolean - protection: &512 + protection: &505 title: Branch Protection description: Branch Protection type: object @@ -67254,7 +66014,7 @@ paths: required: - contexts - checks - enforce_admins: &515 + enforce_admins: &508 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -67269,7 +66029,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &517 + required_pull_request_reviews: &510 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -67345,7 +66105,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &514 + restrictions: &507 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -67622,9 +66382,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: + - *455 - *456 - - *457 - - &513 + - &506 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql). @@ -67638,14 +66398,14 @@ paths: description: Response content: application/json: - schema: &523 + schema: &516 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &573 + commit: &566 title: Commit description: Commit type: object @@ -67679,7 +66439,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &511 + properties: &504 name: type: string example: '"Chris Wanstrath"' @@ -67688,13 +66448,14 @@ paths: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true committer: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *511 + properties: *504 nullable: true message: type: string @@ -67715,7 +66476,7 @@ paths: required: - sha - url - verification: &633 + verification: &626 title: Verification type: object properties: @@ -67785,7 +66546,7 @@ paths: type: integer files: type: array - items: &586 + items: &579 title: Diff Entry description: Diff Entry type: object @@ -67869,7 +66630,7 @@ paths: - self protected: type: boolean - protection: *512 + protection: *505 protection_url: type: string format: uri @@ -67976,7 +66737,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *468 + '301': *461 '404': *6 x-github: githubCloudOnly: false @@ -67998,15 +66759,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response content: application/json: - schema: *512 + schema: *505 examples: default: value: @@ -68200,9 +66961,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: true content: @@ -68457,7 +67218,7 @@ paths: url: type: string format: uri - required_status_checks: &520 + required_status_checks: &513 title: Status Check Policy description: Status Check Policy type: object @@ -68609,7 +67370,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *514 + restrictions: *507 required_conversation_resolution: type: object properties: @@ -68721,9 +67482,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '204': description: Response @@ -68748,17 +67509,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response content: application/json: - schema: *515 + schema: *508 examples: - default: &516 + default: &509 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -68780,17 +67541,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response content: application/json: - schema: *515 + schema: *508 examples: - default: *516 + default: *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68809,9 +67570,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '204': description: Response @@ -68836,17 +67597,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response content: application/json: - schema: *517 + schema: *510 examples: - default: &518 + default: &511 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -68942,9 +67703,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: false content: @@ -69042,9 +67803,9 @@ paths: description: Response content: application/json: - schema: *517 + schema: *510 examples: - default: *518 + default: *511 '422': *15 x-github: githubCloudOnly: false @@ -69065,9 +67826,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '204': description: Response @@ -69094,17 +67855,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response content: application/json: - schema: *515 + schema: *508 examples: - default: &519 + default: &512 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -69127,17 +67888,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response content: application/json: - schema: *515 + schema: *508 examples: - default: *519 + default: *512 '404': *6 x-github: githubCloudOnly: false @@ -69157,9 +67918,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '204': description: Response @@ -69184,17 +67945,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response content: application/json: - schema: *520 + schema: *513 examples: - default: &521 + default: &514 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -69220,9 +67981,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: false content: @@ -69274,9 +68035,9 @@ paths: description: Response content: application/json: - schema: *520 + schema: *513 examples: - default: *521 + default: *514 '404': *6 '422': *15 x-github: @@ -69298,9 +68059,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '204': description: Response @@ -69324,9 +68085,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response @@ -69360,9 +68121,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: false content: @@ -69429,9 +68190,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: false content: @@ -69495,9 +68256,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: content: application/json: @@ -69563,15 +68324,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response content: application/json: - schema: *514 + schema: *507 examples: default: value: @@ -69662,9 +68423,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '204': description: Response @@ -69687,9 +68448,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response @@ -69699,7 +68460,7 @@ paths: type: array items: *5 examples: - default: &522 + default: &515 value: - id: 1 slug: octoapp @@ -69756,9 +68517,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: true content: @@ -69792,7 +68553,7 @@ paths: type: array items: *5 examples: - default: *522 + default: *515 '422': *15 x-github: githubCloudOnly: false @@ -69813,9 +68574,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: true content: @@ -69849,7 +68610,7 @@ paths: type: array items: *5 examples: - default: *522 + default: *515 '422': *15 x-github: githubCloudOnly: false @@ -69870,9 +68631,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: true content: @@ -69906,7 +68667,7 @@ paths: type: array items: *5 examples: - default: *522 + default: *515 '422': *15 x-github: githubCloudOnly: false @@ -69928,9 +68689,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response @@ -69960,9 +68721,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: false content: @@ -70021,9 +68782,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: false content: @@ -70082,9 +68843,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: content: application/json: @@ -70143,9 +68904,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response @@ -70179,9 +68940,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: true content: @@ -70239,9 +69000,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: true content: @@ -70299,9 +69060,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: true content: @@ -70361,9 +69122,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: true content: @@ -70385,7 +69146,7 @@ paths: description: Response content: application/json: - schema: *523 + schema: *516 examples: default: value: @@ -70499,8 +69260,8 @@ paths: category: repos subcategory: bypass-requests parameters: + - *455 - *456 - - *457 - *99 - *100 - *101 @@ -70536,8 +69297,8 @@ paths: category: repos subcategory: bypass-requests parameters: + - *455 - *456 - - *457 - name: bypass_request_number in: path required: true @@ -70610,8 +69371,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: + - *455 - *456 - - *457 - *99 - *100 - *101 @@ -70651,8 +69412,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: + - *455 - *456 - - *457 - name: bypass_request_number in: path required: true @@ -70722,8 +69483,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: + - *455 - *456 - - *457 - name: bypass_request_number in: path required: true @@ -70794,8 +69555,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: + - *455 - *456 - - *457 - name: bypass_response_id in: path required: true @@ -70828,8 +69589,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -71108,7 +69869,7 @@ paths: description: Response content: application/json: - schema: &525 + schema: &518 title: CheckRun description: A check performed on the code of a given code change type: object @@ -71227,8 +69988,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *524 - deployment: &851 + items: *517 + deployment: &842 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -71508,9 +70269,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: + - *455 - *456 - - *457 - - &526 + - &519 name: check_run_id description: The unique identifier of the check run. in: path @@ -71522,9 +70283,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *518 examples: - default: &527 + default: &520 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -71624,9 +70385,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: + - *455 - *456 - - *457 - - *526 + - *519 requestBody: required: true content: @@ -71866,9 +70627,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *518 examples: - default: *527 + default: *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71888,9 +70649,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: + - *455 - *456 - - *457 - - *526 + - *519 - *17 - *19 responses: @@ -71985,9 +70746,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: + - *455 - *456 - - *457 - - *526 + - *519 responses: '201': description: Response @@ -72031,8 +70792,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -72054,7 +70815,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &530 + schema: &523 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -72118,7 +70879,7 @@ paths: nullable: true pull_requests: type: array - items: *524 + items: *517 nullable: true app: title: GitHub app @@ -72140,12 +70901,12 @@ paths: type: string format: date-time nullable: true - head_commit: &882 + head_commit: &873 title: Simple Commit description: A commit. type: object - properties: *528 - required: *529 + properties: *521 + required: *522 latest_check_runs_count: type: integer check_runs_url: @@ -72173,7 +70934,7 @@ paths: - check_runs_url - pull_requests examples: - default: &531 + default: &524 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -72464,9 +71225,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *530 + schema: *523 examples: - default: *531 + default: *524 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72485,8 +71246,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -72795,9 +71556,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: + - *455 - *456 - - *457 - - &532 + - &525 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -72809,9 +71570,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *523 examples: - default: *531 + default: *524 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72834,17 +71595,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-in-a-check-suite parameters: + - *455 - *456 - - *457 - - *532 - - &579 + - *525 + - &572 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &580 + - &573 name: status description: Returns check runs with the specified `status`. in: query @@ -72883,9 +71644,9 @@ paths: type: integer check_runs: type: array - items: *525 + items: *518 examples: - default: &581 + default: &574 value: total_count: 1 check_runs: @@ -72987,9 +71748,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: + - *455 - *456 - - *457 - - *532 + - *525 responses: '201': description: Response @@ -73022,21 +71783,21 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: + - *455 - *456 - - *457 - *307 - *308 - *19 - *17 - - &548 + - &541 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *533 - - &549 + schema: *526 + - &542 name: pr description: The number of the pull request for the results you want to list. in: query @@ -73067,7 +71828,7 @@ paths: be returned. in: query required: false - schema: *534 + schema: *527 responses: '200': description: Response @@ -73083,7 +71844,7 @@ paths: updated_at: *131 url: *128 html_url: *129 - instances_url: *535 + instances_url: *528 state: *109 fixed_at: *133 dismissed_by: @@ -73094,11 +71855,11 @@ paths: required: *21 nullable: true dismissed_at: *132 - dismissed_reason: *536 - dismissed_comment: *537 - rule: *538 - tool: *539 - most_recent_instance: *540 + dismissed_reason: *529 + dismissed_comment: *530 + rule: *531 + tool: *532 + most_recent_instance: *533 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -73224,7 +71985,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &541 + '403': &534 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -73251,9 +72012,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: + - *455 - *456 - - *457 - - &542 + - &535 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -73267,7 +72028,7 @@ paths: description: Response content: application/json: - schema: &543 + schema: &536 type: object properties: number: *123 @@ -73275,7 +72036,7 @@ paths: updated_at: *131 url: *128 html_url: *129 - instances_url: *535 + instances_url: *528 state: *109 fixed_at: *133 dismissed_by: @@ -73286,8 +72047,8 @@ paths: required: *21 nullable: true dismissed_at: *132 - dismissed_reason: *536 - dismissed_comment: *537 + dismissed_reason: *529 + dismissed_comment: *530 rule: type: object properties: @@ -73341,8 +72102,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *539 - most_recent_instance: *540 + tool: *532 + most_recent_instance: *533 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -73441,7 +72202,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *541 + '403': *534 '404': *6 '503': *190 x-github: @@ -73461,9 +72222,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: + - *455 - *456 - - *457 - - *542 + - *535 requestBody: required: true content: @@ -73478,8 +72239,8 @@ paths: enum: - open - dismissed - dismissed_reason: *536 - dismissed_comment: *537 + dismissed_reason: *529 + dismissed_comment: *530 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -73498,7 +72259,7 @@ paths: description: Response content: application/json: - schema: *543 + schema: *536 examples: default: value: @@ -73574,7 +72335,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &547 + '403': &540 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -73601,15 +72362,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: + - *455 - *456 - - *457 - - *542 + - *535 responses: '200': description: Response content: application/json: - schema: &544 + schema: &537 type: object properties: status: @@ -73635,13 +72396,13 @@ paths: - description - started_at examples: - default: &545 + default: &538 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &546 + '400': &539 description: Bad Request content: application/json: @@ -73652,7 +72413,7 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *541 + '403': *534 '404': *6 '503': *190 x-github: @@ -73677,29 +72438,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: + - *455 - *456 - - *457 - - *542 + - *535 responses: '200': description: OK content: application/json: - schema: *544 + schema: *537 examples: - default: *545 + default: *538 '202': description: Accepted content: application/json: - schema: *544 + schema: *537 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *546 + '400': *539 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -73731,9 +72492,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: + - *455 - *456 - - *457 - - *542 + - *535 requestBody: required: false content: @@ -73778,8 +72539,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *546 - '403': *547 + '400': *539 + '403': *540 '404': *6 '422': description: Unprocessable Entity @@ -73803,13 +72564,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: + - *455 - *456 - - *457 - - *542 + - *535 - *19 - *17 - - *548 - - *549 + - *541 + - *542 responses: '200': description: Response @@ -73817,7 +72578,7 @@ paths: application/json: schema: type: array - items: *540 + items: *533 examples: default: value: @@ -73856,7 +72617,7 @@ paths: end_column: 50 classifications: - source - '403': *541 + '403': *534 '404': *6 '503': *190 x-github: @@ -73890,25 +72651,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: + - *455 - *456 - - *457 - *307 - *308 - *19 - *17 - - *549 + - *542 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *533 + schema: *526 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &552 + schema: &545 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -73929,23 +72690,23 @@ paths: application/json: schema: type: array - items: &553 + items: &546 type: object properties: - ref: *533 - commit_sha: &561 + ref: *526 + commit_sha: &554 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *550 + analysis_key: *543 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *551 + category: *544 error: type: string example: error reading field xyz @@ -73969,8 +72730,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *552 - tool: *539 + sarif_id: *545 + tool: *532 deletable: type: boolean warning: @@ -74031,7 +72792,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *541 + '403': *534 '404': *6 '503': *190 x-github: @@ -74067,8 +72828,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: + - *455 - *456 - - *457 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -74081,7 +72842,7 @@ paths: description: Response content: application/json: - schema: *553 + schema: *546 examples: response: summary: application/json response @@ -74135,7 +72896,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *541 + '403': *534 '404': *6 '422': description: Response if analysis could not be processed @@ -74222,8 +72983,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: + - *455 - *456 - - *457 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -74276,7 +73037,7 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *547 + '403': *540 '404': *6 '503': *190 x-github: @@ -74298,8 +73059,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -74307,7 +73068,7 @@ paths: application/json: schema: type: array - items: &554 + items: &547 title: CodeQL Database description: A CodeQL database. type: object @@ -74418,7 +73179,7 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *541 + '403': *534 '404': *6 '503': *190 x-github: @@ -74447,8 +73208,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: + - *455 - *456 - - *457 - name: language in: path description: The language of the CodeQL database. @@ -74460,7 +73221,7 @@ paths: description: Response content: application/json: - schema: *554 + schema: *547 examples: default: value: @@ -74492,9 +73253,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &588 + '302': &581 description: Found - '403': *541 + '403': *534 '404': *6 '503': *190 x-github: @@ -74516,8 +73277,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: + - *455 - *456 - - *457 - name: language in: path description: The language of the CodeQL database. @@ -74527,7 +73288,7 @@ paths: responses: '204': description: Response - '403': *547 + '403': *540 '404': *6 '503': *190 x-github: @@ -74555,8 +73316,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -74565,7 +73326,7 @@ paths: type: object additionalProperties: false properties: - language: &555 + language: &548 type: string description: The language targeted by the CodeQL query enum: @@ -74645,7 +73406,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &559 + schema: &552 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -74655,7 +73416,7 @@ paths: description: The ID of the variant analysis. controller_repo: *115 actor: *4 - query_language: *555 + query_language: *548 query_pack_url: type: string description: The download url for the query pack. @@ -74702,7 +73463,7 @@ paths: items: type: object properties: - repository: &556 + repository: &549 title: Repository Identifier description: Repository Identifier type: object @@ -74738,7 +73499,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &560 + analysis_status: &553 type: string description: The new status of the CodeQL variant analysis repository task. @@ -74770,7 +73531,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &557 + access_mismatch_repos: &550 type: object properties: repository_count: @@ -74784,7 +73545,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *556 + items: *549 required: - repository_count - repositories @@ -74806,8 +73567,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *557 - over_limit_repos: *557 + no_codeql_db_repos: *550 + over_limit_repos: *550 required: - access_mismatch_repos - not_found_repos @@ -74823,7 +73584,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &558 + value: &551 summary: Default response value: id: 1 @@ -74975,10 +73736,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *558 + value: *551 repository_lists: summary: Response for a successful variant analysis submission - value: *558 + value: *551 '404': *6 '422': description: Unable to process variant analysis submission @@ -75006,8 +73767,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: + - *455 - *456 - - *457 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -75019,9 +73780,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *552 examples: - default: *558 + default: *551 '404': *6 '503': *190 x-github: @@ -75044,7 +73805,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *456 + - *455 - name: repo in: path description: The name of the controller repository. @@ -75079,7 +73840,7 @@ paths: type: object properties: repository: *115 - analysis_status: *560 + analysis_status: *553 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -75204,8 +73965,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -75290,7 +74051,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *541 + '403': *534 '404': *6 '503': *190 x-github: @@ -75311,8 +74072,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -75404,7 +74165,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *547 + '403': *540 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -75475,8 +74236,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -75484,7 +74245,7 @@ paths: schema: type: object properties: - commit_sha: *561 + commit_sha: *554 ref: type: string description: |- @@ -75542,7 +74303,7 @@ paths: schema: type: object properties: - id: *552 + id: *545 url: type: string description: The REST API URL for checking the status of the upload. @@ -75556,7 +74317,7 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *547 + '403': *540 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -75579,8 +74340,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: + - *455 - *456 - - *457 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -75626,7 +74387,7 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *541 + '403': *534 '404': description: Not Found if the sarif id does not match any upload '503': *190 @@ -75651,8 +74412,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -75733,8 +74494,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: + - *455 - *456 - - *457 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -75854,8 +74615,8 @@ paths: parameters: - *17 - *19 + - *455 - *456 - - *457 responses: '200': description: Response @@ -76169,8 +74930,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -76235,7 +74996,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *555 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -76243,7 +75004,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *555 '400': *14 '401': *25 '403': *29 @@ -76272,8 +75033,8 @@ paths: parameters: - *17 - *19 + - *455 - *456 - - *457 responses: '200': description: Response @@ -76337,8 +75098,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: + - *455 - *456 - - *457 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -76373,14 +75134,14 @@ paths: type: integer machines: type: array - items: &808 + items: &799 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *563 - required: *564 + properties: *556 + required: *557 examples: - default: &809 + default: &800 value: total_count: 2 machines: @@ -76420,8 +75181,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: + - *455 - *456 - - *457 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -76505,8 +75266,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: + - *455 - *456 - - *457 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -76572,8 +75333,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -76591,7 +75352,7 @@ paths: type: integer secrets: type: array - items: &568 + items: &561 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -76611,7 +75372,7 @@ paths: - created_at - updated_at examples: - default: *565 + default: *558 headers: Link: *43 x-github: @@ -76634,16 +75395,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: + - *455 - *456 - - *457 responses: '200': description: Response content: application/json: - schema: *566 + schema: *559 examples: - default: *567 + default: *560 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -76663,17 +75424,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: + - *455 - *456 - - *457 - *284 responses: '200': description: Response content: application/json: - schema: *568 + schema: *561 examples: - default: *569 + default: *562 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76693,8 +75454,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: + - *455 - *456 - - *457 - *284 requestBody: required: true @@ -76747,8 +75508,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: + - *455 - *456 - - *457 - *284 responses: '204': @@ -76777,8 +75538,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: + - *455 - *456 - - *457 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -76820,7 +75581,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &570 + properties: &563 login: type: string example: octocat @@ -76913,7 +75674,7 @@ paths: user_view_type: type: string example: public - required: &571 + required: &564 - avatar_url - events_url - followers_url @@ -76987,8 +75748,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: + - *455 - *456 - - *457 - *138 responses: '204': @@ -77035,8 +75796,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: + - *455 - *456 - - *457 - *138 requestBody: required: false @@ -77063,7 +75824,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &646 + schema: &639 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -77292,8 +76053,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: + - *455 - *456 - - *457 - *138 responses: '204': @@ -77325,8 +76086,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: + - *455 - *456 - - *457 - *138 responses: '200': @@ -77347,8 +76108,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *570 - required: *571 + properties: *563 + required: *564 nullable: true required: - permission @@ -77403,8 +76164,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -77414,7 +76175,7 @@ paths: application/json: schema: type: array - items: &572 + items: &565 title: Commit Comment description: Commit Comment type: object @@ -77472,7 +76233,7 @@ paths: - created_at - updated_at examples: - default: &575 + default: &568 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -77531,17 +76292,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: + - *455 - *456 - - *457 - *226 responses: '200': description: Response content: application/json: - schema: *572 + schema: *565 examples: - default: &576 + default: &569 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -77598,8 +76359,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: + - *455 - *456 - - *457 - *226 requestBody: required: true @@ -77622,7 +76383,7 @@ paths: description: Response content: application/json: - schema: *572 + schema: *565 examples: default: value: @@ -77673,8 +76434,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: + - *455 - *456 - - *457 - *226 responses: '204': @@ -77696,8 +76457,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: + - *455 - *456 - - *457 - *226 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -77724,9 +76485,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 '404': *6 @@ -77747,8 +76508,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: + - *455 - *456 - - *457 - *226 requestBody: required: true @@ -77781,16 +76542,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Reaction created content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '422': *15 x-github: githubCloudOnly: false @@ -77812,10 +76573,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: + - *455 - *456 - - *457 - *226 - - *448 + - *449 responses: '204': description: Response @@ -77864,8 +76625,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: + - *455 - *456 - - *457 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -77921,9 +76682,9 @@ paths: application/json: schema: type: array - items: *573 + items: *566 examples: - default: &699 + default: &692 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -78017,9 +76778,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: + - *455 - *456 - - *457 - - &574 + - &567 name: commit_sha description: The SHA of the commit. in: path @@ -78091,9 +76852,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: + - *455 - *456 - - *457 - - *574 + - *567 - *17 - *19 responses: @@ -78103,9 +76864,9 @@ paths: application/json: schema: type: array - items: *572 + items: *565 examples: - default: *575 + default: *568 headers: Link: *43 x-github: @@ -78133,9 +76894,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: + - *455 - *456 - - *457 - - *574 + - *567 requestBody: required: true content: @@ -78170,9 +76931,9 @@ paths: description: Response content: application/json: - schema: *572 + schema: *565 examples: - default: *576 + default: *569 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -78200,9 +76961,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: + - *455 - *456 - - *457 - - *574 + - *567 - *17 - *19 responses: @@ -78212,9 +76973,9 @@ paths: application/json: schema: type: array - items: *577 + items: *570 examples: - default: &691 + default: &684 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -78751,11 +77512,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: + - *455 - *456 - - *457 - *19 - *17 - - &578 + - &571 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -78770,9 +77531,9 @@ paths: description: Response content: application/json: - schema: *573 + schema: *566 examples: - default: &676 + default: &669 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -78885,11 +77646,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-for-a-git-reference parameters: + - *455 - *456 - - *457 - - *578 - - *579 - - *580 + - *571 + - *572 + - *573 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -78923,9 +77684,9 @@ paths: type: integer check_runs: type: array - items: *525 + items: *518 examples: - default: *581 + default: *574 headers: Link: *43 x-github: @@ -78950,9 +77711,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#list-check-suites-for-a-git-reference parameters: + - *455 - *456 - - *457 - - *578 + - *571 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -78960,7 +77721,7 @@ paths: schema: type: integer example: 1 - - *579 + - *572 - *17 - *19 responses: @@ -78978,7 +77739,7 @@ paths: type: integer check_suites: type: array - items: *530 + items: *523 examples: default: value: @@ -79178,9 +77939,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: + - *455 - *456 - - *457 - - *578 + - *571 - *17 - *19 responses: @@ -79378,9 +78139,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: + - *455 - *456 - - *457 - - *578 + - *571 - *17 - *19 responses: @@ -79390,7 +78151,7 @@ paths: application/json: schema: type: array - items: &753 + items: &746 title: Status description: The status of a commit. type: object @@ -79471,7 +78232,7 @@ paths: site_admin: false headers: Link: *43 - '301': *468 + '301': *461 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79499,8 +78260,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -79529,20 +78290,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *582 - required: *583 + properties: *575 + required: *576 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &584 + properties: &577 url: type: string format: uri html_url: type: string format: uri - required: &585 + required: &578 - url - html_url nullable: true @@ -79556,26 +78317,26 @@ paths: contributing: title: Community Health File type: object - properties: *584 - required: *585 + properties: *577 + required: *578 nullable: true readme: title: Community Health File type: object - properties: *584 - required: *585 + properties: *577 + required: *578 nullable: true issue_template: title: Community Health File type: object - properties: *584 - required: *585 + properties: *577 + required: *578 nullable: true pull_request_template: title: Community Health File type: object - properties: *584 - required: *585 + properties: *577 + required: *578 nullable: true required: - code_of_conduct @@ -79702,8 +78463,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: + - *455 - *456 - - *457 - *19 - *17 - name: basehead @@ -79746,8 +78507,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *573 - merge_base_commit: *573 + base_commit: *566 + merge_base_commit: *566 status: type: string enum: @@ -79767,10 +78528,10 @@ paths: example: 6 commits: type: array - items: *573 + items: *566 files: type: array - items: *586 + items: *579 required: - url - html_url @@ -80056,8 +78817,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: + - *455 - *456 - - *457 - name: path description: path parameter in: path @@ -80200,7 +78961,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &587 + response-if-content-is-a-file: &580 summary: Response if content is a file value: type: file @@ -80332,7 +79093,7 @@ paths: - size - type - url - - &704 + - &697 title: Content File description: Content File type: object @@ -80533,7 +79294,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *587 + response-if-content-is-a-file: *580 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -80602,7 +79363,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *588 + '302': *581 '304': *37 x-github: githubCloudOnly: false @@ -80625,8 +79386,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: + - *455 - *456 - - *457 - name: path description: path parameter in: path @@ -80719,7 +79480,7 @@ paths: description: Response content: application/json: - schema: &589 + schema: &582 title: File Commit description: File Commit type: object @@ -80871,7 +79632,7 @@ paths: description: Response content: application/json: - schema: *589 + schema: *582 examples: example-for-creating-a-file: value: @@ -80925,7 +79686,7 @@ paths: schema: oneOf: - *3 - - &628 + - &621 description: Repository rule violation was detected type: object properties: @@ -80946,7 +79707,7 @@ paths: items: type: object properties: - placeholder_id: &745 + placeholder_id: &738 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -80978,8 +79739,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: + - *455 - *456 - - *457 - name: path description: path parameter in: path @@ -81040,7 +79801,7 @@ paths: description: Response content: application/json: - schema: *589 + schema: *582 examples: default: value: @@ -81095,8 +79856,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: + - *455 - *456 - - *457 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -81219,8 +79980,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: + - *455 - *456 - - *457 - *323 - *324 - *325 @@ -81232,7 +79993,7 @@ paths: schema: type: string - *327 - - *590 + - *583 - *328 - *329 - *106 @@ -81253,7 +80014,7 @@ paths: application/json: schema: type: array - items: &593 + items: &586 type: object description: A Dependabot alert. properties: @@ -81299,7 +80060,7 @@ paths: - unknown - direct - transitive - security_advisory: *591 + security_advisory: *584 security_vulnerability: *127 url: *128 html_url: *129 @@ -81330,7 +80091,7 @@ paths: nullable: true maxLength: 280 fixed_at: *133 - auto_dismissed_at: *592 + auto_dismissed_at: *585 required: - number - state @@ -81560,9 +80321,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: + - *455 - *456 - - *457 - - &594 + - &587 name: alert_number in: path description: |- @@ -81577,7 +80338,7 @@ paths: description: Response content: application/json: - schema: *593 + schema: *586 examples: default: value: @@ -81690,9 +80451,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: + - *455 - *456 - - *457 - - *594 + - *587 requestBody: required: true content: @@ -81737,7 +80498,7 @@ paths: description: Response content: application/json: - schema: *593 + schema: *586 examples: default: value: @@ -81866,8 +80627,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -81885,7 +80646,7 @@ paths: type: integer secrets: type: array - items: &597 + items: &590 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -81938,16 +80699,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: + - *455 - *456 - - *457 responses: '200': description: Response content: application/json: - schema: *595 + schema: *588 examples: - default: *596 + default: *589 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81967,15 +80728,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: + - *455 - *456 - - *457 - *284 responses: '200': description: Response content: application/json: - schema: *597 + schema: *590 examples: default: value: @@ -82001,8 +80762,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: + - *455 - *456 - - *457 - *284 requestBody: required: true @@ -82055,8 +80816,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: + - *455 - *456 - - *457 - *284 responses: '204': @@ -82079,8 +80840,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: + - *455 - *456 - - *457 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -82240,8 +81001,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -82480,8 +81241,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -82556,7 +81317,7 @@ paths: - version - url additionalProperties: false - metadata: &598 + metadata: &591 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -82589,7 +81350,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *598 + metadata: *591 resolved: type: object description: A collection of resolved package dependencies. @@ -82602,7 +81363,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *598 + metadata: *591 relationship: type: string description: A notation of whether a dependency is requested @@ -82731,8 +81492,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: + - *455 - *456 - - *457 - name: sha description: The SHA recorded at creation time. in: query @@ -82772,9 +81533,9 @@ paths: application/json: schema: type: array - items: *599 + items: *592 examples: - default: *600 + default: *593 headers: Link: *43 x-github: @@ -82840,8 +81601,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -82922,7 +81683,7 @@ paths: description: Response content: application/json: - schema: *599 + schema: *592 examples: simple-example: summary: Simple example @@ -82995,9 +81756,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: + - *455 - *456 - - *457 - - &601 + - &594 name: deployment_id description: deployment_id parameter in: path @@ -83009,7 +81770,7 @@ paths: description: Response content: application/json: - schema: *599 + schema: *592 examples: default: value: @@ -83074,9 +81835,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: + - *455 - *456 - - *457 - - *601 + - *594 responses: '204': description: Response @@ -83098,9 +81859,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: + - *455 - *456 - - *457 - - *601 + - *594 - *17 - *19 responses: @@ -83110,7 +81871,7 @@ paths: application/json: schema: type: array - items: &602 + items: &595 title: Deployment Status description: The status of a deployment. type: object @@ -83271,9 +82032,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: + - *455 - *456 - - *457 - - *601 + - *594 requestBody: required: true content: @@ -83348,9 +82109,9 @@ paths: description: Response content: application/json: - schema: *602 + schema: *595 examples: - default: &603 + default: &596 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -83406,9 +82167,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: + - *455 - *456 - - *457 - - *601 + - *594 - name: status_id in: path required: true @@ -83419,9 +82180,9 @@ paths: description: Response content: application/json: - schema: *602 + schema: *595 examples: - default: *603 + default: *596 '404': *6 x-github: githubCloudOnly: false @@ -83448,12 +82209,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: + - *455 - *456 - - *457 - - *604 - - *605 - - *606 - - *607 + - *597 + - *598 + - *599 + - *600 - *17 - *19 responses: @@ -83463,9 +82224,9 @@ paths: application/json: schema: type: array - items: *608 + items: *601 examples: - default: *609 + default: *602 '404': *6 '403': *29 '500': *40 @@ -83489,8 +82250,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: + - *455 - *456 - - *457 - name: alert_number in: path required: true @@ -83502,7 +82263,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *608 + schema: *601 examples: default: value: @@ -83558,8 +82319,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: + - *455 - *456 - - *457 - name: alert_number in: path required: true @@ -83618,12 +82379,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: + - *455 - *456 - - *457 - *99 - *100 - *101 - - *610 + - *603 - *17 - *19 responses: @@ -83633,9 +82394,9 @@ paths: application/json: schema: type: array - items: *611 + items: *604 examples: - default: *612 + default: *605 '404': *6 '403': *29 '500': *40 @@ -83660,8 +82421,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: + - *455 - *456 - - *457 - name: alert_number in: path required: true @@ -83673,7 +82434,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *611 + schema: *604 examples: default: value: @@ -83731,8 +82492,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: + - *455 - *456 - - *457 - name: alert_number in: path required: true @@ -83801,8 +82562,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -83859,8 +82620,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -83877,7 +82638,7 @@ paths: type: integer environments: type: array - items: &614 + items: &607 title: Environment description: Details of a deployment environment type: object @@ -83929,7 +82690,7 @@ paths: type: type: string example: wait_timer - wait_timer: &616 + wait_timer: &609 type: integer example: 30 description: The amount of time to delay a job after @@ -83966,7 +82727,7 @@ paths: items: type: object properties: - type: *613 + type: *606 reviewer: anyOf: - *4 @@ -83990,7 +82751,7 @@ paths: - id - node_id - type - deployment_branch_policy: &617 + deployment_branch_policy: &610 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -84106,9 +82867,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: + - *455 - *456 - - *457 - - &615 + - &608 name: environment_name in: path required: true @@ -84121,9 +82882,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *607 examples: - default: &618 + default: &611 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -84207,9 +82968,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: + - *455 - *456 - - *457 - - *615 + - *608 requestBody: required: false content: @@ -84218,7 +82979,7 @@ paths: type: object nullable: true properties: - wait_timer: *616 + wait_timer: *609 prevent_self_review: type: boolean example: false @@ -84235,13 +82996,13 @@ paths: items: type: object properties: - type: *613 + type: *606 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *617 + deployment_branch_policy: *610 additionalProperties: false examples: default: @@ -84261,9 +83022,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *607 examples: - default: *618 + default: *611 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -84287,9 +83048,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: + - *455 - *456 - - *457 - - *615 + - *608 responses: '204': description: Default response @@ -84314,9 +83075,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: + - *455 - *456 - - *457 - - *615 + - *608 - *17 - *19 responses: @@ -84334,7 +83095,7 @@ paths: example: 2 branch_policies: type: array - items: &619 + items: &612 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -84391,9 +83152,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: + - *455 - *456 - - *457 - - *615 + - *608 requestBody: required: true content: @@ -84439,9 +83200,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *612 examples: - example-wildcard: &620 + example-wildcard: &613 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -84483,10 +83244,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: + - *455 - *456 - - *457 - - *615 - - &621 + - *608 + - &614 name: branch_policy_id in: path required: true @@ -84498,9 +83259,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *612 examples: - default: *620 + default: *613 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84519,10 +83280,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: + - *455 - *456 - - *457 - - *615 - - *621 + - *608 + - *614 requestBody: required: true content: @@ -84550,9 +83311,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *612 examples: - default: *620 + default: *613 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84571,10 +83332,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: + - *455 - *456 - - *457 - - *615 - - *621 + - *608 + - *614 responses: '204': description: Response @@ -84599,9 +83360,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *615 - - *457 + - *608 - *456 + - *455 responses: '200': description: List of deployment protection rules @@ -84617,7 +83378,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &622 + items: &615 title: Deployment protection rule description: Deployment protection rule type: object @@ -84636,7 +83397,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &623 + app: &616 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -84735,9 +83496,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *615 - - *457 + - *608 - *456 + - *455 requestBody: content: application/json: @@ -84758,9 +83519,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *622 + schema: *615 examples: - default: &624 + default: &617 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -84795,9 +83556,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *615 - - *457 + - *608 - *456 + - *455 - *19 - *17 responses: @@ -84816,7 +83577,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *623 + items: *616 examples: default: value: @@ -84851,10 +83612,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: + - *455 - *456 - - *457 - - *615 - - &625 + - *608 + - &618 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -84866,9 +83627,9 @@ paths: description: Response content: application/json: - schema: *622 + schema: *615 examples: - default: *624 + default: *617 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84889,10 +83650,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *615 - - *457 + - *608 - *456 - - *625 + - *455 + - *618 responses: '204': description: Response @@ -84918,9 +83679,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: + - *455 - *456 - - *457 - - *615 + - *608 - *17 - *19 responses: @@ -84938,9 +83699,9 @@ paths: type: integer secrets: type: array - items: *491 + items: *484 examples: - default: *492 + default: *485 headers: Link: *43 x-github: @@ -84965,17 +83726,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: + - *455 - *456 - - *457 - - *615 + - *608 responses: '200': description: Response content: application/json: - schema: *493 + schema: *486 examples: - default: *494 + default: *487 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84997,18 +83758,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: + - *455 - *456 - - *457 - - *615 + - *608 - *284 responses: '200': description: Response content: application/json: - schema: *491 + schema: *484 examples: - default: *626 + default: *619 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85030,9 +83791,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: + - *455 - *456 - - *457 - - *615 + - *608 - *284 requestBody: required: true @@ -85090,9 +83851,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: + - *455 - *456 - - *457 - - *615 + - *608 - *284 responses: '204': @@ -85118,10 +83879,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: + - *455 - *456 - - *457 - - *615 - - *478 + - *608 + - *471 - *19 responses: '200': @@ -85138,9 +83899,9 @@ paths: type: integer variables: type: array - items: *495 + items: *488 examples: - default: *496 + default: *489 headers: Link: *43 x-github: @@ -85163,9 +83924,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: + - *455 - *456 - - *457 - - *615 + - *608 requestBody: required: true content: @@ -85217,18 +83978,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: + - *455 - *456 - - *457 - - *615 + - *608 - *287 responses: '200': description: Response content: application/json: - schema: *495 + schema: *488 examples: - default: *627 + default: *620 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85249,10 +84010,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: + - *455 - *456 - - *457 - *287 - - *615 + - *608 requestBody: required: true content: @@ -85294,10 +84055,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: + - *455 - *456 - - *457 - *287 - - *615 + - *608 responses: '204': description: Response @@ -85319,8 +84080,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -85388,8 +84149,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: + - *455 - *456 - - *457 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -85548,8 +84309,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: + - *455 - *456 - - *457 requestBody: required: false content: @@ -85581,9 +84342,9 @@ paths: description: Response content: application/json: - schema: *467 + schema: *460 examples: - default: *469 + default: *462 '400': *14 '422': *15 '403': *29 @@ -85604,8 +84365,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -85665,7 +84426,7 @@ paths: schema: oneOf: - *249 - - *628 + - *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85690,8 +84451,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: + - *455 - *456 - - *457 - name: file_sha in: path required: true @@ -85790,8 +84551,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -85900,7 +84661,7 @@ paths: description: Response content: application/json: - schema: &629 + schema: &622 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -86114,15 +84875,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: + - *455 - *456 - - *457 - - *574 + - *567 responses: '200': description: Response content: application/json: - schema: *629 + schema: *622 examples: default: value: @@ -86178,9 +84939,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: + - *455 - *456 - - *457 - - &630 + - &623 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -86197,7 +84958,7 @@ paths: application/json: schema: type: array - items: &631 + items: &624 title: Git Reference description: Git references within a repository type: object @@ -86272,17 +85033,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: + - *455 - *456 - - *457 - - *630 + - *623 responses: '200': description: Response content: application/json: - schema: *631 + schema: *624 examples: - default: &632 + default: &625 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -86311,8 +85072,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -86341,9 +85102,9 @@ paths: description: Response content: application/json: - schema: *631 + schema: *624 examples: - default: *632 + default: *625 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -86369,9 +85130,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: + - *455 - *456 - - *457 - - *630 + - *623 requestBody: required: true content: @@ -86400,9 +85161,9 @@ paths: description: Response content: application/json: - schema: *631 + schema: *624 examples: - default: *632 + default: *625 '422': *15 '409': *114 x-github: @@ -86420,9 +85181,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: + - *455 - *456 - - *457 - - *630 + - *623 responses: '204': description: Response @@ -86477,8 +85238,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -86545,7 +85306,7 @@ paths: description: Response content: application/json: - schema: &634 + schema: &627 title: Git Tag description: Metadata for a Git tag type: object @@ -86596,7 +85357,7 @@ paths: - sha - type - url - verification: *633 + verification: *626 required: - sha - url @@ -86606,7 +85367,7 @@ paths: - tag - message examples: - default: &635 + default: &628 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -86679,8 +85440,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: + - *455 - *456 - - *457 - name: tag_sha in: path required: true @@ -86691,9 +85452,9 @@ paths: description: Response content: application/json: - schema: *634 + schema: *627 examples: - default: *635 + default: *628 '404': *6 '409': *114 x-github: @@ -86717,8 +85478,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -86791,7 +85552,7 @@ paths: description: Response content: application/json: - schema: &636 + schema: &629 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -86887,8 +85648,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: + - *455 - *456 - - *457 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -86911,7 +85672,7 @@ paths: description: Response content: application/json: - schema: *636 + schema: *629 examples: default-response: summary: Default response @@ -86970,8 +85731,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -86981,7 +85742,7 @@ paths: application/json: schema: type: array - items: &637 + items: &630 title: Webhook description: Webhooks for repositories. type: object @@ -87035,7 +85796,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &890 + last_response: &881 title: Hook Response type: object properties: @@ -87109,8 +85870,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: + - *455 - *456 - - *457 requestBody: required: false content: @@ -87162,9 +85923,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *630 examples: - default: &638 + default: &631 value: type: Repository id: 12345678 @@ -87212,17 +85973,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: + - *455 - *456 - - *457 - *337 responses: '200': description: Response content: application/json: - schema: *637 + schema: *630 examples: - default: *638 + default: *631 '404': *6 x-github: githubCloudOnly: false @@ -87242,8 +86003,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: + - *455 - *456 - - *457 - *337 requestBody: required: true @@ -87289,9 +86050,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *630 examples: - default: *638 + default: *631 '422': *15 '404': *6 x-github: @@ -87312,8 +86073,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: + - *455 - *456 - - *457 - *337 responses: '204': @@ -87338,8 +86099,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: + - *455 - *456 - - *457 - *337 responses: '200': @@ -87367,8 +86128,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: + - *455 - *456 - - *457 - *337 requestBody: required: false @@ -87413,8 +86174,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: + - *455 - *456 - - *457 - *337 - *17 - *338 @@ -87446,8 +86207,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: + - *455 - *456 - - *457 - *337 - *16 responses: @@ -87476,8 +86237,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: + - *455 - *456 - - *457 - *337 - *16 responses: @@ -87501,8 +86262,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: + - *455 - *456 - - *457 - *337 responses: '204': @@ -87528,8 +86289,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: + - *455 - *456 - - *457 - *337 responses: '204': @@ -87553,8 +86314,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response if immutable releases are enabled @@ -87600,8 +86361,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: + - *455 - *456 - - *457 responses: '204': *150 '409': *114 @@ -87621,8 +86382,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: + - *455 - *456 - - *457 responses: '204': *150 '409': *114 @@ -87679,14 +86440,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: + - *455 - *456 - - *457 responses: '200': description: Response content: application/json: - schema: &639 + schema: &632 title: Import description: A repository import from an external source. type: object @@ -87785,7 +86546,7 @@ paths: - html_url - authors_url examples: - default: &642 + default: &635 value: vcs: subversion use_lfs: true @@ -87801,7 +86562,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &640 + '503': &633 description: Unavailable due to service under maintenance. content: application/json: @@ -87830,8 +86591,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -87879,7 +86640,7 @@ paths: description: Response content: application/json: - schema: *639 + schema: *632 examples: default: value: @@ -87904,7 +86665,7 @@ paths: type: string '422': *15 '404': *6 - '503': *640 + '503': *633 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87932,8 +86693,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: + - *455 - *456 - - *457 requestBody: required: false content: @@ -87982,7 +86743,7 @@ paths: description: Response content: application/json: - schema: *639 + schema: *632 examples: example-1: summary: Example 1 @@ -88030,7 +86791,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *640 + '503': *633 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88053,12 +86814,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: + - *455 - *456 - - *457 responses: '204': description: Response - '503': *640 + '503': *633 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88084,9 +86845,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: + - *455 - *456 - - *457 - - &830 + - &821 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -88100,7 +86861,7 @@ paths: application/json: schema: type: array - items: &641 + items: &634 title: Porter Author description: Porter Author type: object @@ -88154,7 +86915,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *640 + '503': *633 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88179,8 +86940,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: + - *455 - *456 - - *457 - name: author_id in: path required: true @@ -88210,7 +86971,7 @@ paths: description: Response content: application/json: - schema: *641 + schema: *634 examples: default: value: @@ -88223,7 +86984,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *640 + '503': *633 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88247,8 +87008,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -88289,7 +87050,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *640 + '503': *633 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88317,8 +87078,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -88345,11 +87106,11 @@ paths: description: Response content: application/json: - schema: *639 + schema: *632 examples: - default: *642 + default: *635 '422': *15 - '503': *640 + '503': *633 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88372,8 +87133,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -88381,8 +87142,8 @@ paths: application/json: schema: *22 examples: - default: *643 - '301': *468 + default: *636 + '301': *461 '404': *6 x-github: githubCloudOnly: false @@ -88402,8 +87163,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -88416,7 +87177,7 @@ paths: properties: {} additionalProperties: false examples: - default: &645 + default: &638 value: limit: collaborators_only origin: repository @@ -88441,13 +87202,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: application/json: - schema: *644 + schema: *637 examples: default: summary: Example request body @@ -88461,7 +87222,7 @@ paths: application/json: schema: *355 examples: - default: *645 + default: *638 '409': description: Response x-github: @@ -88483,8 +87244,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -88507,8 +87268,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -88518,9 +87279,9 @@ paths: application/json: schema: type: array - items: *646 + items: *639 examples: - default: &823 + default: &814 value: - id: 1 repository: @@ -88651,8 +87412,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: + - *455 - *456 - - *457 - *359 requestBody: required: false @@ -88682,7 +87443,7 @@ paths: description: Response content: application/json: - schema: *646 + schema: *639 examples: default: value: @@ -88813,8 +87574,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: + - *455 - *456 - - *457 - *359 responses: '204': @@ -88846,8 +87607,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: + - *455 - *456 - - *457 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -88920,7 +87681,7 @@ paths: type: array items: *227 examples: - default: &656 + default: &649 value: - id: 1 node_id: MDU6SXNzdWUx @@ -89068,7 +87829,7 @@ paths: state_reason: completed headers: Link: *43 - '301': *468 + '301': *461 '422': *15 '404': *6 x-github: @@ -89097,8 +87858,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -89182,7 +87943,7 @@ paths: application/json: schema: *227 examples: - default: &653 + default: &646 value: id: 1 node_id: MDU6SXNzdWUx @@ -89338,7 +88099,7 @@ paths: '422': *15 '503': *190 '404': *6 - '410': *647 + '410': *640 x-github: triggersNotification: true githubCloudOnly: false @@ -89366,8 +88127,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: + - *455 - *456 - - *457 - *237 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -89388,9 +88149,9 @@ paths: application/json: schema: type: array - items: *648 + items: *641 examples: - default: &655 + default: &648 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -89448,17 +88209,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: + - *455 - *456 - - *457 - *226 responses: '200': description: Response content: application/json: - schema: *648 + schema: *641 examples: - default: &649 + default: &642 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -89512,8 +88273,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: + - *455 - *456 - - *457 - *226 requestBody: required: true @@ -89536,9 +88297,9 @@ paths: description: Response content: application/json: - schema: *648 + schema: *641 examples: - default: *649 + default: *642 '422': *15 x-github: githubCloudOnly: false @@ -89556,8 +88317,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: + - *455 - *456 - - *457 - *226 responses: '204': @@ -89578,8 +88339,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: + - *455 - *456 - - *457 - *226 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -89606,9 +88367,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 '404': *6 @@ -89629,8 +88390,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: + - *455 - *456 - - *457 - *226 requestBody: required: true @@ -89663,16 +88424,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Reaction created content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '422': *15 x-github: githubCloudOnly: false @@ -89694,10 +88455,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: + - *455 - *456 - - *457 - *226 - - *448 + - *449 responses: '204': description: Response @@ -89717,8 +88478,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -89728,7 +88489,7 @@ paths: application/json: schema: type: array - items: &652 + items: &645 title: Issue Event description: Issue Event type: object @@ -89771,8 +88532,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *650 - required: *651 + properties: *643 + required: *644 nullable: true label: title: Issue Event Label @@ -90079,8 +88840,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: + - *455 - *456 - - *457 - name: event_id in: path required: true @@ -90091,7 +88852,7 @@ paths: description: Response content: application/json: - schema: *652 + schema: *645 examples: default: value: @@ -90284,7 +89045,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *647 + '410': *640 '403': *29 x-github: githubCloudOnly: false @@ -90318,9 +89079,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: + - *455 - *456 - - *457 - - &654 + - &647 name: issue_number description: The number that identifies the issue. in: path @@ -90334,10 +89095,10 @@ paths: application/json: schema: *227 examples: - default: *653 - '301': *468 + default: *646 + '301': *461 '404': *6 - '410': *647 + '410': *640 '304': *37 x-github: githubCloudOnly: false @@ -90362,9 +89123,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: false content: @@ -90470,13 +89231,13 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *646 '422': *15 '503': *190 '403': *29 - '301': *468 + '301': *461 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90494,9 +89255,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: false content: @@ -90524,7 +89285,7 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *646 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90540,9 +89301,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: content: application/json: @@ -90569,7 +89330,7 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *646 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90591,9 +89352,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 - name: assignee in: path required: true @@ -90633,9 +89394,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: + - *455 - *456 - - *457 - - *654 + - *647 - *217 - *17 - *19 @@ -90646,13 +89407,13 @@ paths: application/json: schema: type: array - items: *648 + items: *641 examples: - default: *655 + default: *648 headers: Link: *43 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90681,9 +89442,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: true content: @@ -90705,16 +89466,16 @@ paths: description: Response content: application/json: - schema: *648 + schema: *641 examples: - default: *649 + default: *642 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *647 + '410': *640 '422': *15 '404': *6 x-github: @@ -90742,9 +89503,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: + - *455 - *456 - - *457 - - *654 + - *647 - *17 - *19 responses: @@ -90756,12 +89517,12 @@ paths: type: array items: *227 examples: - default: *656 + default: *649 headers: Link: *43 - '301': *468 + '301': *461 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90789,9 +89550,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: true content: @@ -90815,15 +89576,15 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *646 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *468 + '301': *461 '403': *29 - '410': *647 + '410': *640 '422': *15 '404': *6 x-github: @@ -90854,9 +89615,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: + - *455 - *456 - - *457 - - *654 + - *647 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -90870,13 +89631,13 @@ paths: application/json: schema: *227 examples: - default: *653 - '301': *468 + default: *646 + '301': *461 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *647 + '410': *640 x-github: triggersNotification: true githubCloudOnly: false @@ -90902,9 +89663,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: + - *455 - *456 - - *457 - - *654 + - *647 - *17 - *19 responses: @@ -90916,12 +89677,12 @@ paths: type: array items: *227 examples: - default: *656 + default: *649 headers: Link: *43 - '301': *468 + '301': *461 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90938,9 +89699,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: + - *455 - *456 - - *457 - - *654 + - *647 - *17 - *19 responses: @@ -90954,7 +89715,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &659 + - &652 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -91008,7 +89769,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &660 + - &653 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -91144,7 +89905,7 @@ paths: - performed_via_github_app - assignee - assigner - - &661 + - &654 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -91195,7 +89956,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &662 + - &655 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -91246,7 +90007,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &663 + - &656 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -91300,7 +90061,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &664 + - &657 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -91347,7 +90108,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &665 + - &658 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -91394,7 +90155,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &666 + - &659 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -91454,7 +90215,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &667 + - &660 title: Locked Issue Event description: Locked Issue Event type: object @@ -91502,7 +90263,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &668 + - &661 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -91568,7 +90329,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &669 + - &662 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -91634,7 +90395,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &670 + - &663 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -91700,7 +90461,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &671 + - &664 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -91791,7 +90552,7 @@ paths: color: red headers: Link: *43 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91808,9 +90569,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 - *17 - *19 responses: @@ -91820,7 +90581,7 @@ paths: application/json: schema: type: array - items: &657 + items: &650 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -91867,7 +90628,7 @@ paths: - color - default examples: - default: &658 + default: &651 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -91885,9 +90646,9 @@ paths: default: false headers: Link: *43 - '301': *468 + '301': *461 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91904,9 +90665,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: false content: @@ -91965,12 +90726,12 @@ paths: application/json: schema: type: array - items: *657 + items: *650 examples: - default: *658 - '301': *468 + default: *651 + '301': *461 '404': *6 - '410': *647 + '410': *640 '422': *15 x-github: githubCloudOnly: false @@ -91987,9 +90748,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: false content: @@ -92049,12 +90810,12 @@ paths: application/json: schema: type: array - items: *657 + items: *650 examples: - default: *658 - '301': *468 + default: *651 + '301': *461 '404': *6 - '410': *647 + '410': *640 '422': *15 x-github: githubCloudOnly: false @@ -92071,15 +90832,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 responses: '204': description: Response - '301': *468 + '301': *461 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92098,9 +90859,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 - name: name in: path required: true @@ -92113,7 +90874,7 @@ paths: application/json: schema: type: array - items: *657 + items: *650 examples: default: value: @@ -92124,9 +90885,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *468 + '301': *461 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92146,9 +90907,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: false content: @@ -92176,7 +90937,7 @@ paths: '204': description: Response '403': *29 - '410': *647 + '410': *640 '404': *6 '422': *15 x-github: @@ -92194,9 +90955,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 responses: '204': description: Response @@ -92226,9 +90987,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 responses: '200': description: Response @@ -92236,10 +90997,10 @@ paths: application/json: schema: *227 examples: - default: *653 - '301': *468 + default: *646 + '301': *461 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92256,9 +91017,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -92284,13 +91045,13 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92308,9 +91069,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: true content: @@ -92342,16 +91103,16 @@ paths: description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '422': *15 x-github: githubCloudOnly: false @@ -92373,10 +91134,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: + - *455 - *456 - - *457 - - *654 - - *448 + - *647 + - *449 responses: '204': description: Response @@ -92405,9 +91166,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: true content: @@ -92431,7 +91192,7 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *646 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -92464,9 +91225,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: + - *455 - *456 - - *457 - - *654 + - *647 - *17 - *19 responses: @@ -92478,11 +91239,11 @@ paths: type: array items: *227 examples: - default: *656 + default: *649 headers: Link: *43 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92510,9 +91271,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: true content: @@ -92541,14 +91302,14 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *646 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *647 + '410': *640 '422': *15 '404': *6 x-github: @@ -92568,9 +91329,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: true content: @@ -92603,7 +91364,7 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *646 '403': *29 '404': *6 '422': *7 @@ -92625,9 +91386,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 - *17 - *19 responses: @@ -92642,19 +91403,19 @@ paths: description: Timeline Event type: object anyOf: + - *652 + - *653 + - *654 + - *655 + - *656 + - *657 + - *658 - *659 - *660 - *661 - *662 - *663 - *664 - - *665 - - *666 - - *667 - - *668 - - *669 - - *670 - - *671 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -92963,7 +91724,7 @@ paths: type: string comments: type: array - items: &693 + items: &686 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -93172,7 +91933,7 @@ paths: type: string comments: type: array - items: *572 + items: *565 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -93461,7 +92222,7 @@ paths: headers: Link: *43 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93478,8 +92239,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -93489,7 +92250,7 @@ paths: application/json: schema: type: array - items: &672 + items: &665 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -93555,8 +92316,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -93592,9 +92353,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *665 examples: - default: &673 + default: &666 value: id: 1 key: ssh-rsa AAA... @@ -93628,9 +92389,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: + - *455 - *456 - - *457 - - &674 + - &667 name: key_id description: The unique identifier of the key. in: path @@ -93642,9 +92403,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *665 examples: - default: *673 + default: *666 '404': *6 x-github: githubCloudOnly: false @@ -93662,9 +92423,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: + - *455 - *456 - - *457 - - *674 + - *667 responses: '204': description: Response @@ -93684,8 +92445,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -93695,9 +92456,9 @@ paths: application/json: schema: type: array - items: *657 + items: *650 examples: - default: *658 + default: *651 headers: Link: *43 '404': *6 @@ -93718,8 +92479,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -93755,9 +92516,9 @@ paths: description: Response content: application/json: - schema: *657 + schema: *650 examples: - default: &675 + default: &668 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -93789,8 +92550,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: + - *455 - *456 - - *457 - name: name in: path required: true @@ -93801,9 +92562,9 @@ paths: description: Response content: application/json: - schema: *657 + schema: *650 examples: - default: *675 + default: *668 '404': *6 x-github: githubCloudOnly: false @@ -93820,8 +92581,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: + - *455 - *456 - - *457 - name: name in: path required: true @@ -93860,7 +92621,7 @@ paths: description: Response content: application/json: - schema: *657 + schema: *650 examples: default: value: @@ -93886,8 +92647,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: + - *455 - *456 - - *457 - name: name in: path required: true @@ -93913,8 +92674,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -93950,8 +92711,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: + - *455 - *456 - - *457 responses: '202': *39 '403': @@ -93979,8 +92740,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -94006,9 +92767,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: + - *455 - *456 - - *457 - - *548 + - *541 responses: '200': description: Response @@ -94153,8 +92914,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -94219,8 +92980,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -94254,9 +93015,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *573 + schema: *566 examples: - default: *676 + default: *669 '204': description: Response when already merged '404': @@ -94281,8 +93042,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: + - *455 - *456 - - *457 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -94323,7 +93084,7 @@ paths: application/json: schema: type: array - items: &677 + items: &670 title: Milestone description: A collection of related issues and pull requests. type: object @@ -94384,8 +93145,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -94425,9 +93186,9 @@ paths: description: Response content: application/json: - schema: *677 + schema: *670 examples: - default: &678 + default: &671 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -94486,9 +93247,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: + - *455 - *456 - - *457 - - &679 + - &672 name: milestone_number description: The number that identifies the milestone. in: path @@ -94500,9 +93261,9 @@ paths: description: Response content: application/json: - schema: *677 + schema: *670 examples: - default: *678 + default: *671 '404': *6 x-github: githubCloudOnly: false @@ -94519,9 +93280,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: + - *455 - *456 - - *457 - - *679 + - *672 requestBody: required: false content: @@ -94559,9 +93320,9 @@ paths: description: Response content: application/json: - schema: *677 + schema: *670 examples: - default: *678 + default: *671 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94577,9 +93338,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: + - *455 - *456 - - *457 - - *679 + - *672 responses: '204': description: Response @@ -94600,9 +93361,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: + - *455 - *456 - - *457 - - *679 + - *672 - *17 - *19 responses: @@ -94612,9 +93373,9 @@ paths: application/json: schema: type: array - items: *657 + items: *650 examples: - default: *658 + default: *651 headers: Link: *43 x-github: @@ -94633,12 +93394,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: + - *455 - *456 - - *457 - - *680 - - *681 + - *673 + - *674 - *217 - - *682 + - *675 - *17 - *19 responses: @@ -94650,7 +93411,7 @@ paths: type: array items: *240 examples: - default: *683 + default: *676 headers: Link: *43 x-github: @@ -94674,8 +93435,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: + - *455 - *456 - - *457 requestBody: required: false content: @@ -94733,14 +93494,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: + - *455 - *456 - - *457 responses: '200': description: Response content: application/json: - schema: &684 + schema: &677 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -94865,7 +93626,7 @@ paths: - custom_404 - public examples: - default: &685 + default: &678 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -94906,8 +93667,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -94961,9 +93722,9 @@ paths: description: Response content: application/json: - schema: *684 + schema: *677 examples: - default: *685 + default: *678 '422': *15 '409': *114 x-github: @@ -94986,8 +93747,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#update-information-about-a-apiname-pages-site parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -95094,8 +93855,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -95121,8 +93882,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -95132,7 +93893,7 @@ paths: application/json: schema: type: array - items: &686 + items: &679 title: Page Build description: Page Build type: object @@ -95226,8 +93987,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: + - *455 - *456 - - *457 responses: '201': description: Response @@ -95272,16 +94033,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: + - *455 - *456 - - *457 responses: '200': description: Response content: application/json: - schema: *686 + schema: *679 examples: - default: &687 + default: &680 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -95329,8 +94090,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: + - *455 - *456 - - *457 - name: build_id in: path required: true @@ -95341,9 +94102,9 @@ paths: description: Response content: application/json: - schema: *686 + schema: *679 examples: - default: *687 + default: *680 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95363,8 +94124,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -95469,9 +94230,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: + - *455 - *456 - - *457 - - &688 + - &681 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -95529,9 +94290,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: + - *455 - *456 - - *457 - - *688 + - *681 responses: '204': *150 '404': *6 @@ -95558,8 +94319,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -95817,8 +94578,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Private vulnerability reporting status @@ -95855,8 +94616,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: + - *455 - *456 - - *457 responses: '204': *150 '422': *14 @@ -95877,8 +94638,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: + - *455 - *456 - - *457 responses: '204': *150 '422': *14 @@ -95900,8 +94661,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -95911,7 +94672,7 @@ paths: type: array items: *151 examples: - default: *689 + default: *682 '403': *29 '404': *6 x-github: @@ -95933,8 +94694,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -95950,7 +94711,7 @@ paths: required: - properties examples: - default: *690 + default: *683 responses: '204': description: No Content when custom property values are successfully created @@ -95988,8 +94749,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: + - *455 - *456 - - *457 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -96049,9 +94810,9 @@ paths: application/json: schema: type: array - items: *577 + items: *570 examples: - default: *691 + default: *684 headers: Link: *43 '304': *37 @@ -96083,8 +94844,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -96149,7 +94910,7 @@ paths: description: Response content: application/json: - schema: &695 + schema: &688 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -96306,7 +95067,7 @@ paths: nullable: true requested_teams: type: array - items: *429 + items: *430 nullable: true head: type: object @@ -96363,7 +95124,7 @@ paths: - review_comment - self author_association: *214 - auto_merge: *692 + auto_merge: *685 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -96455,7 +95216,7 @@ paths: - merged_by - review_comments examples: - default: &696 + default: &689 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -96982,8 +95743,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: + - *455 - *456 - - *457 - name: sort in: query required: false @@ -97012,9 +95773,9 @@ paths: application/json: schema: type: array - items: *693 + items: *686 examples: - default: &698 + default: &691 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -97091,17 +95852,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: + - *455 - *456 - - *457 - *226 responses: '200': description: Response content: application/json: - schema: *693 + schema: *686 examples: - default: &694 + default: &687 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -97176,8 +95937,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: + - *455 - *456 - - *457 - *226 requestBody: required: true @@ -97200,9 +95961,9 @@ paths: description: Response content: application/json: - schema: *693 + schema: *686 examples: - default: *694 + default: *687 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97218,8 +95979,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: + - *455 - *456 - - *457 - *226 responses: '204': @@ -97241,8 +96002,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: + - *455 - *456 - - *457 - *226 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -97269,9 +96030,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 '404': *6 @@ -97292,8 +96053,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: + - *455 - *456 - - *457 - *226 requestBody: required: true @@ -97326,16 +96087,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Reaction created content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '422': *15 x-github: githubCloudOnly: false @@ -97357,10 +96118,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: + - *455 - *456 - - *457 - *226 - - *448 + - *449 responses: '204': description: Response @@ -97403,9 +96164,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: + - *455 - *456 - - *457 - - &697 + - &690 name: pull_number description: The number that identifies the pull request. in: path @@ -97418,9 +96179,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *695 + schema: *688 examples: - default: *696 + default: *689 '304': *37 '404': *6 '406': @@ -97455,9 +96216,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 requestBody: required: false content: @@ -97499,9 +96260,9 @@ paths: description: Response content: application/json: - schema: *695 + schema: *688 examples: - default: *696 + default: *689 '422': *15 '403': *29 x-github: @@ -97523,9 +96284,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 requestBody: required: true content: @@ -97587,7 +96348,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *555 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -97595,7 +96356,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *555 '401': *25 '403': *29 '404': *6 @@ -97625,9 +96386,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 - *237 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -97648,9 +96409,9 @@ paths: application/json: schema: type: array - items: *693 + items: *686 examples: - default: *698 + default: *691 headers: Link: *43 x-github: @@ -97683,9 +96444,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 requestBody: required: true content: @@ -97790,7 +96551,7 @@ paths: description: Response content: application/json: - schema: *693 + schema: *686 examples: example-for-a-multi-line-comment: value: @@ -97878,9 +96639,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment parameters: + - *455 - *456 - - *457 - - *697 + - *690 - *226 requestBody: required: true @@ -97903,7 +96664,7 @@ paths: description: Response content: application/json: - schema: *693 + schema: *686 examples: default: value: @@ -97989,9 +96750,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 - *17 - *19 responses: @@ -98001,9 +96762,9 @@ paths: application/json: schema: type: array - items: *573 + items: *566 examples: - default: *699 + default: *692 headers: Link: *43 x-github: @@ -98033,9 +96794,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: + - *455 - *456 - - *457 - - *697 + - *690 - *17 - *19 responses: @@ -98045,7 +96806,7 @@ paths: application/json: schema: type: array - items: *586 + items: *579 examples: default: value: @@ -98083,9 +96844,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: + - *455 - *456 - - *457 - - *697 + - *690 responses: '204': description: Response if pull request has been merged @@ -98108,9 +96869,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 requestBody: required: false content: @@ -98221,9 +96982,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 responses: '200': description: Response @@ -98298,9 +97059,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 requestBody: required: false content: @@ -98337,7 +97098,7 @@ paths: description: Response content: application/json: - schema: *577 + schema: *570 examples: default: value: @@ -98873,9 +97634,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 requestBody: required: true content: @@ -98909,7 +97670,7 @@ paths: description: Response content: application/json: - schema: *577 + schema: *570 examples: default: value: @@ -99414,9 +98175,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 - *17 - *19 responses: @@ -99426,7 +98187,7 @@ paths: application/json: schema: type: array - items: &700 + items: &693 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -99577,9 +98338,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 requestBody: required: false content: @@ -99665,9 +98426,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *693 examples: - default: &702 + default: &695 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -99730,10 +98491,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 - - &701 + - *690 + - &694 name: review_id description: The unique identifier of the review. in: path @@ -99745,9 +98506,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *693 examples: - default: &703 + default: &696 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -99806,10 +98567,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 - - *701 + - *690 + - *694 requestBody: required: true content: @@ -99832,7 +98593,7 @@ paths: description: Response content: application/json: - schema: *700 + schema: *693 examples: default: value: @@ -99894,18 +98655,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 - - *701 + - *690 + - *694 responses: '200': description: Response content: application/json: - schema: *700 + schema: *693 examples: - default: *702 + default: *695 '422': *7 '404': *6 x-github: @@ -99932,10 +98693,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: + - *455 - *456 - - *457 - - *697 - - *701 + - *690 + - *694 - *17 - *19 responses: @@ -100170,10 +98931,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 - - *701 + - *690 + - *694 requestBody: required: true content: @@ -100201,7 +98962,7 @@ paths: description: Response content: application/json: - schema: *700 + schema: *693 examples: default: value: @@ -100264,10 +99025,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 - - *701 + - *690 + - *694 requestBody: required: true content: @@ -100302,9 +99063,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *693 examples: - default: *703 + default: *696 '404': *6 '422': *7 '403': *29 @@ -100326,9 +99087,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: + - *455 - *456 - - *457 - - *697 + - *690 requestBody: required: false content: @@ -100391,8 +99152,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: + - *455 - *456 - - *457 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -100405,9 +99166,9 @@ paths: description: Response content: application/json: - schema: *704 + schema: *697 examples: - default: &705 + default: &698 value: type: file encoding: base64 @@ -100449,8 +99210,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme-for-a-directory parameters: + - *455 - *456 - - *457 - name: dir description: The alternate path to look for a README file in: path @@ -100470,9 +99231,9 @@ paths: description: Response content: application/json: - schema: *704 + schema: *697 examples: - default: *705 + default: *698 '404': *6 '422': *15 x-github: @@ -100494,8 +99255,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -100505,7 +99266,7 @@ paths: application/json: schema: type: array - items: &706 + items: &699 title: Release description: A release. type: object @@ -100576,7 +99337,7 @@ paths: author: *4 assets: type: array - items: &707 + items: &700 title: Release Asset description: Data related to a release. type: object @@ -100763,8 +99524,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -100840,9 +99601,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *699 examples: - default: &710 + default: &703 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -100947,9 +99708,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: + - *455 - *456 - - *457 - - &708 + - &701 name: asset_id description: The unique identifier of the asset. in: path @@ -100961,9 +99722,9 @@ paths: description: Response content: application/json: - schema: *707 + schema: *700 examples: - default: &709 + default: &702 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -100998,7 +99759,7 @@ paths: type: User site_admin: false '404': *6 - '302': *588 + '302': *581 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101014,9 +99775,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: + - *455 - *456 - - *457 - - *708 + - *701 requestBody: required: false content: @@ -101044,9 +99805,9 @@ paths: description: Response content: application/json: - schema: *707 + schema: *700 examples: - default: *709 + default: *702 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101062,9 +99823,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: + - *455 - *456 - - *457 - - *708 + - *701 responses: '204': description: Response @@ -101088,8 +99849,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#generate-release-notes-content-for-a-release parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -101174,16 +99935,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: + - *455 - *456 - - *457 responses: '200': description: Response content: application/json: - schema: *706 + schema: *699 examples: - default: *710 + default: *703 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101200,8 +99961,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: + - *455 - *456 - - *457 - name: tag description: tag parameter in: path @@ -101214,9 +99975,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *699 examples: - default: *710 + default: *703 '404': *6 x-github: githubCloudOnly: false @@ -101238,9 +99999,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: + - *455 - *456 - - *457 - - &711 + - &704 name: release_id description: The unique identifier of the release. in: path @@ -101254,9 +100015,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *706 + schema: *699 examples: - default: *710 + default: *703 '401': description: Unauthorized x-github: @@ -101274,9 +100035,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: + - *455 - *456 - - *457 - - *711 + - *704 requestBody: required: false content: @@ -101340,9 +100101,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *699 examples: - default: *710 + default: *703 '404': description: Not Found if the discussion category name is invalid content: @@ -101363,9 +100124,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: + - *455 - *456 - - *457 - - *711 + - *704 responses: '204': description: Response @@ -101385,9 +100146,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: + - *455 - *456 - - *457 - - *711 + - *704 - *17 - *19 responses: @@ -101397,7 +100158,7 @@ paths: application/json: schema: type: array - items: *707 + items: *700 examples: default: value: @@ -101479,9 +100240,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: + - *455 - *456 - - *457 - - *711 + - *704 - name: name in: query required: true @@ -101507,7 +100268,7 @@ paths: description: Response for successful upload content: application/json: - schema: *707 + schema: *700 examples: response-for-successful-upload: value: @@ -101562,9 +100323,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: + - *455 - *456 - - *457 - - *711 + - *704 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -101588,9 +100349,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 '404': *6 @@ -101611,9 +100372,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: + - *455 - *456 - - *457 - - *711 + - *704 requestBody: required: true content: @@ -101643,16 +100404,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Reaction created content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '422': *15 x-github: githubCloudOnly: false @@ -101674,10 +100435,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: + - *455 - *456 - - *457 - - *711 - - *448 + - *704 + - *449 responses: '204': description: Response @@ -101701,9 +100462,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: + - *455 - *456 - - *457 - - *513 + - *506 - *17 - *19 responses: @@ -101720,7 +100481,7 @@ paths: oneOf: - allOf: - *165 - - &712 + - &705 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -101741,67 +100502,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *166 - - *712 + - *705 - allOf: - *167 - - *712 + - *705 - allOf: - *168 - - *712 + - *705 - allOf: - - *713 - - *712 + - *706 + - *705 - allOf: - *169 - - *712 + - *705 - allOf: - *170 - - *712 + - *705 - allOf: - *171 - - *712 + - *705 - allOf: - *172 - - *712 + - *705 - allOf: - *173 - - *712 + - *705 - allOf: - *174 - - *712 + - *705 - allOf: - *175 - - *712 + - *705 - allOf: - *176 - - *712 + - *705 - allOf: - *177 - - *712 + - *705 - allOf: - *178 - - *712 + - *705 - allOf: - *179 - - *712 + - *705 - allOf: - *180 - - *712 + - *705 - allOf: - *181 - - *712 + - *705 - allOf: - *182 - - *712 + - *705 - allOf: - *183 - - *712 + - *705 - allOf: - *184 - - *712 + - *705 - allOf: - - *714 - - *712 + - *707 + - *705 examples: default: value: @@ -101840,8 +100601,8 @@ paths: category: repos subcategory: rules parameters: + - *455 - *456 - - *457 - *17 - *19 - name: includes_parents @@ -101852,7 +100613,7 @@ paths: schema: type: boolean default: true - - *715 + - *708 responses: '200': description: Response @@ -101907,8 +100668,8 @@ paths: category: repos subcategory: rules parameters: + - *455 - *456 - - *457 requestBody: description: Request body required: true @@ -101937,7 +100698,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *716 + items: *709 required: - name - enforcement @@ -101970,7 +100731,7 @@ paths: application/json: schema: *185 examples: - default: &725 + default: &718 value: id: 42 name: super cool ruleset @@ -102017,12 +100778,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: + - *455 - *456 - - *457 - - *717 + - *710 - *101 - - *718 - - *719 + - *711 + - *712 - *17 - *19 responses: @@ -102030,9 +100791,9 @@ paths: description: Response content: application/json: - schema: *720 + schema: *713 examples: - default: *721 + default: *714 '404': *6 '500': *40 x-github: @@ -102053,17 +100814,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: + - *455 - *456 - - *457 - - *722 + - *715 responses: '200': description: Response content: application/json: - schema: *723 + schema: *716 examples: - default: *724 + default: *717 '404': *6 '500': *40 x-github: @@ -102091,8 +100852,8 @@ paths: category: repos subcategory: rules parameters: + - *455 - *456 - - *457 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102114,7 +100875,7 @@ paths: application/json: schema: *185 examples: - default: *725 + default: *718 '404': *6 '500': *40 put: @@ -102132,8 +100893,8 @@ paths: category: repos subcategory: rules parameters: + - *455 - *456 - - *457 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102167,7 +100928,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *716 + items: *709 examples: default: value: @@ -102197,7 +100958,7 @@ paths: application/json: schema: *185 examples: - default: *725 + default: *718 '404': *6 '500': *40 delete: @@ -102215,8 +100976,8 @@ paths: category: repos subcategory: rules parameters: + - *455 - *456 - - *457 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102239,8 +101000,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: + - *455 - *456 - - *457 - *17 - *19 - name: ruleset_id @@ -102277,8 +101038,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: + - *455 - *456 - - *457 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102351,21 +101112,22 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: + - *455 - *456 - - *457 - *416 - *417 - *418 - *419 + - *420 - *106 - *19 - *17 - - *726 - - *727 - - *420 + - *719 + - *720 - *421 - *422 - *423 + - *424 responses: '200': description: Response @@ -102373,7 +101135,7 @@ paths: application/json: schema: type: array - items: &731 + items: &724 type: object properties: number: *123 @@ -102392,8 +101154,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *728 - resolution: *729 + state: *721 + resolution: *722 resolved_at: type: string format: date-time @@ -102489,7 +101251,7 @@ paths: pull request. ' - oneOf: *730 + oneOf: *723 nullable: true has_more_locations: type: boolean @@ -102638,16 +101400,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: + - *455 - *456 - - *457 - - *542 - - *423 + - *535 + - *424 responses: '200': description: Response content: application/json: - schema: *731 + schema: *724 examples: default: value: @@ -102689,6 +101451,8 @@ paths: description: |- Updates the status of a secret scanning alert in an eligible repository. + You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. 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. @@ -102699,9 +101463,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: + - *455 - *456 - - *457 - - *542 + - *535 requestBody: required: true content: @@ -102709,27 +101473,42 @@ paths: schema: type: object properties: - state: *728 - resolution: *729 + state: *721 + resolution: *722 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: string nullable: true + assignee: + description: The username of the user to assign to the alert. Set + to `null` to unassign the alert. + type: string + nullable: true anyOf: - required: - state + - required: + - assignee examples: default: value: state: resolved resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: responses: '200': description: Response content: application/json: - schema: *731 + schema: *724 examples: default: value: @@ -102774,6 +101553,25 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false '400': description: Bad request, resolution comment is invalid or the resolution was not changed. @@ -102781,7 +101579,8 @@ paths: description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': - description: State does not match the resolution or resolution comment + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository '503': *190 x-github: enabledForGitHubApps: true @@ -102804,9 +101603,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: + - *455 - *456 - - *457 - - *542 + - *535 - *19 - *17 responses: @@ -102817,7 +101616,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &912 + items: &903 type: object properties: type: @@ -102843,19 +101642,19 @@ paths: example: commit details: oneOf: + - *725 + - *726 + - *727 + - *728 + - *729 + - *730 + - *731 - *732 - *733 - *734 - *735 - *736 - *737 - - *738 - - *739 - - *740 - - *741 - - *742 - - *743 - - *744 examples: default: value: @@ -102941,8 +101740,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -102950,14 +101749,14 @@ paths: schema: type: object properties: - reason: &746 + reason: &739 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *745 + placeholder_id: *738 required: - reason - placeholder_id @@ -102974,7 +101773,7 @@ paths: schema: type: object properties: - reason: *746 + reason: *739 expire_at: type: string format: date-time @@ -103020,8 +101819,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: + - *455 - *456 - - *457 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -103036,7 +101835,7 @@ paths: properties: incremental_scans: type: array - items: &747 + items: &740 description: Information on a single scan performed by secret scanning on the repository type: object @@ -103062,15 +101861,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *747 + items: *740 backfill_scans: type: array - items: *747 + items: *740 custom_pattern_backfill_scans: type: array items: allOf: - - *747 + - *740 - type: object properties: pattern_name: @@ -103140,8 +101939,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: + - *455 - *456 - - *457 - *106 - name: sort description: The property to sort the results by. @@ -103185,9 +101984,9 @@ paths: application/json: schema: type: array - items: *748 + items: *741 examples: - default: *749 + default: *742 '400': *14 '404': *6 x-github: @@ -103210,8 +102009,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -103284,7 +102083,7 @@ paths: login: type: string description: The username of the user credited. - type: *428 + type: *429 required: - login - type @@ -103371,9 +102170,9 @@ paths: description: Response content: application/json: - schema: *748 + schema: *741 examples: - default: &751 + default: &744 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -103606,8 +102405,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -103711,7 +102510,7 @@ paths: description: Response content: application/json: - schema: *748 + schema: *741 examples: default: value: @@ -103858,17 +102657,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: + - *455 - *456 - - *457 - - *750 + - *743 responses: '200': description: Response content: application/json: - schema: *748 + schema: *741 examples: - default: *751 + default: *744 '403': *29 '404': *6 x-github: @@ -103892,9 +102691,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: + - *455 - *456 - - *457 - - *750 + - *743 requestBody: required: true content: @@ -103967,7 +102766,7 @@ paths: login: type: string description: The username of the user credited. - type: *428 + type: *429 required: - login - type @@ -104053,10 +102852,10 @@ paths: description: Response content: application/json: - schema: *748 + schema: *741 examples: - default: *751 - add_credit: *751 + default: *744 + add_credit: *744 '403': *29 '404': *6 '422': @@ -104094,9 +102893,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: + - *455 - *456 - - *457 - - *750 + - *743 responses: '202': *39 '400': *14 @@ -104123,17 +102922,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: + - *455 - *456 - - *457 - - *750 + - *743 responses: '202': description: Response content: application/json: - schema: *467 + schema: *460 examples: - default: *469 + default: *462 '400': *14 '422': *15 '403': *29 @@ -104159,8 +102958,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -104259,8 +103058,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: + - *455 - *456 - - *457 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -104269,7 +103068,7 @@ paths: application/json: schema: type: array - items: &752 + items: &745 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -104302,8 +103101,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -104379,8 +103178,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -104476,8 +103275,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: + - *455 - *456 - - *457 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -104631,8 +103430,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: + - *455 - *456 - - *457 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -104642,7 +103441,7 @@ paths: application/json: schema: type: array - items: *752 + items: *745 examples: default: value: @@ -104675,8 +103474,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: + - *455 - *456 - - *457 - name: sha in: path required: true @@ -104730,7 +103529,7 @@ paths: description: Response content: application/json: - schema: *753 + schema: *746 examples: default: value: @@ -104784,8 +103583,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -104817,14 +103616,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: + - *455 - *456 - - *457 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &754 + schema: &747 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -104892,8 +103691,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: + - *455 - *456 - - *457 requestBody: required: false content: @@ -104919,7 +103718,7 @@ paths: description: Response content: application/json: - schema: *754 + schema: *747 examples: default: value: @@ -104946,8 +103745,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -104967,8 +103766,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -105047,8 +103846,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -105056,7 +103855,7 @@ paths: application/json: schema: type: array - items: &755 + items: &748 title: Tag protection description: Tag protection type: object @@ -105108,8 +103907,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -105132,7 +103931,7 @@ paths: description: Response content: application/json: - schema: *755 + schema: *748 examples: default: value: @@ -105163,8 +103962,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: + - *455 - *456 - - *457 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -105201,8 +104000,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: + - *455 - *456 - - *457 - name: ref in: path required: true @@ -105238,8 +104037,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -105271,8 +104070,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: + - *455 - *456 - - *457 - *19 - *17 responses: @@ -105280,7 +104079,7 @@ paths: description: Response content: application/json: - schema: &756 + schema: &749 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -105292,7 +104091,7 @@ paths: required: - names examples: - default: &757 + default: &750 value: names: - octocat @@ -105315,8 +104114,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -105347,9 +104146,9 @@ paths: description: Response content: application/json: - schema: *756 + schema: *749 examples: - default: *757 + default: *750 '404': *6 '422': *7 x-github: @@ -105370,9 +104169,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: + - *455 - *456 - - *457 - - &758 + - &751 name: per description: The time frame to display results for. in: query @@ -105401,7 +104200,7 @@ paths: example: 128 clones: type: array - items: &759 + items: &752 title: Traffic type: object properties: @@ -105488,8 +104287,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -105579,8 +104378,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -105640,9 +104439,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: + - *455 - *456 - - *457 - - *758 + - *751 responses: '200': description: Response @@ -105661,7 +104460,7 @@ paths: example: 3782 views: type: array - items: *759 + items: *752 required: - uniques - count @@ -105738,8 +104537,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -106013,8 +104812,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: + - *455 - *456 - - *457 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -106037,8 +104836,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -106060,8 +104859,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -106087,8 +104886,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: + - *455 - *456 - - *457 - name: ref in: path required: true @@ -106180,9 +104979,9 @@ paths: description: Response content: application/json: - schema: *467 + schema: *460 examples: - default: *469 + default: *462 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -106333,7 +105132,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &767 + - &760 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -106342,7 +105141,7 @@ paths: schema: type: string example: members - - &772 + - &765 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -106353,7 +105152,7 @@ paths: default: 1 format: int32 example: 1 - - &773 + - &766 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -106395,7 +105194,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &762 + items: &755 allOf: - type: object required: @@ -106470,7 +105269,7 @@ paths: - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 - meta: &774 + meta: &767 type: object description: The metadata associated with the creation/updates to the user. @@ -106530,30 +105329,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &763 + '400': &756 description: Bad request content: application/json: - schema: *760 + schema: *753 application/scim+json: - schema: *760 - '401': *761 - '403': &764 + schema: *753 + '401': *754 + '403': &757 description: Permission denied - '429': &765 + '429': &758 description: Too many requests content: application/json: - schema: *760 + schema: *753 application/scim+json: - schema: *760 - '500': &766 + schema: *753 + '500': &759 description: Internal server error content: application/json: - schema: *760 + schema: *753 application/scim+json: - schema: *760 + schema: *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106577,7 +105376,7 @@ paths: required: true content: application/json: - schema: &770 + schema: &763 type: object required: - schemas @@ -106637,9 +105436,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *762 + schema: *755 examples: - group: &768 + group: &761 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -106658,13 +105457,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 - '400': *763 - '401': *761 - '403': *764 - '409': &771 + '400': *756 + '401': *754 + '403': *757 + '409': &764 description: Duplicate record detected - '429': *765 - '500': *766 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106681,7 +105480,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group parameters: - - &769 + - &762 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -106689,22 +105488,22 @@ paths: schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 - - *767 + - *760 - *41 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *762 + schema: *755 examples: - default: *768 - '400': *763 - '401': *761 - '403': *764 + default: *761 + '400': *756 + '401': *754 + '403': *757 '404': *6 - '429': *765 - '500': *766 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106723,13 +105522,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group parameters: - - *769 + - *762 - *41 requestBody: required: true content: application/json: - schema: *770 + schema: *763 examples: group: summary: Group @@ -106755,17 +105554,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *762 + schema: *755 examples: - group: *768 - groupWithMembers: *768 - '400': *763 - '401': *761 - '403': *764 + group: *761 + groupWithMembers: *761 + '400': *756 + '401': *754 + '403': *757 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *764 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106789,13 +105588,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group parameters: - - *769 + - *762 - *41 requestBody: required: true content: application/json: - schema: &781 + schema: &774 type: object required: - Operations @@ -106855,17 +105654,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *762 + schema: *755 examples: - updateGroup: *768 - addMembers: *768 - '400': *763 - '401': *761 - '403': *764 + updateGroup: *761 + addMembers: *761 + '400': *756 + '401': *754 + '403': *757 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *764 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106881,17 +105680,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise parameters: - - *769 + - *762 - *41 responses: '204': description: Group was deleted, no content - '400': *763 - '401': *761 - '403': *764 + '400': *756 + '401': *754 + '403': *757 '404': *6 - '429': *765 - '500': *766 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106925,8 +105724,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *772 - - *773 + - *765 + - *766 - *41 responses: '200': @@ -106959,7 +105758,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &776 + items: &769 allOf: - type: object required: @@ -107038,7 +105837,7 @@ paths: description: Whether this email address is the primary address. example: true - roles: &775 + roles: &768 type: array description: The roles assigned to the user. items: @@ -107094,7 +105893,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *774 + meta: *767 startIndex: type: integer description: A starting index for the returned page @@ -107131,11 +105930,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *763 - '401': *761 - '403': *764 - '429': *765 - '500': *766 + '400': *756 + '401': *754 + '403': *757 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107159,7 +105958,7 @@ paths: required: true content: application/json: - schema: &779 + schema: &772 type: object required: - schemas @@ -107241,9 +106040,9 @@ paths: type: boolean description: Whether this email address is the primary address. example: true - roles: *775 + roles: *768 examples: - user: &780 + user: &773 summary: User value: schemas: @@ -107290,9 +106089,9 @@ paths: description: User has been created content: application/scim+json: - schema: *776 + schema: *769 examples: - user: &777 + user: &770 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -107318,13 +106117,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 - enterpriseOwner: *777 - '400': *763 - '401': *761 - '403': *764 - '409': *771 - '429': *765 - '500': *766 + enterpriseOwner: *770 + '400': *756 + '401': *754 + '403': *757 + '409': *764 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107341,7 +106140,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user parameters: - - &778 + - &771 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -107354,15 +106153,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *776 + schema: *769 examples: - default: *777 - '400': *763 - '401': *761 - '403': *764 + default: *770 + '400': *756 + '401': *754 + '403': *757 '404': *6 - '429': *765 - '500': *766 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107384,30 +106183,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user parameters: - - *778 + - *771 - *41 requestBody: required: true content: application/json: - schema: *779 + schema: *772 examples: - user: *780 + user: *773 responses: '200': description: User was updated content: application/scim+json: - schema: *776 + schema: *769 examples: - user: *777 - '400': *763 - '401': *761 - '403': *764 + user: *770 + '400': *756 + '401': *754 + '403': *757 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *764 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107442,13 +106241,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user parameters: - - *778 + - *771 - *41 requestBody: required: true content: application/json: - schema: *781 + schema: *774 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -107488,18 +106287,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *776 + schema: *769 examples: - userMultiValuedProperties: *777 - userSingleValuedProperties: *777 - disableUser: *777 - '400': *763 - '401': *761 - '403': *764 + userMultiValuedProperties: *770 + userSingleValuedProperties: *770 + disableUser: *770 + '400': *756 + '401': *754 + '403': *757 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *764 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107519,17 +106318,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise parameters: - - *778 + - *771 - *41 responses: '204': description: User was deleted, no content - '400': *763 - '401': *761 - '403': *764 + '400': *756 + '401': *754 + '403': *757 '404': *6 - '429': *765 - '500': *766 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107616,7 +106415,7 @@ paths: example: 1 Resources: type: array - items: &782 + items: &775 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -107847,22 +106646,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *37 - '404': &783 + '404': &776 description: Resource not found content: application/json: - schema: *760 + schema: *753 application/scim+json: - schema: *760 - '403': &784 + schema: *753 + '403': &777 description: Forbidden content: application/json: - schema: *760 + schema: *753 application/scim+json: - schema: *760 - '400': *763 - '429': *765 + schema: *753 + '400': *756 + '429': *758 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -107888,9 +106687,9 @@ paths: description: Response content: application/scim+json: - schema: *782 + schema: *775 examples: - default: &785 + default: &778 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -107913,17 +106712,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *37 - '404': *783 - '403': *784 - '500': *766 + '404': *776 + '403': *777 + '500': *759 '409': description: Conflict content: application/json: - schema: *760 + schema: *753 application/scim+json: - schema: *760 - '400': *763 + schema: *753 + '400': *756 requestBody: required: true content: @@ -108021,17 +106820,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - *83 - - *778 + - *771 responses: '200': description: Response content: application/scim+json: - schema: *782 + schema: *775 examples: - default: *785 - '404': *783 - '403': *784 + default: *778 + '404': *776 + '403': *777 '304': *37 x-github: githubCloudOnly: true @@ -108055,18 +106854,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - *83 - - *778 + - *771 responses: '200': description: Response content: application/scim+json: - schema: *782 + schema: *775 examples: - default: *785 + default: *778 '304': *37 - '404': *783 - '403': *784 + '404': *776 + '403': *777 requestBody: required: true content: @@ -108179,19 +106978,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - *83 - - *778 + - *771 responses: '200': description: Response content: application/scim+json: - schema: *782 + schema: *775 examples: - default: *785 + default: *778 '304': *37 - '404': *783 - '403': *784 - '400': *763 + '404': *776 + '403': *777 + '400': *756 '429': description: Response content: @@ -108282,12 +107081,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - *83 - - *778 + - *771 responses: '204': description: Response - '404': *783 - '403': *784 + '404': *776 + '403': *777 '304': *37 x-github: githubCloudOnly: true @@ -108420,7 +107219,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &786 + text_matches: &779 title: Search Result Text Matches type: array items: @@ -108583,7 +107382,7 @@ paths: enum: - author-date - committer-date - - &787 + - &780 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -108654,7 +107453,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *511 + properties: *504 nullable: true comment_count: type: integer @@ -108674,7 +107473,7 @@ paths: url: type: string format: uri - verification: *633 + verification: *626 required: - author - committer @@ -108693,7 +107492,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *511 + properties: *504 nullable: true parents: type: array @@ -108711,7 +107510,7 @@ paths: type: number node_id: type: string - text_matches: *786 + text_matches: *779 required: - sha - node_id @@ -108904,7 +107703,7 @@ paths: - interactions - created - updated - - *787 + - *780 - *17 - *19 - name: advanced_search @@ -109001,11 +107800,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: type: string state_reason: @@ -109037,7 +107836,7 @@ paths: type: string format: date-time nullable: true - text_matches: *786 + text_matches: *779 pull_request: type: object properties: @@ -109262,7 +108061,7 @@ paths: enum: - created - updated - - *787 + - *780 - *17 - *19 responses: @@ -109306,7 +108105,7 @@ paths: nullable: true score: type: number - text_matches: *786 + text_matches: *779 required: - id - node_id @@ -109392,7 +108191,7 @@ paths: - forks - help-wanted-issues - updated - - *787 + - *780 - *17 - *19 responses: @@ -109631,7 +108430,7 @@ paths: - admin - pull - push - text_matches: *786 + text_matches: *779 temp_clone_token: type: string allow_merge_commit: @@ -109932,7 +108731,7 @@ paths: type: string format: uri nullable: true - text_matches: *786 + text_matches: *779 related: type: array nullable: true @@ -110125,7 +108924,7 @@ paths: - followers - repositories - joined - - *787 + - *780 - *17 - *19 responses: @@ -110229,7 +109028,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *786 + text_matches: *779 blog: type: string nullable: true @@ -110308,7 +109107,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &791 + - &784 name: team_id description: The unique identifier of the team. in: path @@ -110320,9 +109119,9 @@ paths: description: Response content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '404': *6 x-github: githubCloudOnly: false @@ -110349,7 +109148,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *791 + - *784 requestBody: required: true content: @@ -110412,16 +109211,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '201': description: Response content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '404': *6 '422': *15 '403': *29 @@ -110449,7 +109248,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *791 + - *784 responses: '204': description: Response @@ -110480,7 +109279,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *791 + - *784 - *106 - *17 - *19 @@ -110491,9 +109290,9 @@ paths: application/json: schema: type: array - items: *439 + items: *440 examples: - default: *792 + default: *785 headers: Link: *43 x-github: @@ -110522,7 +109321,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *791 + - *784 requestBody: required: true content: @@ -110556,9 +109355,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: *440 + default: *441 x-github: triggersNotification: true githubCloudOnly: false @@ -110585,16 +109384,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *791 - - *441 + - *784 + - *442 responses: '200': description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: *440 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110619,8 +109418,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *791 - - *441 + - *784 + - *442 requestBody: required: false content: @@ -110643,9 +109442,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: *793 + default: *786 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110670,8 +109469,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *791 - - *441 + - *784 + - *442 responses: '204': description: Response @@ -110700,8 +109499,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *791 - - *441 + - *784 + - *442 - *106 - *17 - *19 @@ -110712,9 +109511,9 @@ paths: application/json: schema: type: array - items: *442 + items: *443 examples: - default: *794 + default: *787 headers: Link: *43 x-github: @@ -110743,8 +109542,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *791 - - *441 + - *784 + - *442 requestBody: required: true content: @@ -110766,9 +109565,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: *443 + default: *444 x-github: triggersNotification: true githubCloudOnly: false @@ -110795,17 +109594,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *784 + - *442 + - *445 responses: '200': description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: *443 + default: *444 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110830,9 +109629,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *784 + - *442 + - *445 requestBody: required: true content: @@ -110854,9 +109653,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: *795 + default: *788 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110881,9 +109680,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *784 + - *442 + - *445 responses: '204': description: Response @@ -110912,9 +109711,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *784 + - *442 + - *445 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -110940,9 +109739,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 x-github: @@ -110971,9 +109770,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *784 + - *442 + - *445 requestBody: required: true content: @@ -111005,9 +109804,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111033,8 +109832,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *791 - - *441 + - *784 + - *442 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -111060,9 +109859,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 x-github: @@ -111091,8 +109890,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *791 - - *441 + - *784 + - *442 requestBody: required: true content: @@ -111124,9 +109923,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -111150,7 +109949,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *791 + - *784 - *17 - *19 responses: @@ -111188,7 +109987,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *791 + - *784 - name: role description: Filters members returned by their role in the team. in: query @@ -111239,7 +110038,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *791 + - *784 - *138 responses: '204': @@ -111276,7 +110075,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *791 + - *784 - *138 responses: '204': @@ -111316,7 +110115,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *791 + - *784 - *138 responses: '204': @@ -111353,16 +110152,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *791 + - *784 - *138 responses: '200': description: Response content: application/json: - schema: *453 + schema: *454 examples: - response-if-user-is-a-team-maintainer: *796 + response-if-user-is-a-team-maintainer: *789 '404': *6 x-github: githubCloudOnly: false @@ -111395,7 +110194,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *791 + - *784 - *138 requestBody: required: false @@ -111421,9 +110220,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *454 examples: - response-if-users-membership-with-team-is-now-pending: *797 + response-if-users-membership-with-team-is-now-pending: *790 '403': description: Forbidden if team synchronization is set up '422': @@ -111457,7 +110256,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *791 + - *784 - *138 responses: '204': @@ -111472,174 +110271,6 @@ paths: category: teams subcategory: members deprecated: true - "/teams/{team_id}/projects": - get: - summary: List team projects (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/list-projects-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy - parameters: - - *791 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *454 - examples: - default: *798 - headers: - Link: *43 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - "/teams/{team_id}/projects/{project_id}": - get: - summary: Check team permissions for a project (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/check-permissions-for-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project-legacy - parameters: - - *791 - - *455 - responses: - '200': - description: Response - content: - application/json: - schema: *454 - examples: - default: *799 - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - put: - summary: Add or update team project permissions (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/add-or-update-project-permissions-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions-legacy - parameters: - - *791 - - *455 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - examples: - default: - summary: Example of setting permission to read - value: - permission: read - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - delete: - summary: Remove a project from a team (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/remove-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team-legacy - parameters: - - *791 - - *455 - responses: - '204': - description: Response - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true "/teams/{team_id}/repos": get: summary: List team repositories (Legacy) @@ -111653,7 +110284,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *791 + - *784 - *17 - *19 responses: @@ -111695,15 +110326,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *791 + - *784 + - *455 - *456 - - *457 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *800 + schema: *791 examples: alternative-response-with-extra-repository-information: value: @@ -111854,9 +110485,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *791 + - *784 + - *455 - *456 - - *457 requestBody: required: false content: @@ -111906,9 +110537,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *791 + - *784 + - *455 - *456 - - *457 responses: '204': description: Response @@ -111937,15 +110568,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy parameters: - - *791 + - *784 responses: '200': description: Response content: application/json: - schema: *458 + schema: *457 examples: - default: *459 + default: *458 '403': *29 '404': *6 x-github: @@ -111972,7 +110603,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy parameters: - - *791 + - *784 requestBody: required: true content: @@ -112029,7 +110660,7 @@ paths: description: Response content: application/json: - schema: *458 + schema: *457 examples: default: value: @@ -112060,7 +110691,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *791 + - *784 - *17 - *19 responses: @@ -112072,7 +110703,7 @@ paths: type: array items: *303 examples: - response-if-child-teams-exist: *801 + response-if-child-teams-exist: *792 headers: Link: *43 '404': *6 @@ -112105,7 +110736,7 @@ paths: application/json: schema: oneOf: - - &803 + - &794 title: Private User description: Private User type: object @@ -112308,7 +110939,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *802 + - *793 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -112461,7 +111092,7 @@ paths: description: Response content: application/json: - schema: *803 + schema: *794 examples: default: value: @@ -112807,7 +111438,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *555 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -112815,7 +111446,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *555 '401': *25 '403': *29 '404': *6 @@ -112859,7 +111490,7 @@ paths: type: integer secrets: type: array - items: &804 + items: &795 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -112899,7 +111530,7 @@ paths: - visibility - selected_repositories_url examples: - default: *565 + default: *558 headers: Link: *43 x-github: @@ -112975,7 +111606,7 @@ paths: description: Response content: application/json: - schema: *804 + schema: *795 examples: default: value: @@ -113121,7 +111752,7 @@ paths: type: array items: *274 examples: - default: *805 + default: *796 '401': *25 '403': *29 '404': *6 @@ -113273,7 +111904,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *555 '304': *37 '500': *40 '401': *25 @@ -113331,7 +111962,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *555 '401': *25 '403': *29 '404': *6 @@ -113388,7 +112019,7 @@ paths: description: Response content: application/json: - schema: &806 + schema: &797 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -113429,7 +112060,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &807 + default: &798 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -113474,9 +112105,9 @@ paths: description: Response content: application/json: - schema: *806 + schema: *797 examples: - default: *807 + default: *798 '404': *6 x-github: githubCloudOnly: false @@ -113513,9 +112144,9 @@ paths: type: integer machines: type: array - items: *808 + items: *799 examples: - default: *809 + default: *800 '304': *37 '500': *40 '401': *25 @@ -113594,13 +112225,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *467 + repository: *460 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *563 - required: *564 + properties: *556 + required: *557 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -114382,7 +113013,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *555 '304': *37 '500': *40 '400': *14 @@ -114422,7 +113053,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *555 '500': *40 '401': *25 '403': *29 @@ -114454,7 +113085,7 @@ paths: type: array items: *376 examples: - default: &820 + default: &811 value: - id: 197 name: hello_docker @@ -114555,7 +113186,7 @@ paths: application/json: schema: type: array - items: &810 + items: &801 title: Email description: Email type: object @@ -114620,9 +113251,9 @@ paths: application/json: schema: type: array - items: *810 + items: *801 examples: - default: &822 + default: &813 value: - email: octocat@github.com verified: true @@ -114697,7 +113328,7 @@ paths: application/json: schema: type: array - items: *810 + items: *801 examples: default: value: @@ -114953,7 +113584,7 @@ paths: application/json: schema: type: array - items: &811 + items: &802 title: GPG Key description: A unique encryption key type: object @@ -115084,7 +113715,7 @@ paths: - subkeys - revoked examples: - default: &836 + default: &827 value: - id: 3 name: Octocat's GPG Key @@ -115169,9 +113800,9 @@ paths: description: Response content: application/json: - schema: *811 + schema: *802 examples: - default: &812 + default: &803 value: id: 3 name: Octocat's GPG Key @@ -115228,7 +113859,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &813 + - &804 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -115240,9 +113871,9 @@ paths: description: Response content: application/json: - schema: *811 + schema: *802 examples: - default: *812 + default: *803 '404': *6 '304': *37 '403': *29 @@ -115265,7 +113896,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *813 + - *804 responses: '204': description: Response @@ -115570,7 +114201,7 @@ paths: required: true content: application/json: - schema: *644 + schema: *637 examples: default: value: @@ -115720,7 +114351,7 @@ paths: application/json: schema: type: array - items: &814 + items: &805 title: Key description: Key type: object @@ -115821,9 +114452,9 @@ paths: description: Response content: application/json: - schema: *814 + schema: *805 examples: - default: &815 + default: &806 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -115856,15 +114487,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *674 + - *667 responses: '200': description: Response content: application/json: - schema: *814 + schema: *805 examples: - default: *815 + default: *806 '404': *6 '304': *37 '403': *29 @@ -115887,7 +114518,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *674 + - *667 responses: '204': description: Response @@ -115920,7 +114551,7 @@ paths: application/json: schema: type: array - items: &816 + items: &807 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -115988,7 +114619,7 @@ paths: - account - plan examples: - default: &817 + default: &808 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -116050,9 +114681,9 @@ paths: application/json: schema: type: array - items: *816 + items: *807 examples: - default: *817 + default: *808 headers: Link: *43 '304': *37 @@ -117047,7 +115678,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - *371 - - *818 + - *809 responses: '204': description: Response @@ -117162,7 +115793,7 @@ paths: - docker - nuget - container - - *819 + - *810 - *19 - *17 responses: @@ -117174,8 +115805,8 @@ paths: type: array items: *376 examples: - default: *820 - '400': *821 + default: *811 + '400': *812 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -117204,7 +115835,7 @@ paths: application/json: schema: *376 examples: - default: &837 + default: &828 value: id: 40201 name: octo-name @@ -117566,9 +116197,9 @@ paths: application/json: schema: type: array - items: *810 + items: *801 examples: - default: *822 + default: *813 headers: Link: *43 '304': *37 @@ -117681,7 +116312,7 @@ paths: type: array items: *74 examples: - default: &829 + default: &820 summary: Default response value: - id: 1296269 @@ -117985,9 +116616,9 @@ paths: description: Response content: application/json: - schema: *467 + schema: *460 examples: - default: *469 + default: *462 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -118025,9 +116656,9 @@ paths: application/json: schema: type: array - items: *646 + items: *639 examples: - default: *823 + default: *814 headers: Link: *43 '304': *37 @@ -118106,7 +116737,7 @@ paths: application/json: schema: type: array - items: &824 + items: &815 title: Social account description: Social media account type: object @@ -118121,7 +116752,7 @@ paths: - provider - url examples: - default: &825 + default: &816 value: - provider: twitter url: https://twitter.com/github @@ -118183,9 +116814,9 @@ paths: application/json: schema: type: array - items: *824 + items: *815 examples: - default: *825 + default: *816 '422': *15 '304': *37 '404': *6 @@ -118272,7 +116903,7 @@ paths: application/json: schema: type: array - items: &826 + items: &817 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -118292,7 +116923,7 @@ paths: - title - created_at examples: - default: &841 + default: &832 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -118356,9 +116987,9 @@ paths: description: Response content: application/json: - schema: *826 + schema: *817 examples: - default: &827 + default: &818 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -118388,7 +117019,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &828 + - &819 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -118400,9 +117031,9 @@ paths: description: Response content: application/json: - schema: *826 + schema: *817 examples: - default: *827 + default: *818 '404': *6 '304': *37 '403': *29 @@ -118425,7 +117056,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *828 + - *819 responses: '204': description: Response @@ -118454,7 +117085,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &842 + - &833 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -118479,11 +117110,11 @@ paths: type: array items: *74 examples: - default-response: *829 + default-response: *820 application/vnd.github.v3.star+json: schema: type: array - items: &843 + items: &834 title: Starred Repository description: Starred Repository type: object @@ -118639,8 +117270,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: + - *455 - *456 - - *457 responses: '204': description: Response if this repository is starred by you @@ -118668,8 +117299,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -118693,8 +117324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -118766,7 +117397,7 @@ paths: application/json: schema: type: array - items: *437 + items: *438 examples: default: value: @@ -118852,10 +117483,10 @@ paths: application/json: schema: oneOf: - - *803 - - *802 + - *794 + - *793 examples: - default-response: &831 + default-response: &822 summary: Default response value: login: octocat @@ -118890,7 +117521,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &832 + response-with-git-hub-plan-information: &823 summary: Response with GitHub plan information value: login: octocat @@ -119012,7 +117643,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *830 + - *821 - *17 responses: '200': @@ -119061,11 +117692,11 @@ paths: application/json: schema: oneOf: - - *803 - - *802 + - *794 + - *793 examples: - default-response: *831 - response-with-git-hub-plan-information: *832 + default-response: *822 + response-with-git-hub-plan-information: *823 '404': *6 x-github: githubCloudOnly: false @@ -119115,8 +117746,8 @@ paths: required: - subject_digests examples: - default: *833 - withPredicateType: *834 + default: *824 + withPredicateType: *825 responses: '200': description: Response @@ -119169,7 +117800,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *835 + default: *826 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -119374,7 +118005,7 @@ paths: initiator: type: string examples: - default: *507 + default: *500 '201': description: Response content: @@ -119415,7 +118046,7 @@ paths: type: array items: *376 examples: - default: *820 + default: *811 '403': *29 '401': *25 x-github: @@ -119799,9 +118430,9 @@ paths: application/json: schema: type: array - items: *811 + items: *802 examples: - default: *836 + default: *827 headers: Link: *43 x-github: @@ -119905,7 +118536,7 @@ paths: application/json: schema: *22 examples: - default: *643 + default: *636 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120029,7 +118660,7 @@ paths: - docker - nuget - container - - *819 + - *810 - *138 - *19 - *17 @@ -120042,10 +118673,10 @@ paths: type: array items: *376 examples: - default: *820 + default: *811 '403': *29 '401': *25 - '400': *821 + '400': *812 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120075,7 +118706,7 @@ paths: application/json: schema: *376 examples: - default: *837 + default: *828 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120424,7 +119055,7 @@ paths: type: array items: *398 examples: - default: *838 + default: *829 headers: Link: *43 '304': *37 @@ -120435,6 +119066,257 @@ paths: enabledForGitHubApps: true category: projects subcategory: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-field-to-user-owned-project + parameters: + - *138 + - *394 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + - single_select + - iteration + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + iteration_configuration: + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: The duration of the iteration in days. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + properties: + title: + type: string + description: The title for the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + required: + - name + - data_type + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + iteration_field: + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + responses: + '201': + description: Response + content: + application/json: + schema: *398 + examples: + text_field: + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + number_field: + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + date_field: + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + single_select_field: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + iteration_field: + value: + id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' + '304': *37 + '403': *29 + '401': *25 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields "/users/{username}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for user @@ -120447,7 +119329,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user parameters: - *394 - - *839 + - *830 - *138 responses: '200': @@ -120456,7 +119338,7 @@ paths: application/json: schema: *398 examples: - default: *840 + default: *831 headers: Link: *43 '304': *37 @@ -120991,9 +119873,9 @@ paths: application/json: schema: type: array - items: *824 + items: *815 examples: - default: *825 + default: *816 headers: Link: *43 x-github: @@ -121023,9 +119905,9 @@ paths: application/json: schema: type: array - items: *826 + items: *817 examples: - default: *841 + default: *832 headers: Link: *43 x-github: @@ -121050,7 +119932,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - *138 - - *842 + - *833 - *106 - *17 - *19 @@ -121062,11 +119944,11 @@ paths: schema: anyOf: - type: array - items: *843 + items: *834 - type: array items: *74 examples: - default-response: *829 + default-response: *820 headers: Link: *43 x-github: @@ -121225,7 +120107,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &844 + enterprise: &835 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -121283,7 +120165,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &845 + installation: &836 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -121302,7 +120184,7 @@ x-webhooks: required: - id - node_id - organization: &846 + organization: &837 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -121362,13 +120244,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &847 + repository: &838 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &884 + properties: &875 id: description: Unique identifier of the repository example: 42 @@ -122051,7 +120933,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &885 + required: &876 - archive_url - assignees_url - blobs_url @@ -122202,10 +121084,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -122281,11 +121163,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - rule: &848 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + rule: &839 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -122508,11 +121390,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - rule: *848 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + rule: *839 sender: *4 required: - action @@ -122695,11 +121577,11 @@ x-webhooks: - everyone required: - from - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - rule: *848 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + rule: *839 sender: *4 required: - action @@ -122772,7 +121654,7 @@ x-webhooks: required: true content: application/json: - schema: &868 + schema: &859 title: Exemption request cancellation event type: object properties: @@ -122780,11 +121662,11 @@ x-webhooks: type: string enum: - cancelled - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: &849 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + exemption_request: &840 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -123017,7 +121899,7 @@ x-webhooks: type: array description: The responses to the exemption request. nullable: true - items: &850 + items: &841 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -123127,7 +122009,7 @@ x-webhooks: required: true content: application/json: - schema: &869 + schema: &860 title: Exemption request completed event type: object properties: @@ -123135,11 +122017,11 @@ x-webhooks: type: string enum: - completed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + exemption_request: *840 sender: *4 required: - action @@ -123211,7 +122093,7 @@ x-webhooks: required: true content: application/json: - schema: &866 + schema: &857 title: Exemption request created event type: object properties: @@ -123219,11 +122101,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + exemption_request: *840 sender: *4 required: - action @@ -123295,7 +122177,7 @@ x-webhooks: required: true content: application/json: - schema: &870 + schema: &861 title: Exemption response dismissed event type: object properties: @@ -123303,12 +122185,12 @@ x-webhooks: type: string enum: - response_dismissed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 - exemption_response: *850 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + exemption_request: *840 + exemption_response: *841 sender: *4 required: - action @@ -123382,7 +122264,7 @@ x-webhooks: required: true content: application/json: - schema: &867 + schema: &858 title: Exemption response submitted event type: object properties: @@ -123390,12 +122272,12 @@ x-webhooks: type: string enum: - response_submitted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 - exemption_response: *850 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + exemption_request: *840 + exemption_response: *841 sender: *4 required: - action @@ -123479,7 +122361,7 @@ x-webhooks: type: string enum: - completed - check_run: &852 + check_run: &843 title: CheckRun description: A check performed on the code of a given code change type: object @@ -123532,7 +122414,7 @@ x-webhooks: type: string pull_requests: type: array - items: *524 + items: *517 repository: *274 status: example: completed @@ -123570,7 +122452,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *851 + deployment: *842 details_url: example: https://example.com type: string @@ -123620,7 +122502,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *524 + items: *517 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -123655,10 +122537,10 @@ x-webhooks: - output - app - pull_requests - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + installation: *836 + enterprise: *835 + organization: *837 + repository: *838 sender: *4 required: - check_run @@ -124051,11 +122933,11 @@ x-webhooks: type: string enum: - created - check_run: *852 - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + check_run: *843 + installation: *836 + enterprise: *835 + organization: *837 + repository: *838 sender: *4 required: - check_run @@ -124451,11 +123333,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *852 - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + check_run: *843 + installation: *836 + enterprise: *835 + organization: *837 + repository: *838 requested_action: description: The action requested by the user. type: object @@ -124860,11 +123742,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *852 - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + check_run: *843 + installation: *836 + enterprise: *835 + organization: *837 + repository: *838 sender: *4 required: - check_run @@ -125841,10 +124723,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -126117,6 +124999,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -126529,10 +125416,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -126800,6 +125687,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -127211,10 +126103,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -127380,7 +126272,7 @@ x-webhooks: required: - login - id - dismissed_comment: *537 + dismissed_comment: *530 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -127525,20 +126417,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &853 + commit_oid: &844 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *844 - installation: *845 - organization: *846 - ref: &854 + enterprise: *835 + installation: *836 + organization: *837 + ref: &845 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *847 + repository: *838 sender: *4 required: - action @@ -127703,7 +126595,7 @@ x-webhooks: required: - login - id - dismissed_comment: *537 + dismissed_comment: *530 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -127933,12 +126825,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *844 + enterprise: *835 + installation: *836 + organization: *837 + ref: *845 + repository: *838 sender: *4 required: - action @@ -128033,7 +126925,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *537 + dismissed_comment: *530 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -128204,12 +127096,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *844 + enterprise: *835 + installation: *836 + organization: *837 + ref: *845 + repository: *838 sender: *4 required: - action @@ -128375,7 +127267,7 @@ x-webhooks: required: - login - id - dismissed_comment: *537 + dismissed_comment: *530 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -128541,12 +127433,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *844 + enterprise: *835 + installation: *836 + organization: *837 + ref: *845 + repository: *838 sender: *4 required: - action @@ -128646,7 +127538,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *537 + dismissed_comment: *530 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -128814,16 +127706,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *847 + repository: *838 sender: *4 required: - action @@ -128920,7 +127812,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *537 + dismissed_comment: *530 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -129060,12 +127952,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *844 + enterprise: *835 + installation: *836 + organization: *837 + ref: *845 + repository: *838 sender: *4 required: - action @@ -129322,10 +128214,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -129405,18 +128297,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *846 - pusher_type: &855 + organization: *837 + pusher_type: &846 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &856 + ref: &847 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -129426,7 +128318,7 @@ x-webhooks: enum: - tag - branch - repository: *847 + repository: *838 sender: *4 required: - ref @@ -129509,9 +128401,9 @@ x-webhooks: enum: - created definition: *152 - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 sender: *4 required: - action @@ -129596,9 +128488,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 sender: *4 required: - action @@ -129676,9 +128568,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *152 - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 sender: *4 required: - action @@ -129756,9 +128648,9 @@ x-webhooks: enum: - updated definition: *152 - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 sender: *4 required: - action @@ -129835,10 +128727,10 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - repository: *847 - organization: *846 + enterprise: *835 + installation: *836 + repository: *838 + organization: *837 sender: *4 new_property_values: type: array @@ -129923,18 +128815,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - pusher_type: *855 - ref: *856 + enterprise: *835 + installation: *836 + organization: *837 + pusher_type: *846 + ref: *847 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *847 + repository: *838 sender: *4 required: - ref @@ -130018,11 +128910,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *586 + installation: *836 + organization: *837 + enterprise: *835 + repository: *838 sender: *4 required: - action @@ -130106,11 +128998,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *586 + installation: *836 + organization: *837 + enterprise: *835 + repository: *838 sender: *4 required: - action @@ -130194,11 +129086,11 @@ x-webhooks: type: string enum: - created - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *586 + installation: *836 + organization: *837 + enterprise: *835 + repository: *838 sender: *4 required: - action @@ -130280,11 +129172,11 @@ x-webhooks: type: string enum: - dismissed - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *586 + installation: *836 + organization: *837 + enterprise: *835 + repository: *838 sender: *4 required: - action @@ -130366,11 +129258,11 @@ x-webhooks: type: string enum: - fixed - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *586 + installation: *836 + organization: *837 + enterprise: *835 + repository: *838 sender: *4 required: - action @@ -130453,11 +129345,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *586 + installation: *836 + organization: *837 + enterprise: *835 + repository: *838 sender: *4 required: - action @@ -130539,11 +129431,11 @@ x-webhooks: type: string enum: - reopened - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *586 + installation: *836 + organization: *837 + enterprise: *835 + repository: *838 sender: *4 required: - action @@ -130620,9 +129512,9 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - key: &857 + enterprise: *835 + installation: *836 + key: &848 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -130658,8 +129550,8 @@ x-webhooks: - verified - created_at - read_only - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -130736,11 +129628,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - key: *857 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + key: *848 + organization: *837 + repository: *838 sender: *4 required: - action @@ -131301,12 +130193,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - workflow: &861 + workflow: &852 title: Workflow type: object nullable: true @@ -132032,13 +130924,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *599 + deployment: *592 pull_requests: type: array - items: *695 - repository: *847 - organization: *846 - installation: *845 + items: *688 + repository: *838 + organization: *837 + installation: *836 sender: *4 responses: '200': @@ -132109,7 +131001,7 @@ x-webhooks: type: string enum: - approved - approver: &858 + approver: &849 type: object properties: avatar_url: @@ -132152,11 +131044,11 @@ x-webhooks: type: string comment: type: string - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - reviewers: &859 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + reviewers: &850 type: array items: type: object @@ -132235,7 +131127,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &860 + workflow_job_run: &851 type: object properties: conclusion: @@ -132966,18 +131858,18 @@ x-webhooks: type: string enum: - rejected - approver: *858 + approver: *849 comment: type: string - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - reviewers: *859 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + reviewers: *850 sender: *4 since: type: string - workflow_job_run: *860 + workflow_job_run: *851 workflow_job_runs: type: array items: @@ -133681,13 +132573,13 @@ x-webhooks: type: string enum: - requested - enterprise: *844 + enterprise: *835 environment: type: string - installation: *845 - organization: *846 - repository: *847 - requestor: &871 + installation: *836 + organization: *837 + repository: *838 + requestor: &862 title: User type: object nullable: true @@ -135586,12 +134478,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - workflow: *861 + workflow: *852 workflow_run: title: Deployment Workflow Run type: object @@ -136271,7 +135163,7 @@ x-webhooks: type: string enum: - answered - answer: &864 + answer: &855 type: object properties: author_association: @@ -136428,7 +135320,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &862 + discussion: &853 title: Discussion description: A Discussion in a repository. type: object @@ -136714,7 +135606,7 @@ x-webhooks: - id labels: type: array - items: *657 + items: *650 required: - repository_url - category @@ -136736,10 +135628,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -136866,11 +135758,11 @@ x-webhooks: - from required: - category - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -136953,11 +135845,11 @@ x-webhooks: type: string enum: - closed - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -137039,7 +135931,7 @@ x-webhooks: type: string enum: - created - comment: &863 + comment: &854 type: object properties: author_association: @@ -137196,11 +136088,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -137283,12 +136175,12 @@ x-webhooks: type: string enum: - deleted - comment: *863 - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + comment: *854 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -137383,12 +136275,12 @@ x-webhooks: - from required: - body - comment: *863 - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + comment: *854 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -137472,11 +136364,11 @@ x-webhooks: type: string enum: - created - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -137558,11 +136450,11 @@ x-webhooks: type: string enum: - deleted - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -137662,11 +136554,11 @@ x-webhooks: type: string required: - from - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -137748,10 +136640,10 @@ x-webhooks: type: string enum: - labeled - discussion: *862 - enterprise: *844 - installation: *845 - label: &865 + discussion: *853 + enterprise: *835 + installation: *836 + label: &856 title: Label type: object properties: @@ -137783,8 +136675,8 @@ x-webhooks: - color - default - description - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -137867,11 +136759,11 @@ x-webhooks: type: string enum: - locked - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -137953,11 +136845,11 @@ x-webhooks: type: string enum: - pinned - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -138039,11 +136931,11 @@ x-webhooks: type: string enum: - reopened - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -138128,16 +137020,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *862 - new_repository: *847 + new_discussion: *853 + new_repository: *838 required: - new_discussion - new_repository - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -138220,10 +137112,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *862 - old_answer: *864 - organization: *846 - repository: *847 + discussion: *853 + old_answer: *855 + organization: *837 + repository: *838 sender: *4 required: - action @@ -138305,12 +137197,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *862 - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + label: *856 + organization: *837 + repository: *838 sender: *4 required: - action @@ -138393,11 +137285,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -138479,11 +137371,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -138552,7 +137444,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *857 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138615,7 +137507,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *858 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138681,7 +137573,7 @@ x-webhooks: required: true content: application/json: - schema: *868 + schema: *859 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138747,7 +137639,7 @@ x-webhooks: required: true content: application/json: - schema: *869 + schema: *860 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138813,7 +137705,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *857 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138879,7 +137771,7 @@ x-webhooks: required: true content: application/json: - schema: *870 + schema: *861 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138945,7 +137837,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *858 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139010,7 +137902,7 @@ x-webhooks: required: true content: application/json: - schema: *868 + schema: *859 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139075,7 +137967,7 @@ x-webhooks: required: true content: application/json: - schema: *869 + schema: *860 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139140,7 +138032,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *857 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139205,7 +138097,7 @@ x-webhooks: required: true content: application/json: - schema: *870 + schema: *861 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139271,7 +138163,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *858 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139338,7 +138230,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *844 + enterprise: *835 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -139998,9 +138890,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *845 - organization: *846 - repository: *847 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - forkee @@ -140146,9 +139038,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 pages: description: The pages that were updated. type: array @@ -140185,7 +139077,7 @@ x-webhooks: - action - sha - html_url - repository: *847 + repository: *838 sender: *4 required: - pages @@ -140261,10 +139153,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 + enterprise: *835 installation: *22 - organization: *846 - repositories: &872 + organization: *837 + repositories: &863 description: An array of repository objects that the installation can access. type: array @@ -140290,8 +139182,8 @@ x-webhooks: - name - full_name - private - repository: *847 - requester: *871 + repository: *838 + requester: *862 sender: *4 required: - action @@ -140366,11 +139258,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 + enterprise: *835 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *837 + repositories: *863 + repository: *838 requester: nullable: true sender: *4 @@ -140446,11 +139338,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *844 + enterprise: *835 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *837 + repositories: *863 + repository: *838 requester: nullable: true sender: *4 @@ -140526,10 +139418,10 @@ x-webhooks: type: string enum: - added - enterprise: *844 + enterprise: *835 installation: *22 - organization: *846 - repositories_added: &873 + organization: *837 + repositories_added: &864 description: An array of repository objects, which were added to the installation. type: array @@ -140575,15 +139467,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *847 - repository_selection: &874 + repository: *838 + repository_selection: &865 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *871 + requester: *862 sender: *4 required: - action @@ -140662,10 +139554,10 @@ x-webhooks: type: string enum: - removed - enterprise: *844 + enterprise: *835 installation: *22 - organization: *846 - repositories_added: *873 + organization: *837 + repositories_added: *864 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -140692,9 +139584,9 @@ x-webhooks: - name - full_name - private - repository: *847 - repository_selection: *874 - requester: *871 + repository: *838 + repository_selection: *865 + requester: *862 sender: *4 required: - action @@ -140773,11 +139665,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *844 + enterprise: *835 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *837 + repositories: *863 + repository: *838 requester: nullable: true sender: *4 @@ -140956,10 +139848,10 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 target_type: type: string @@ -141038,11 +139930,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *844 + enterprise: *835 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *837 + repositories: *863 + repository: *838 requester: nullable: true sender: *4 @@ -141294,8 +140186,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -142089,8 +140981,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142439,8 +141331,8 @@ x-webhooks: - state - locked - assignee - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -142520,7 +141412,7 @@ x-webhooks: type: string enum: - deleted - comment: &875 + comment: &866 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -142685,8 +141577,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -143476,8 +142368,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143828,8 +142720,8 @@ x-webhooks: - state - locked - assignee - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -143909,7 +142801,7 @@ x-webhooks: type: string enum: - edited - changes: &904 + changes: &895 description: The changes to the comment. type: object properties: @@ -143921,9 +142813,9 @@ x-webhooks: type: string required: - from - comment: *875 - enterprise: *844 - installation: *845 + comment: *866 + enterprise: *835 + installation: *836 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -144716,8 +143608,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145066,8 +143958,8 @@ x-webhooks: - state - locked - assignee - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -145157,9 +144049,9 @@ x-webhooks: type: number blocking_issue: *227 blocking_issue_repo: *74 - installation: *845 - organization: *846 - repository: *847 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -145253,9 +144145,9 @@ x-webhooks: type: number blocking_issue: *227 blocking_issue_repo: *74 - installation: *845 - organization: *846 - repository: *847 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -145348,9 +144240,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -145444,9 +144336,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -145531,10 +144423,10 @@ x-webhooks: type: string enum: - assigned - assignee: *871 - enterprise: *844 - installation: *845 - issue: &878 + assignee: *862 + enterprise: *835 + installation: *836 + issue: &869 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -146323,11 +145215,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146444,8 +145336,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -146525,8 +145417,8 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -147320,11 +146212,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147576,8 +146468,8 @@ x-webhooks: required: - state - closed_at - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -147656,8 +146548,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -148442,11 +147334,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148562,8 +147454,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -148642,8 +147534,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -149450,11 +148342,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149549,7 +148441,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &876 + milestone: &867 title: Milestone description: A collection of related issues and pull requests. type: object @@ -149687,8 +148579,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -149787,8 +148679,8 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -150577,11 +149469,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150698,9 +149590,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *865 - organization: *846 - repository: *847 + label: *856 + organization: *837 + repository: *838 sender: *4 required: - action @@ -150780,8 +149672,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -151569,11 +150461,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151690,9 +150582,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *865 - organization: *846 - repository: *847 + label: *856 + organization: *837 + repository: *838 sender: *4 required: - action @@ -151772,8 +150664,8 @@ x-webhooks: type: string enum: - locked - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -152585,11 +151477,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152683,8 +151575,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -152763,8 +151655,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -153570,11 +152462,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153668,9 +152560,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *876 - organization: *846 - repository: *847 + milestone: *867 + organization: *837 + repository: *838 sender: *4 required: - action @@ -154538,11 +153430,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155104,8 +153996,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -155894,11 +154786,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156014,8 +154906,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -156095,9 +154987,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *844 - installation: *845 - issue: &877 + enterprise: *835 + installation: *836 + issue: &868 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -156880,11 +155772,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157000,8 +155892,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -157080,8 +155972,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -157891,11 +156783,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157990,8 +156882,8 @@ x-webhooks: user_view_type: type: string type: *360 - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -158857,11 +157749,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159445,11 +158337,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *844 - installation: *845 - issue: *877 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + issue: *868 + organization: *837 + repository: *838 sender: *4 required: - action @@ -159529,12 +158421,12 @@ x-webhooks: type: string enum: - typed - enterprise: *844 - installation: *845 - issue: *878 + enterprise: *835 + installation: *836 + issue: *869 type: *360 - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -159615,7 +158507,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &907 + assignee: &898 title: User type: object nullable: true @@ -159685,11 +158577,11 @@ x-webhooks: required: - login - id - enterprise: *844 - installation: *845 - issue: *878 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + issue: *869 + organization: *837 + repository: *838 sender: *4 required: - action @@ -159768,12 +158660,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *844 - installation: *845 - issue: *878 - label: *865 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + issue: *869 + label: *856 + organization: *837 + repository: *838 sender: *4 required: - action @@ -159853,8 +158745,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -160664,11 +159556,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160762,8 +159654,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -160843,11 +159735,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *844 - installation: *845 - issue: *877 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + issue: *868 + organization: *837 + repository: *838 sender: *4 required: - action @@ -160926,12 +159818,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *844 - installation: *845 - issue: *878 + enterprise: *835 + installation: *836 + issue: *869 type: *360 - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -161011,11 +159903,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + label: *856 + organization: *837 + repository: *838 sender: *4 required: - action @@ -161093,11 +159985,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + label: *856 + organization: *837 + repository: *838 sender: *4 required: - action @@ -161207,11 +160099,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + label: *856 + organization: *837 + repository: *838 sender: *4 required: - action @@ -161293,9 +160185,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: &879 + enterprise: *835 + installation: *836 + marketplace_purchase: &870 title: Marketplace Purchase type: object required: @@ -161378,8 +160270,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *846 - previous_marketplace_purchase: &880 + organization: *837 + previous_marketplace_purchase: &871 title: Marketplace Purchase type: object properties: @@ -161459,7 +160351,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *847 + repository: *838 sender: *4 required: - action @@ -161539,10 +160431,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: *879 - organization: *846 + enterprise: *835 + installation: *836 + marketplace_purchase: *870 + organization: *837 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -161625,7 +160517,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *847 + repository: *838 sender: *4 required: - action @@ -161707,10 +160599,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: *879 - organization: *846 + enterprise: *835 + installation: *836 + marketplace_purchase: *870 + organization: *837 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -161792,7 +160684,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *847 + repository: *838 sender: *4 required: - action @@ -161873,8 +160765,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 marketplace_purchase: title: Marketplace Purchase type: object @@ -161956,9 +160848,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *846 - previous_marketplace_purchase: *880 - repository: *847 + organization: *837 + previous_marketplace_purchase: *871 + repository: *838 sender: *4 required: - action @@ -162038,12 +160930,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: *879 - organization: *846 - previous_marketplace_purchase: *880 - repository: *847 + enterprise: *835 + installation: *836 + marketplace_purchase: *870 + organization: *837 + previous_marketplace_purchase: *871 + repository: *838 sender: *4 required: - action @@ -162145,11 +161037,11 @@ x-webhooks: type: string required: - to - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + member: *862 + organization: *837 + repository: *838 sender: *4 required: - action @@ -162249,11 +161141,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + member: *862 + organization: *837 + repository: *838 sender: *4 required: - action @@ -162332,11 +161224,11 @@ x-webhooks: type: string enum: - removed - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + member: *862 + organization: *837 + repository: *838 sender: *4 required: - action @@ -162414,11 +161306,11 @@ x-webhooks: type: string enum: - added - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + member: *862 + organization: *837 + repository: *838 scope: description: The scope of the membership. Currently, can only be `team`. @@ -162494,7 +161386,7 @@ x-webhooks: required: - login - id - team: &881 + team: &872 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -162717,11 +161609,11 @@ x-webhooks: type: string enum: - removed - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + member: *862 + organization: *837 + repository: *838 scope: description: The scope of the membership. Currently, can only be `team`. @@ -162798,7 +161690,7 @@ x-webhooks: required: - login - id - team: *881 + team: *872 required: - action - scope @@ -162880,8 +161772,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *845 - merge_group: &883 + installation: *836 + merge_group: &874 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -162900,15 +161792,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *882 + head_commit: *873 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -162994,10 +161886,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *845 - merge_group: *883 - organization: *846 - repository: *847 + installation: *836 + merge_group: *874 + organization: *837 + repository: *838 sender: *4 required: - action @@ -163070,7 +161962,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 + enterprise: *835 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -163179,16 +162071,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *845 - organization: *846 + installation: *836 + organization: *837 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *875 + required: *876 nullable: true sender: *4 required: @@ -163269,11 +162161,11 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 - milestone: *876 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + milestone: *867 + organization: *837 + repository: *838 sender: *4 required: - action @@ -163352,9 +162244,9 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - milestone: &886 + enterprise: *835 + installation: *836 + milestone: &877 title: Milestone description: A collection of related issues and pull requests. type: object @@ -163491,8 +162383,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -163571,11 +162463,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - milestone: *876 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + milestone: *867 + organization: *837 + repository: *838 sender: *4 required: - action @@ -163685,11 +162577,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - milestone: *876 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + milestone: *867 + organization: *837 + repository: *838 sender: *4 required: - action @@ -163769,11 +162661,11 @@ x-webhooks: type: string enum: - opened - enterprise: *844 - installation: *845 - milestone: *886 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + milestone: *877 + organization: *837 + repository: *838 sender: *4 required: - action @@ -163852,11 +162744,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *871 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + blocked_user: *862 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -163935,11 +162827,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *871 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + blocked_user: *862 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -164015,7 +162907,7 @@ x-webhooks: enum: - created definition: *146 - enterprise: *844 + enterprise: *835 sender: *4 required: - action @@ -164095,8 +162987,8 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 sender: *4 required: - action @@ -164169,8 +163061,8 @@ x-webhooks: enum: - updated definition: *146 - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 sender: *4 required: - action @@ -164242,9 +163134,9 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 sender: *4 new_property_values: type: array @@ -164332,9 +163224,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - membership: &887 + enterprise: *835 + installation: *836 + membership: &878 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -164441,8 +163333,8 @@ x-webhooks: - role - organization_url - user - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -164520,11 +163412,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *844 - installation: *845 - membership: *887 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + membership: *878 + organization: *837 + repository: *838 sender: *4 required: - action @@ -164603,8 +163495,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -164720,10 +163612,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 - user: *871 + user: *862 required: - action - invitation @@ -164801,11 +163693,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *844 - installation: *845 - membership: *887 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + membership: *878 + organization: *837 + repository: *838 sender: *4 required: - action @@ -164892,11 +163784,11 @@ x-webhooks: properties: from: type: string - enterprise: *844 - installation: *845 - membership: *887 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + membership: *878 + organization: *837 + repository: *838 sender: *4 required: - action @@ -164972,9 +163864,9 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 package: description: Information about the package. type: object @@ -165473,7 +164365,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &888 + items: &879 title: Ruby Gems metadata type: object properties: @@ -165568,7 +164460,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *838 sender: *4 required: - action @@ -165644,9 +164536,9 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 package: description: Information about the package. type: object @@ -165999,7 +164891,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *888 + items: *879 source_url: type: string format: uri @@ -166069,7 +164961,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *838 sender: *4 required: - action @@ -166246,12 +165138,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *844 + enterprise: *835 id: type: integer - installation: *845 - organization: *846 - repository: *847 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - id @@ -166328,7 +165220,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &889 + personal_access_token_request: &880 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -166474,10 +165366,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *844 - organization: *846 + enterprise: *835 + organization: *837 sender: *4 - installation: *845 + installation: *836 required: - action - personal_access_token_request @@ -166554,11 +165446,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *889 - enterprise: *844 - organization: *846 + personal_access_token_request: *880 + enterprise: *835 + organization: *837 sender: *4 - installation: *845 + installation: *836 required: - action - personal_access_token_request @@ -166634,11 +165526,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *889 - enterprise: *844 - organization: *846 + personal_access_token_request: *880 + enterprise: *835 + organization: *837 sender: *4 - installation: *845 + installation: *836 required: - action - personal_access_token_request @@ -166713,11 +165605,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *889 - organization: *846 - enterprise: *844 + personal_access_token_request: *880 + organization: *837 + enterprise: *835 sender: *4 - installation: *845 + installation: *836 required: - action - personal_access_token_request @@ -166822,7 +165714,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *890 + last_response: *881 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -166854,8 +165746,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 zen: description: Random string of GitHub zen. @@ -167100,10 +165992,10 @@ x-webhooks: - from required: - note - enterprise: *844 - installation: *845 - organization: *846 - project_card: &891 + enterprise: *835 + installation: *836 + organization: *837 + project_card: &882 title: Project Card type: object properties: @@ -167222,7 +166114,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *847 + repository: *838 sender: *4 required: - action @@ -167303,11 +166195,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - project_card: *891 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + project_card: *882 + repository: *838 sender: *4 required: - action @@ -167387,9 +166279,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 project_card: title: Project Card type: object @@ -167517,8 +166409,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *875 + required: *876 nullable: true sender: *4 required: @@ -167612,11 +166504,11 @@ x-webhooks: - from required: - note - enterprise: *844 - installation: *845 - organization: *846 - project_card: *891 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + project_card: *882 + repository: *838 sender: *4 required: - action @@ -167710,9 +166602,9 @@ x-webhooks: - from required: - column_id - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 project_card: allOf: - title: Project Card @@ -167902,7 +166794,7 @@ x-webhooks: type: string required: - after_id - repository: *847 + repository: *838 sender: *4 required: - action @@ -167982,10 +166874,10 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 - organization: *846 - project: &893 + enterprise: *835 + installation: *836 + organization: *837 + project: &884 title: Project type: object properties: @@ -168109,7 +167001,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *847 + repository: *838 sender: *4 required: - action @@ -168189,10 +167081,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - project_column: &892 + enterprise: *835 + installation: *836 + organization: *837 + project_column: &883 title: Project Column type: object properties: @@ -168231,7 +167123,7 @@ x-webhooks: - name - created_at - updated_at - repository: *847 + repository: *838 sender: *4 required: - action @@ -168310,18 +167202,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - project_column: *892 + enterprise: *835 + installation: *836 + organization: *837 + project_column: *883 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *875 + required: *876 nullable: true sender: *4 required: @@ -168411,11 +167303,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - project_column: *892 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + project_column: *883 + repository: *838 sender: *4 required: - action @@ -168495,11 +167387,11 @@ x-webhooks: type: string enum: - moved - enterprise: *844 - installation: *845 - organization: *846 - project_column: *892 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + project_column: *883 + repository: *838 sender: *4 required: - action @@ -168579,11 +167471,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - project: *893 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + project: *884 + repository: *838 sender: *4 required: - action @@ -168663,18 +167555,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - project: *893 + enterprise: *835 + installation: *836 + organization: *837 + project: *884 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *875 + required: *876 nullable: true sender: *4 required: @@ -168776,11 +167668,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - project: *893 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + project: *884 + repository: *838 sender: *4 required: - action @@ -168859,11 +167751,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *844 - installation: *845 - organization: *846 - project: *893 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + project: *884 + repository: *838 sender: *4 required: - action @@ -168944,8 +167836,8 @@ x-webhooks: type: string enum: - closed - installation: *845 - organization: *846 + installation: *836 + organization: *837 projects_v2: *392 sender: *4 required: @@ -169027,8 +167919,8 @@ x-webhooks: type: string enum: - created - installation: *845 - organization: *846 + installation: *836 + organization: *837 projects_v2: *392 sender: *4 required: @@ -169110,8 +168002,8 @@ x-webhooks: type: string enum: - deleted - installation: *845 - organization: *846 + installation: *836 + organization: *837 projects_v2: *392 sender: *4 required: @@ -169229,8 +168121,8 @@ x-webhooks: type: string to: type: string - installation: *845 - organization: *846 + installation: *836 + organization: *837 projects_v2: *392 sender: *4 required: @@ -169314,7 +168206,7 @@ x-webhooks: type: string enum: - archived - changes: &897 + changes: &888 type: object properties: archived_at: @@ -169328,9 +168220,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *845 - organization: *846 - projects_v2_item: &894 + installation: *836 + organization: *837 + projects_v2_item: &885 title: Projects v2 Item description: An item belonging to a project type: object @@ -169465,9 +168357,9 @@ x-webhooks: nullable: true to: type: string - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *836 + organization: *837 + projects_v2_item: *885 sender: *4 required: - action @@ -169549,9 +168441,9 @@ x-webhooks: type: string enum: - created - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *836 + organization: *837 + projects_v2_item: *885 sender: *4 required: - action @@ -169632,9 +168524,9 @@ x-webhooks: type: string enum: - deleted - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *836 + organization: *837 + projects_v2_item: *885 sender: *4 required: - action @@ -169740,7 +168632,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &895 + - &886 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -169762,7 +168654,7 @@ x-webhooks: required: - id - name - - &896 + - &887 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -169796,8 +168688,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *895 - - *896 + - *886 + - *887 required: - field_value - type: object @@ -169813,9 +168705,9 @@ x-webhooks: nullable: true required: - body - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *836 + organization: *837 + projects_v2_item: *885 sender: *4 required: - action @@ -169910,9 +168802,9 @@ x-webhooks: to: type: string nullable: true - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *836 + organization: *837 + projects_v2_item: *885 sender: *4 required: - action @@ -169995,10 +168887,10 @@ x-webhooks: type: string enum: - restored - changes: *897 - installation: *845 - organization: *846 - projects_v2_item: *894 + changes: *888 + installation: *836 + organization: *837 + projects_v2_item: *885 sender: *4 required: - action @@ -170080,8 +168972,8 @@ x-webhooks: type: string enum: - reopened - installation: *845 - organization: *846 + installation: *836 + organization: *837 projects_v2: *392 sender: *4 required: @@ -170163,14 +169055,14 @@ x-webhooks: type: string enum: - created - installation: *845 - organization: *846 - projects_v2_status_update: &900 + installation: *836 + organization: *837 + projects_v2_status_update: &891 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *898 - required: *899 + properties: *889 + required: *890 sender: *4 required: - action @@ -170251,9 +169143,9 @@ x-webhooks: type: string enum: - deleted - installation: *845 - organization: *846 - projects_v2_status_update: *900 + installation: *836 + organization: *837 + projects_v2_status_update: *891 sender: *4 required: - action @@ -170389,9 +169281,9 @@ x-webhooks: type: string format: date nullable: true - installation: *845 - organization: *846 - projects_v2_status_update: *900 + installation: *836 + organization: *837 + projects_v2_status_update: *891 sender: *4 required: - action @@ -170462,10 +169354,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - repository @@ -170542,13 +169434,13 @@ x-webhooks: type: string enum: - assigned - assignee: *871 - enterprise: *844 - installation: *845 - number: &901 + assignee: *862 + enterprise: *835 + installation: *836 + number: &892 description: The pull request number. type: integer - organization: *846 + organization: *837 pull_request: title: Pull Request type: object @@ -172831,7 +171723,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 sender: *4 required: - action @@ -172913,11 +171805,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 number: type: integer - organization: *846 + organization: *837 pull_request: title: Pull Request type: object @@ -175195,7 +174087,7 @@ x-webhooks: - draft reason: type: string - repository: *847 + repository: *838 sender: *4 required: - action @@ -175277,11 +174169,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 number: type: integer - organization: *846 + organization: *837 pull_request: title: Pull Request type: object @@ -177559,7 +176451,7 @@ x-webhooks: - draft reason: type: string - repository: *847 + repository: *838 sender: *4 required: - action @@ -177641,13 +176533,13 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: &902 + enterprise: *835 + installation: *836 + number: *892 + organization: *837 + pull_request: &893 allOf: - - *695 + - *688 - type: object properties: allow_auto_merge: @@ -177709,7 +176601,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *847 + repository: *838 sender: *4 required: - action @@ -177790,12 +176682,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *835 + installation: *836 + number: *892 + organization: *837 + pull_request: *893 + repository: *838 sender: *4 required: - action @@ -177875,11 +176767,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *844 - milestone: *677 - number: *901 - organization: *846 - pull_request: &903 + enterprise: *835 + milestone: *670 + number: *892 + organization: *837 + pull_request: &894 title: Pull Request type: object properties: @@ -180142,7 +179034,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 sender: *4 required: - action @@ -180221,11 +179113,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 number: type: integer - organization: *846 + organization: *837 pull_request: title: Pull Request type: object @@ -182507,7 +181399,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *847 + repository: *838 sender: *4 required: - action @@ -182631,12 +181523,12 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *835 + installation: *836 + number: *892 + organization: *837 + pull_request: *893 + repository: *838 sender: *4 required: - action @@ -182716,11 +181608,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 number: type: integer - organization: *846 + organization: *837 pull_request: title: Pull Request type: object @@ -184987,7 +183879,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 sender: *4 required: - action @@ -185067,11 +183959,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *844 - installation: *845 - label: *865 - number: *901 - organization: *846 + enterprise: *835 + installation: *836 + label: *856 + number: *892 + organization: *837 pull_request: title: Pull Request type: object @@ -187353,7 +186245,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 sender: *4 required: - action @@ -187434,10 +186326,10 @@ x-webhooks: type: string enum: - locked - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + enterprise: *835 + installation: *836 + number: *892 + organization: *837 pull_request: title: Pull Request type: object @@ -189717,7 +188609,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 sender: *4 required: - action @@ -189797,12 +188689,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *844 - milestone: *677 - number: *901 - organization: *846 - pull_request: *903 - repository: *847 + enterprise: *835 + milestone: *670 + number: *892 + organization: *837 + pull_request: *894 + repository: *838 sender: *4 required: - action @@ -189881,12 +188773,12 @@ x-webhooks: type: string enum: - opened - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *835 + installation: *836 + number: *892 + organization: *837 + pull_request: *893 + repository: *838 sender: *4 required: - action @@ -189967,12 +188859,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *835 + installation: *836 + number: *892 + organization: *837 + pull_request: *893 + repository: *838 sender: *4 required: - action @@ -190052,12 +188944,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *835 + installation: *836 + number: *892 + organization: *837 + pull_request: *893 + repository: *838 sender: *4 required: - action @@ -190423,9 +189315,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 pull_request: type: object properties: @@ -192595,7 +191487,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *847 + repository: *838 sender: *4 required: - action @@ -192675,7 +191567,7 @@ x-webhooks: type: string enum: - deleted - comment: &905 + comment: &896 title: Pull Request Review Comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -192960,9 +191852,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 pull_request: type: object properties: @@ -195120,7 +194012,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *847 + repository: *838 sender: *4 required: - action @@ -195200,11 +194092,11 @@ x-webhooks: type: string enum: - edited - changes: *904 - comment: *905 - enterprise: *844 - installation: *845 - organization: *846 + changes: *895 + comment: *896 + enterprise: *835 + installation: *836 + organization: *837 pull_request: type: object properties: @@ -197365,7 +196257,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *847 + repository: *838 sender: *4 required: - action @@ -197446,9 +196338,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 pull_request: title: Simple Pull Request type: object @@ -199621,7 +198513,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 + repository: *838 review: description: The review that was affected. type: object @@ -199868,9 +198760,9 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 pull_request: title: Simple Pull Request type: object @@ -201924,8 +200816,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 - review: &906 + repository: *838 + review: &897 description: The review that was affected. type: object properties: @@ -202158,12 +201050,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 number: description: The pull request number. type: integer - organization: *846 + organization: *837 pull_request: title: Pull Request type: object @@ -204446,7 +203338,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 requested_reviewer: title: User type: object @@ -204530,12 +203422,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 number: description: The pull request number. type: integer - organization: *846 + organization: *837 pull_request: title: Pull Request type: object @@ -206825,7 +205717,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 requested_team: title: Team description: Groups of organization members that gives permissions @@ -207017,12 +205909,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 number: description: The pull request number. type: integer - organization: *846 + organization: *837 pull_request: title: Pull Request type: object @@ -209307,7 +208199,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 requested_reviewer: title: User type: object @@ -209392,12 +208284,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 number: description: The pull request number. type: integer - organization: *846 + organization: *837 pull_request: title: Pull Request type: object @@ -211673,7 +210565,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 requested_team: title: Team description: Groups of organization members that gives permissions @@ -211854,9 +210746,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 pull_request: title: Simple Pull Request type: object @@ -214031,8 +212923,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 - review: *906 + repository: *838 + review: *897 sender: *4 required: - action @@ -214112,9 +213004,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 pull_request: title: Simple Pull Request type: object @@ -216184,7 +215076,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 + repository: *838 sender: *4 thread: type: object @@ -216571,9 +215463,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 pull_request: title: Simple Pull Request type: object @@ -218629,7 +217521,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 + repository: *838 sender: *4 thread: type: object @@ -219019,10 +217911,10 @@ x-webhooks: type: string before: type: string - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + enterprise: *835 + installation: *836 + number: *892 + organization: *837 pull_request: title: Pull Request type: object @@ -221293,7 +220185,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 sender: *4 required: - action @@ -221375,11 +220267,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *907 - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + assignee: *898 + enterprise: *835 + installation: *836 + number: *892 + organization: *837 pull_request: title: Pull Request type: object @@ -223662,7 +222554,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 sender: *4 required: - action @@ -223741,11 +222633,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *844 - installation: *845 - label: *865 - number: *901 - organization: *846 + enterprise: *835 + installation: *836 + label: *856 + number: *892 + organization: *837 pull_request: title: Pull Request type: object @@ -226018,7 +224910,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 sender: *4 required: - action @@ -226099,10 +224991,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + enterprise: *835 + installation: *836 + number: *892 + organization: *837 pull_request: title: Pull Request type: object @@ -228367,7 +227259,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 sender: *4 required: - action @@ -228567,7 +227459,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *844 + enterprise: *835 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -228659,8 +227551,8 @@ x-webhooks: - url - author - committer - installation: *845 - organization: *846 + installation: *836 + organization: *837 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -229235,9 +228127,9 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 registry_package: type: object properties: @@ -229683,7 +228575,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *888 + items: *879 summary: type: string tag_name: @@ -229737,7 +228629,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *838 sender: *4 required: - action @@ -229815,9 +228707,9 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 registry_package: type: object properties: @@ -230125,7 +229017,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *888 + items: *879 summary: type: string tag_name: @@ -230174,7 +229066,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *838 sender: *4 required: - action @@ -230251,10 +229143,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - release: &908 + enterprise: *835 + installation: *836 + organization: *837 + release: &899 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -230572,7 +229464,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *847 + repository: *838 sender: *4 required: - action @@ -230649,11 +229541,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - release: *908 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + release: *899 + repository: *838 sender: *4 required: - action @@ -230770,11 +229662,11 @@ x-webhooks: type: boolean required: - to - enterprise: *844 - installation: *845 - organization: *846 - release: *908 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + release: *899 + repository: *838 sender: *4 required: - action @@ -230852,9 +229744,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -231176,7 +230068,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *847 + repository: *838 sender: *4 required: - action @@ -231252,10 +230144,10 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 - release: &909 + enterprise: *835 + installation: *836 + organization: *837 + release: &900 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -231574,7 +230466,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *847 + repository: *838 sender: *4 required: - action @@ -231650,11 +230542,11 @@ x-webhooks: type: string enum: - released - enterprise: *844 - installation: *845 - organization: *846 - release: *908 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + release: *899 + repository: *838 sender: *4 required: - action @@ -231730,11 +230622,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *844 - installation: *845 - organization: *846 - release: *909 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + release: *900 + repository: *838 sender: *4 required: - action @@ -231810,11 +230702,11 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - repository_advisory: *748 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + repository_advisory: *741 sender: *4 required: - action @@ -231890,11 +230782,11 @@ x-webhooks: type: string enum: - reported - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - repository_advisory: *748 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + repository_advisory: *741 sender: *4 required: - action @@ -231970,10 +230862,10 @@ x-webhooks: type: string enum: - archived - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -232050,10 +230942,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -232131,10 +231023,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -232218,10 +231110,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -232333,10 +231225,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -232408,10 +231300,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 status: type: string @@ -232492,10 +231384,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -232572,10 +231464,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -232669,10 +231561,10 @@ x-webhooks: - name required: - repository - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -232752,10 +231644,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 repository_ruleset: *185 sender: *4 required: @@ -232834,10 +231726,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 repository_ruleset: *185 sender: *4 required: @@ -232916,10 +231808,10 @@ x-webhooks: type: string enum: - edited - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 repository_ruleset: *185 changes: type: object @@ -232981,16 +231873,16 @@ x-webhooks: properties: added: type: array - items: *716 + items: *709 deleted: type: array - items: *716 + items: *709 updated: type: array items: type: object properties: - rule: *716 + rule: *709 changes: type: object properties: @@ -233224,10 +232116,10 @@ x-webhooks: - from required: - owner - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -233305,10 +232197,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -233386,7 +232278,7 @@ x-webhooks: type: string enum: - create - alert: &910 + alert: &901 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -233507,10 +232399,10 @@ x-webhooks: type: string enum: - open - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -233716,10 +232608,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -233797,11 +232689,11 @@ x-webhooks: type: string enum: - reopen - alert: *910 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *901 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -234000,10 +232892,10 @@ x-webhooks: enum: - fixed - open - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -234021,7 +232913,7 @@ x-webhooks: supported-webhook-types: - repository - organization - secret-scanning-alert-created: + secret-scanning-alert-assigned: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. @@ -234029,8 +232921,8 @@ x-webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was created. - operationId: secret-scanning-alert/created + description: A secret scanning alert was assigned. + operationId: secret-scanning-alert/assigned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -234074,14 +232966,14 @@ x-webhooks: content: application/json: schema: - title: secret_scanning_alert created event + title: secret_scanning_alert assigned event type: object properties: action: type: string enum: - - created - alert: &911 + - assigned + alert: &902 type: object properties: number: *123 @@ -234199,10 +233091,93 @@ x-webhooks: properties: *20 required: *21 nullable: true - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + assignee: *4 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-created: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was created. + operationId: secret-scanning-alert/created + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: secret_scanning_alert created event + type: object + properties: + action: + type: string + enum: + - created + alert: *902 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -234283,11 +233258,11 @@ x-webhooks: type: string enum: - created - alert: *911 - installation: *845 - location: *912 - organization: *846 - repository: *847 + alert: *902 + installation: *836 + location: *903 + organization: *837 + repository: *838 sender: *4 required: - location @@ -234525,11 +233500,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *902 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -234607,11 +233582,11 @@ x-webhooks: type: string enum: - reopened - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *902 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -234689,11 +233664,94 @@ x-webhooks: type: string enum: - resolved - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *902 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-unassigned: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was unassigned. + operationId: secret-scanning-alert/unassigned + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: secret_scanning_alert unassigned event + type: object + properties: + action: + type: string + enum: + - unassigned + alert: *902 + assignee: *4 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -234771,11 +233829,11 @@ x-webhooks: type: string enum: - validated - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *902 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -234901,10 +233959,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *847 - enterprise: *844 - installation: *845 - organization: *846 + repository: *838 + enterprise: *835 + installation: *836 + organization: *837 sender: *4 required: - action @@ -234982,11 +234040,11 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - security_advisory: &913 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + security_advisory: &904 description: The details of the security advisory, including summary, description, and severity. type: object @@ -235169,11 +234227,11 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - security_advisory: *913 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + security_advisory: *904 sender: *4 required: - action @@ -235246,10 +234304,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -235434,10 +234492,10 @@ x-webhooks: type: object properties: security_and_analysis: *408 - enterprise: *844 - installation: *845 - organization: *846 - repository: *467 + enterprise: *835 + installation: *836 + organization: *837 + repository: *460 sender: *4 required: - changes @@ -235515,12 +234573,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - sponsorship: &914 + sponsorship: &905 type: object properties: created_at: @@ -235821,12 +234879,12 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - sponsorship: *914 + sponsorship: *905 required: - action - sponsorship @@ -235914,12 +234972,12 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - sponsorship: *914 + sponsorship: *905 required: - action - changes @@ -235996,17 +235054,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &915 + effective_date: &906 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - sponsorship: *914 + sponsorship: *905 required: - action - sponsorship @@ -236080,7 +235138,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &916 + changes: &907 type: object properties: tier: @@ -236124,13 +235182,13 @@ x-webhooks: - from required: - tier - effective_date: *915 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + effective_date: *906 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - sponsorship: *914 + sponsorship: *905 required: - action - changes @@ -236207,13 +235265,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *916 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + changes: *907 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - sponsorship: *914 + sponsorship: *905 required: - action - changes @@ -236287,10 +235345,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -236373,10 +235431,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -236796,15 +235854,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *844 + enterprise: *835 id: description: The unique identifier of the status. type: integer - installation: *845 + installation: *836 name: type: string - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 sha: description: The Commit SHA. @@ -236919,9 +235977,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -237011,9 +236069,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -237103,9 +236161,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -237195,9 +236253,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -237274,12 +236332,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - team: &917 + team: &908 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -237502,9 +236560,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 repository: title: Repository description: A git repository @@ -237962,7 +237020,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *908 required: - action - team @@ -238038,9 +237096,9 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 repository: title: Repository description: A git repository @@ -238498,7 +237556,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *908 required: - action - team @@ -238575,9 +237633,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 repository: title: Repository description: A git repository @@ -239035,7 +238093,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *908 required: - action - team @@ -239179,9 +238237,9 @@ x-webhooks: - from required: - permissions - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 repository: title: Repository description: A git repository @@ -239639,7 +238697,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *908 required: - action - changes @@ -239717,9 +238775,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 repository: title: Repository description: A git repository @@ -240177,7 +239235,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *908 required: - action - team @@ -240253,10 +239311,10 @@ x-webhooks: type: string enum: - started - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -240329,16 +239387,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *844 + enterprise: *835 inputs: type: object nullable: true additionalProperties: true - installation: *845 - organization: *846 + installation: *836 + organization: *837 ref: type: string - repository: *847 + repository: *838 sender: *4 workflow: type: string @@ -240420,10 +239478,10 @@ x-webhooks: type: string enum: - completed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 workflow_job: allOf: @@ -240660,7 +239718,7 @@ x-webhooks: type: string required: - conclusion - deployment: *599 + deployment: *592 required: - action - repository @@ -240739,10 +239797,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 workflow_job: allOf: @@ -241002,7 +240060,7 @@ x-webhooks: required: - status - steps - deployment: *599 + deployment: *592 required: - action - repository @@ -241081,10 +240139,10 @@ x-webhooks: type: string enum: - queued - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 workflow_job: type: object @@ -241219,7 +240277,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *599 + deployment: *592 required: - action - repository @@ -241298,10 +240356,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 workflow_job: type: object @@ -241437,7 +240495,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *599 + deployment: *592 required: - action - repository @@ -241517,12 +240575,12 @@ x-webhooks: type: string enum: - completed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - workflow: *861 + workflow: *852 workflow_run: title: Workflow Run type: object @@ -242521,12 +241579,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - workflow: *861 + workflow: *852 workflow_run: title: Workflow Run type: object @@ -243510,12 +242568,12 @@ x-webhooks: type: string enum: - requested - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - workflow: *861 + workflow: *852 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index cf7f65190..3224a3dee 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -104,10 +104,6 @@ "name": "packages", "description": "Manage packages for authenticated users and organizations." }, - { - "name": "projects-classic", - "description": "Interact with GitHub Projects (classic)." - }, { "name": "pulls", "description": "Interact with GitHub Pull Requests." @@ -4734,6 +4730,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -5735,6 +5739,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -6590,6 +6602,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -7076,6 +7096,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -9117,6 +9145,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -10169,6 +10205,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -11138,6 +11182,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -11818,6 +11870,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -27409,6 +27469,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -28205,6 +28273,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -29157,6 +29233,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -30500,6 +30584,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -59354,6 +59446,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "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.", @@ -63078,226 +63193,20 @@ "update-budget": { "value": { "message": "Budget successfully updated.", - "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" - } - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Budget not found or feature not enabled", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - }, - "examples": { - "budget-not-found": { - "value": { - "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - }, - "feature-not-enabled": { - "value": { - "message": "Not Found", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } + "budget": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "org-name/example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] } } } @@ -63306,146 +63215,367 @@ } } }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - }, - "examples": { - "server-error": { - "value": { - "message": "Unable to retrieve budget.", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - }, - "examples": { - "server-error": { - "value": { - "message": "Unable to update budget.", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": false, - "category": "billing", - "subcategory": "budgets" - } - }, - "delete": { - "summary": "Delete a budget", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDeletes a budget by ID. The authenticated user must be an enterprise admin.", - "tags": [ - "billing" - ], - "operationId": "billing/delete-budget", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#delete-a-budget" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "budget_id", - "description": "The ID corresponding to the budget.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response when deleting a budget", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "A message indicating the result of the deletion operation" - }, - "id": { - "type": "string", - "description": "The ID of the deleted budget" - } - }, - "required": [ - "message", - "id" - ] - }, - "examples": { - "default": { - "value": { - "message": "Budget successfully deleted.", - "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" - } - } - } - } - } - }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Budget not found or feature not enabled", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "budget-not-found": { + "value": { + "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + }, + "feature-not-enabled": { + "value": { + "message": "Not Found", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to retrieve budget.", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to update budget.", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "budgets" + } + }, + "delete": { + "summary": "Delete a budget", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDeletes a budget by ID. The authenticated user must be an enterprise admin.", + "tags": [ + "billing" + ], + "operationId": "billing/delete-budget", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#delete-a-budget" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "budget_id", + "description": "The ID corresponding to the budget.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response when deleting a budget", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the result of the deletion operation" + }, + "id": { + "type": "string", + "description": "The ID of the deleted budget" + } + }, + "required": [ + "message", + "id" + ] + }, + "examples": { + "default": { + "value": { + "message": "Budget successfully deleted.", + "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" + } + } + } + } + } + }, "400": { "description": "Bad Request", "content": { @@ -151668,6 +151798,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -152684,6 +152822,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -189145,21 +189291,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -218162,6 +218326,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "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.", @@ -235193,17 +235380,17 @@ } } }, - "/orgs/{org}/teams/{team_slug}/projects": { + "/orgs/{org}/teams/{team_slug}/repos": { "get": { - "summary": "List team projects", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "List team repositories", + "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", "tags": [ "teams" ], - "operationId": "teams/list-projects-in-org", + "operationId": "teams/list-repos-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories" }, "parameters": [ { @@ -235251,42 +235438,28 @@ "schema": { "type": "array", "items": { - "title": "Team Project", - "description": "A team's access to a project.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, "id": { - "type": "integer" + "type": "integer", + "format": "int64", + "example": 1296269 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { - "type": "string" - }, - "body": { "type": "string", - "nullable": true - }, - "number": { - "type": "integer" + "example": "Hello-World" }, - "state": { - "type": "string" + "full_name": { + "type": "string", + "example": "octocat/Hello-World" }, - "creator": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -235410,55 +235583,550 @@ "url" ] }, - "created_at": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, - "updated_at": { + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { "type": "string" }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { "type": "string" }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { "type": "boolean" }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, "permissions": { "type": "object", "properties": { - "read": { + "admin": { "type": "boolean" }, - "write": { + "maintain": { "type": "boolean" }, - "admin": { + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { "type": "boolean" } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + } }, "required": [ - "read", - "write", - "admin" + "url", + "html_url", + "key", + "name" ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_validity_checks": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ - "owner_url", - "url", + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", - "columns_url", "id", "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] } }, @@ -235466,17 +236134,11 @@ "default": { "value": [ { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -235496,1397 +236158,97 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": "string", - "nullable": true - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - } - } - } - } - }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - }, - "nullable": true - }, - "examples": { - "default": { - "summary": "Updates the permissions for the team to write for the project", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/teams/{team_slug}/repos": { - "get": { - "summary": "List team repositories", - "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", - "tags": [ - "teams" - ], - "operationId": "teams/list-repos-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_validity_checks": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_validity_checks": { - "status": "disabled" - } + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_validity_checks": { + "status": "disabled" + } } } ] @@ -238650,327 +238012,463 @@ "deprecated": true } }, - "/projects/columns/cards/{card_id}": { + "/rate_limit": { "get": { - "summary": "Get a project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "Get rate limit status for the authenticated user", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ - "projects-classic" + "rate-limit" ], - "operationId": "projects-classic/get-card", + "operationId": "rate-limit/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], + "parameters": [], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Rate Limit Overview", + "description": "Rate Limit Overview", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" - }, - "id": { - "description": "The project card's ID", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" - }, - "note": { - "type": "string", - "example": "Add payload for delete Project column", - "nullable": true - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", + "resources": { "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "core": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "graphql": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "code_search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "source_import": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "integration_manifest": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "code_scanning_upload": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "actions_runner_registration": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "scim": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "dependency_snapshots": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "dependency_sbom": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "type": { - "type": "string", - "example": "User" + "code_scanning_autofix": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + } + }, + "required": [ + "core", + "search" + ] + }, + "rate": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" }, - "site_admin": { - "type": "boolean" + "remaining": { + "type": "integer" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "reset": { + "type": "integer" }, - "user_view_type": { - "type": "string", - "example": "public" + "used": { + "type": "integer" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:21:06Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:20:22Z" - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "content_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" + "limit", + "remaining", + "reset", + "used" + ] } }, "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" + "rate", + "resources" ] }, "examples": { "default": { "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "resources": { + "core": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691591363 + }, + "search": { + "limit": 30, + "used": 12, + "remaining": 18, + "reset": 1691591091 + }, + "graphql": { + "limit": 5000, + "used": 7, + "remaining": 4993, + "reset": 1691593228 + }, + "integration_manifest": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691594631 + }, + "source_import": { + "limit": 100, + "used": 1, + "remaining": 99, + "reset": 1691591091 + }, + "code_scanning_upload": { + "limit": 500, + "used": 1, + "remaining": 499, + "reset": 1691594631 + }, + "actions_runner_registration": { + "limit": 10000, + "used": 0, + "remaining": 10000, + "reset": 1691594631 + }, + "scim": { + "limit": 15000, + "used": 0, + "remaining": 15000, + "reset": 1691594631 + }, + "dependency_snapshots": { + "limit": 100, + "used": 0, + "remaining": 100, + "reset": 1691591091 + }, + "code_search": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + } }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" + "rate": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1372700873 + } } } } } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { + }, + "headers": { + "X-RateLimit-Limit": { + "example": 5000, "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } + "type": "integer" } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { + }, + "X-RateLimit-Remaining": { + "example": 4999, "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } + "type": "integer" + } + }, + "X-RateLimit-Reset": { + "example": 1590701888, + "schema": { + "type": "integer", + "format": "timestamp" } } } }, + "304": { + "description": "Not modified" + }, "404": { "description": "Resource not found", "content": { @@ -238999,99 +238497,73 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update an existing project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "category": "rate-limit", + "subcategory": "rate-limit" + } + } + }, + "/repos/{owner}/{repo}": { + "get": { + "summary": "Get a repository", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.", "tags": [ - "projects-classic" + "repos" ], - "operationId": "projects-classic/update-card", + "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository" }, "parameters": [ { - "name": "card_id", - "description": "The unique identifier of the card.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "note": { - "description": "The project card's note", - "example": "Update all gems", - "type": "string", - "nullable": true - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - } - } - }, - "examples": { - "default": { - "summary": "Change the note on the card", - "value": { - "note": "Add payload for delete Project column" - } - } - } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Full Repository", + "description": "Full Repository", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" - }, "id": { - "description": "The project card's ID", - "example": 42, "type": "integer", - "format": "int64" + "format": "int64", + "example": 1296269 }, "node_id": { "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "note": { + "name": { "type": "string", - "example": "Add payload for delete Project column", - "nullable": true + "example": "Hello-World" }, - "creator": { + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -239213,2994 +238685,1194 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ] }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:21:06Z" + "private": { + "type": "boolean" }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:20:22Z" + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_name": { - "type": "string" + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true }, - "project_id": { - "type": "string" + "fork": { + "type": "boolean" }, - "column_url": { + "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367" + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "content_url": { + "archive_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "project_url": { + "assignees_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - "documentation_url": { - "type": "string" + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/delete-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card" - }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - "documentation_url": { - "type": "string" + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, - "documentation_url": { - "type": "string" + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, - "url": { - "type": "string" + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "documentation_url": { - "type": "string" + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "url": { - "type": "string" + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/cards/{card_id}/moves": { - "post": { - "summary": "Move a project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/move-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card" - }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.", - "example": "bottom", - "type": "string", - "pattern": "^(?:top|bottom|after:\\d+)$" - }, - "column_id": { - "description": "The unique identifier of the column the card should be moved to", - "example": 42, - "type": "integer" - } - }, - "required": [ - "position" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Move the card to the bottom of the column", - "value": { - "column_id": 42, - "position": "bottom" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - "documentation_url": { - "type": "string" + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "resource": { - "type": "string" - }, - "field": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - "documentation_url": { - "type": "string" + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - "url": { - "type": "string" + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "503": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" }, - "message": { - "type": "string" + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - "documentation_url": { - "type": "string" + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, - "documentation_url": { - "type": "string" + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/{column_id}": { - "get": { - "summary": "Get a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { + "labels_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, - "project_url": { + "languages_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/120" + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, - "cards_url": { + "merges_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" - }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, - "node_id": { + "milestones_url": { "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" - }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, - "created_at": { + "notifications_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, - "updated_at": { + "pulls_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:22:28Z" - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, - "url": { - "type": "string" + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" }, - "documentation_url": { - "type": "string" + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, - "url": { - "type": "string" + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update an existing project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/update-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Rename the project column", - "value": { - "name": "To Do" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { + "subscribers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367" + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, - "project_url": { + "subscription_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/120" + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, - "cards_url": { + "tags_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" - }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" + "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, - "node_id": { + "teams_url": { "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, - "created_at": { + "clone_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" + "example": "https://github.com/octocat/Hello-World.git" }, - "updated_at": { + "mirror_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:22:28Z" - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true }, - "documentation_url": { - "type": "string" + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, - "url": { - "type": "string" + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true }, - "documentation_url": { - "type": "string" + "language": { + "type": "string", + "nullable": true }, - "url": { - "type": "string" + "forks_count": { + "type": "integer", + "example": 9 }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/delete-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#delete-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "stargazers_count": { + "type": "integer", + "example": 80 }, - "documentation_url": { - "type": "string" + "watchers_count": { + "type": "integer", + "example": 80 }, - "url": { - "type": "string" + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "default_branch": { + "type": "string", + "example": "master" }, - "documentation_url": { - "type": "string" + "open_issues_count": { + "type": "integer", + "example": 0 }, - "url": { - "type": "string" + "is_template": { + "type": "boolean", + "example": true }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/{column_id}/cards": { - "get": { - "summary": "List project cards", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/list-cards", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "archived_state", - "description": "Filters the project cards that are returned by the card's state.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "archived", - "not_archived" - ], - "default": "not_archived" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" - }, - "id": { - "description": "The project card's ID", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" - }, - "note": { - "type": "string", - "example": "Add payload for delete Project column", - "nullable": true - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:21:06Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:20:22Z" - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_name": { - "type": "string" - }, - "project_id": { + "topics": { + "type": "array", + "items": { "type": "string" }, - "column_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "content_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - } + "example": [ + "octocat", + "atom", + "electron", + "API" + ] }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "has_issues": { + "type": "boolean", + "example": true }, - "documentation_url": { - "type": "string" + "has_projects": { + "type": "boolean", + "example": true }, - "url": { - "type": "string" + "has_wiki": { + "type": "boolean", + "example": true }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "has_pages": { + "type": "boolean" }, - "documentation_url": { - "type": "string" + "has_downloads": { + "type": "boolean", + "example": true }, - "url": { - "type": "string" + "has_discussions": { + "type": "boolean", + "example": true }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "post": { - "summary": "Create a project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/create-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "note": { - "description": "The project card's note", - "example": "Update all gems", - "type": "string", - "nullable": true - } + "archived": { + "type": "boolean" }, - "required": [ - "note" - ] - }, - { - "type": "object", - "properties": { - "content_id": { - "description": "The unique identifier of the content associated with the card", - "example": 42, - "type": "integer" - }, - "content_type": { - "description": "The piece of content associated with the card", - "example": "PullRequest", - "type": "string" - } + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." }, - "required": [ - "content_id", - "content_type" - ] - } - ] - }, - "examples": { - "default": { - "summary": "Create a new card", - "value": { - "note": "Add payload for delete Project column" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { + "visibility": { + "description": "The repository visibility: public, private, or internal.", "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" + "example": "public" }, - "id": { - "description": "The project card's ID", - "example": 42, - "type": "integer", - "format": "int64" + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z" }, - "node_id": { + "created_at": { "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" + "format": "date-time", + "example": "2011-01-26T19:01:12Z" }, - "note": { + "updated_at": { "type": "string", - "example": "Add payload for delete Project column", - "nullable": true + "format": "date-time", + "example": "2011-01-26T19:14:43Z" }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", + "permissions": { "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" + "admin": { + "type": "boolean" }, - "email": { - "nullable": true, - "type": "string" + "maintain": { + "type": "boolean" }, - "login": { - "type": "string", - "example": "octocat" + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" }, + "pull": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "allow_rebase_merge": { + "type": "boolean", + "example": true + }, + "template_repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer", - "format": "int64", - "example": 1 + "format": "int64" }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "avatar_url": { + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "example": "https://github.com/octocat/Hello-World" }, - "gravatar_id": { + "description": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", + "example": "This your first repo!", "nullable": true }, + "fork": { + "type": "boolean" + }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "html_url": { + "archive_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "followers_url": { + "assignees_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, - "following_url": { + "blobs_url": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - "gists_url": { + "branches_url": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - "starred_url": { + "collaborators_url": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - "subscriptions_url": { + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "organizations_url": { + "deployments_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "repos_url": { + "downloads_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - "received_events_url": { + "forks_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - "type": { + "git_commits_url": { "type": "string", - "example": "User" + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - "site_admin": { - "type": "boolean" + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - "starred_at": { + "git_tags_url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, - "user_view_type": { + "git_url": { "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:21:06Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:20:22Z" - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "content_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "example": "git:github.com/octocat/Hello-World.git" }, - "documentation_url": { - "type": "string" + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - }, - { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, - "documentation_url": { - "type": "string" + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ] - } - } - } - }, - "503": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { "type": "string" } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/{column_id}/moves": { - "post": { - "summary": "Move a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/move-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#move-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "example": "last", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$" - } - }, - "required": [ - "position" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Move the column to the end of the board", - "value": { - "position": "last" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators": { - "get": { - "summary": "List project collaborators", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/list-collaborators", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#list-project-collaborators" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "affiliation", - "description": "Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "outside", - "direct", - "all" - ], - "default": "all" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } } } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}": { - "put": { - "summary": "Add project collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/add-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#add-project-collaborator" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "example": "write", - "type": "string" - } - }, - "nullable": true - }, - "examples": { - "default": { - "summary": "Applying write permissions for the new collaborator", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "nullable": true }, - "documentation_url": { - "type": "string" + "temp_clone_token": { + "type": "string", + "nullable": true }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "allow_squash_merge": { + "type": "boolean", + "example": true }, - "documentation_url": { - "type": "string" + "allow_auto_merge": { + "type": "boolean", + "example": false }, - "url": { - "type": "string" + "delete_branch_on_merge": { + "type": "boolean", + "example": false }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "allow_merge_commit": { + "type": "boolean", + "example": true }, - "documentation_url": { - "type": "string" + "allow_update_branch": { + "type": "boolean", + "example": true }, - "url": { - "type": "string" + "use_squash_pr_title_as_default": { + "type": "boolean", + "example": false }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove user as a collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/remove-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#remove-user-as-a-collaborator" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "squash_merge_commit_title": { + "type": "string", + "example": "PR_TITLE", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, - "documentation_url": { - "type": "string" + "squash_merge_commit_message": { + "type": "string", + "example": "PR_BODY", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, - "url": { - "type": "string" + "merge_commit_title": { + "type": "string", + "example": "PR_TITLE", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "merge_commit_message": { + "type": "string", + "example": "PR_BODY", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, - "documentation_url": { - "type": "string" + "allow_forking": { + "type": "boolean", + "example": true }, - "url": { - "type": "string" + "web_commit_signoff_required": { + "type": "boolean", + "example": false }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "subscribers_count": { + "type": "integer", + "example": 42 }, - "documentation_url": { - "type": "string" + "network_count": { + "type": "integer", + "example": 0 }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" } - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}/permission": { - "get": { - "summary": "Get project permission for a user", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-permission-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#get-project-permission-for-a-user" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", - "type": "object", - "properties": { - "permission": { - "type": "string" + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true }, - "user": { + "organization": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -242324,2406 +239996,223 @@ "url" ], "nullable": true - } - }, - "required": [ - "permission", - "user" - ] - }, - "examples": { - "default": { - "value": { - "permission": "admin", - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/rate_limit": { - "get": { - "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", - "tags": [ - "rate-limit" - ], - "operationId": "rate-limit/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" - }, - "parameters": [], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Rate Limit Overview", - "description": "Rate Limit Overview", - "type": "object", - "properties": { - "resources": { + "parent": { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { - "core": { - "title": "Rate Limit", + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" + "key": { + "type": "string", + "example": "mit" }, - "reset": { - "type": "integer" + "name": { + "type": "string", + "example": "MIT License" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "graphql": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" }, - "remaining": { - "type": "integer" + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" }, - "reset": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" }, - "used": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "limit", - "remaining", - "reset", - "used" - ] + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true }, - "search": { - "title": "Rate Limit", + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", "properties": { - "limit": { - "type": "integer" + "admin": { + "type": "boolean" }, - "remaining": { - "type": "integer" + "pull": { + "type": "boolean" }, - "reset": { - "type": "integer" + "triage": { + "type": "boolean" }, - "used": { - "type": "integer" + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" } }, "required": [ - "limit", - "remaining", - "reset", - "used" + "admin", + "pull", + "push" ] }, - "code_search": { - "title": "Rate Limit", + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "limit": { - "type": "integer" + "name": { + "nullable": true, + "type": "string" }, - "remaining": { - "type": "integer" + "email": { + "nullable": true, + "type": "string" }, - "reset": { - "type": "integer" + "login": { + "type": "string", + "example": "octocat" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "source_import": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "remaining": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "reset": { - "type": "integer" + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "integration_manifest": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "remaining": { - "type": "integer" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "reset": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_upload": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "remaining": { - "type": "integer" + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "reset": { - "type": "integer" + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "actions_runner_registration": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "remaining": { - "type": "integer" + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "reset": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "scim": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" }, - "remaining": { - "type": "integer" + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "reset": { - "type": "integer" + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_snapshots": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "type": { + "type": "string", + "example": "User" }, - "remaining": { - "type": "integer" + "site_admin": { + "type": "boolean" }, - "reset": { - "type": "integer" + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" }, - "used": { - "type": "integer" + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_sbom": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_autofix": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - } - }, - "required": [ - "core", - "search" - ] - }, - "rate": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - } - }, - "required": [ - "rate", - "resources" - ] - }, - "examples": { - "default": { - "value": { - "resources": { - "core": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691591363 - }, - "search": { - "limit": 30, - "used": 12, - "remaining": 18, - "reset": 1691591091 - }, - "graphql": { - "limit": 5000, - "used": 7, - "remaining": 4993, - "reset": 1691593228 - }, - "integration_manifest": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691594631 - }, - "source_import": { - "limit": 100, - "used": 1, - "remaining": 99, - "reset": 1691591091 - }, - "code_scanning_upload": { - "limit": 500, - "used": 1, - "remaining": 499, - "reset": 1691594631 - }, - "actions_runner_registration": { - "limit": 10000, - "used": 0, - "remaining": 10000, - "reset": 1691594631 - }, - "scim": { - "limit": 15000, - "used": 0, - "remaining": 15000, - "reset": 1691594631 - }, - "dependency_snapshots": { - "limit": 100, - "used": 0, - "remaining": 100, - "reset": 1691591091 - }, - "code_search": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - }, - "code_scanning_autofix": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - } - }, - "rate": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1372700873 - } - } - } - } - } - }, - "headers": { - "X-RateLimit-Limit": { - "example": 5000, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Remaining": { - "example": 4999, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Reset": { - "example": 1590701888, - "schema": { - "type": "integer", - "format": "timestamp" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "rate-limit", - "subcategory": "rate-limit" - } - } - }, - "/repos/{owner}/{repo}": { - "get": { - "summary": "Get a repository", - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.", - "tags": [ - "repos" - ], - "operationId": "repos/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Full Repository", - "description": "Full Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "octocat", - "atom", - "electron", - "API" - ] - }, - "has_issues": { - "type": "boolean", - "example": true - }, - "has_projects": { - "type": "boolean", - "example": true - }, - "has_wiki": { - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean", - "example": true - }, - "has_discussions": { - "type": "boolean", - "example": true - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string", - "example": "public" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { - "type": "boolean", - "example": true - }, - "template_repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "example": false - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ], - "nullable": true - }, - "temp_clone_token": { - "type": "string", - "nullable": true - }, - "allow_squash_merge": { - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "type": "boolean", - "example": false - }, - "allow_merge_commit": { - "type": "boolean", - "example": true - }, - "allow_update_branch": { - "type": "boolean", - "example": true - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "example": false - }, - "squash_merge_commit_title": { - "type": "string", - "example": "PR_TITLE", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "example": "PR_BODY", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "example": "PR_TITLE", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "example": "PR_BODY", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_forking": { - "type": "boolean", - "example": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "subscribers_count": { - "type": "integer", - "example": 42 - }, - "network_count": { - "type": "integer", - "example": 0 - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "organization": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "parent": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, "private": { @@ -277562,6 +273051,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -277582,6 +273072,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -295780,6 +291271,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -295800,6 +291292,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -333647,6 +329140,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -333667,6 +329161,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -339401,6 +334896,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -339421,6 +334917,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -344754,6 +340251,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -344774,6 +340272,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345300,6 +340799,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345320,6 +340820,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345870,6 +341371,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345890,6 +341392,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -381848,6 +377351,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -464232,6 +459743,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -464252,6 +459764,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -495105,6 +490618,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -495125,6 +490639,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -526189,6 +521704,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "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.", @@ -528429,7 +523967,7 @@ }, "patch": { "summary": "Update a secret scanning alert", - "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "operationId": "secret-scanning/update-alert", "tags": [ "secret-scanning" @@ -528499,6 +524037,11 @@ "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", "type": "string", "nullable": true + }, + "assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true } }, "anyOf": [ @@ -528506,6 +524049,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -528515,6 +524063,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -529491,7 +525051,27 @@ "resolution_comment": "Example comment", "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://alambic.github.com/avatars/u/1?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } } } @@ -529505,7 +525085,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment" + "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" }, "503": { "description": "Service unavailable", @@ -566791,6 +562371,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -567003,6 +562584,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -579973,17 +575555,17 @@ "deprecated": true } }, - "/teams/{team_id}/projects": { + "/teams/{team_id}/repos": { "get": { - "summary": "List team projects (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "List team repositories (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories) endpoint.", "tags": [ "teams" ], - "operationId": "teams/list-projects-legacy", + "operationId": "teams/list-repos-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy" }, "parameters": [ { @@ -580022,42 +575604,28 @@ "schema": { "type": "array", "items": { - "title": "Team Project", - "description": "A team's access to a project.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, "id": { - "type": "integer" + "type": "integer", + "format": "int64", + "example": 1296269 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { - "type": "string" - }, - "body": { "type": "string", - "nullable": true - }, - "number": { - "type": "integer" + "example": "Hello-World" }, - "state": { - "type": "string" + "full_name": { + "type": "string", + "example": "octocat/Hello-World" }, - "creator": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -580181,55 +575749,550 @@ "url" ] }, - "created_at": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, - "updated_at": { + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { "type": "string" }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { "type": "string" }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { "type": "boolean" }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, "permissions": { "type": "object", "properties": { - "read": { + "admin": { "type": "boolean" }, - "write": { + "maintain": { "type": "boolean" }, - "admin": { + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { "type": "boolean" } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + } }, "required": [ - "read", - "write", - "admin" + "url", + "html_url", + "key", + "name" ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_validity_checks": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ - "owner_url", - "url", + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", - "columns_url", "id", "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] } }, @@ -580237,17 +576300,11 @@ "default": { "value": [ { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -580267,1576 +576324,97 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, - "/teams/{team_id}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-project-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": "string", - "nullable": true - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - } - } - } - } - }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - } - }, - "examples": { - "default": { - "summary": "Example of setting permission to read", - "value": { - "permission": "read" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, - "/teams/{team_id}/repos": { - "get": { - "summary": "List team repositories (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories) endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/list-repos-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_validity_checks": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_validity_checks": { - "status": "disabled" - } + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_validity_checks": { + "status": "disabled" + } } } ] @@ -608846,6 +603424,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -657687,6 +652273,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -664124,6 +658718,675 @@ "category": "projects", "subcategory": "fields" } + }, + "post": { + "summary": "Add field to user owned project", + "description": "Add a field to a specified user owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/add-field-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-field-to-user-owned-project" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_number", + "description": "The project's number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date", + "single_select", + "iteration" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "description": "The color associated with the option.", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + "description": { + "type": "string", + "description": "The description of the option." + } + } + } + }, + "iteration_configuration": { + "type": "object", + "description": "The configuration for iteration fields.", + "properties": { + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the first iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "description": "Zero or more iterations for the field.", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title for the iteration." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + } + } + } + } + } + } + }, + "required": [ + "name", + "data_type" + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "summary": "Create a single select field", + "value": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + } + }, + "iteration_field": { + "summary": "Create an iteration field", + "value": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "example": "https://api.github.com/projects/1" + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was last updated." + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + }, + "examples": { + "text_field": { + "value": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + } + }, + "number_field": { + "value": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + } + }, + "date_field": { + "value": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + } + }, + "single_select_field": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + }, + "iteration_field": { + "value": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" + } } }, "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { @@ -664369,21 +659632,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -724616,6 +719897,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -726997,6 +722285,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -858270,6 +853565,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -860878,6 +856181,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -863393,6 +858704,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -865908,6 +861227,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -868555,6 +863882,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -871209,6 +866544,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -875486,6 +870829,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1270976,949 +1266327,4357 @@ ] } }, - "updated": { + "updated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "rule": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "automatic_copilot_code_review_enabled": { + "type": "boolean", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + } + ] + }, + "changes": { + "type": "object", + "properties": { + "configuration": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "rule_type": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "pattern": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-transferred": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", + "operationId": "repository/transferred", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "repository transferred event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "transferred" + ] + }, + "changes": { + "type": "object", + "properties": { + "owner": { + "type": "object", + "properties": { + "from": { + "type": "object", + "properties": { + "organization": { + "title": "Organization", + "type": "object", + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issues_url": { + "type": "string", + "format": "uri" + }, + "login": { + "type": "string" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "node_id": { + "type": "string" + }, + "public_members_url": { + "type": "string", + "format": "uri-template" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id", + "node_id", + "url", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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": [ + "from" + ] + } + }, + "required": [ + "owner" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "changes", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-unarchived": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "repository unarchived event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unarchived" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { "type": "array", "items": { - "type": "object", - "properties": { - "rule": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "merge_queue" - ] - }, - "parameters": { - "type": "object", - "properties": { - "check_response_timeout_minutes": { - "type": "integer", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", - "minimum": 1, - "maximum": 360 - }, - "grouping_strategy": { - "type": "string", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - "max_entries_to_build": { - "type": "integer", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", - "minimum": 0, - "maximum": 100 - }, - "max_entries_to_merge": { - "type": "integer", - "description": "The maximum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "merge_method": { - "type": "string", - "description": "Method to use when merging changes from queued pull requests.", - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - "min_entries_to_merge": { - "type": "integer", - "description": "The minimum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "min_entries_to_merge_wait_minutes": { - "type": "integer", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", - "minimum": 0, - "maximum": 360 - } - }, - "required": [ - "check_response_timeout_minutes", - "grouping_strategy", - "max_entries_to_build", - "max_entries_to_merge", - "merge_method", - "min_entries_to_merge", - "min_entries_to_merge_wait_minutes" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "automatic_copilot_code_review_enabled": { - "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - }, - "required_reviewers": { - "type": "array", - "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", - "items": { - "title": "RequiredReviewerConfiguration", - "description": "A reviewing team, and file patterns describing which files they must approve changes to.", - "type": "object", - "properties": { - "file_patterns": { - "type": "array", - "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", - "items": { - "type": "string" - } - }, - "minimum_approvals": { - "type": "integer", - "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." - }, - "reviewer": { - "title": "Reviewer", - "description": "A required reviewing team", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "ID of the reviewer which must review changes to matching files." - }, - "type": { - "type": "string", - "description": "The type of the reviewer", - "enum": [ - "Team" - ] - } - }, - "required": [ - "id", - "type" - ] - } - }, - "required": [ - "file_patterns", - "minimum_approvals", - "reviewer" - ] - } - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } - } - ] - }, - "changes": { - "type": "object", - "properties": { - "configuration": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "rule_type": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "pattern": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - } - } - } + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" } } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" } } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } - } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] }, "sender": { "title": "Simple User", @@ -1272047,7 +1270806,7 @@ }, "required": [ "action", - "repository_ruleset", + "repository", "sender" ] } @@ -1272062,8 +1270821,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -1272071,13 +1270831,13 @@ } } }, - "repository-transferred": { + "repository-vulnerability-alert-create": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", - "operationId": "repository/transferred", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1272142,200 +1270902,180 @@ "content": { "application/json": { "schema": { - "title": "repository transferred event", + "title": "repository_vulnerability_alert create event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "transferred" + "create" ] }, - "changes": { + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], "properties": { - "owner": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "issues_url": { - "type": "string", - "format": "uri" - }, - "login": { - "type": "string" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "node_id": { - "type": "string" - }, - "public_members_url": { - "type": "string", - "format": "uri-template" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id", - "node_id", - "url", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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" - ] - } - } + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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" } - }, - "required": [ - "from" + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open" ] } - }, - "required": [ - "owner" - ] + } }, "enterprise": { "title": "Enterprise", @@ -1273843,7 +1272583,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1273859,23 +1272599,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-unarchived": { + "repository-vulnerability-alert-dismiss": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1273940,15 +1272678,191 @@ "content": { "application/json": { "schema": { - "title": "repository unarchived event", + "title": "repository_vulnerability_alert dismiss event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unarchived" + "dismiss" ] }, + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", + "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "dismiss_reason", + "dismissed_at", + "dismisser", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], + "properties": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_comment": { + "type": "string", + "nullable": true + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "dismissed" + ] + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", @@ -1275455,6 +1274369,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1275470,21 +1274385,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-vulnerability-alert-create": { + "repository-vulnerability-alert-reopen": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was created.", - "operationId": "repository-vulnerability-alert/create", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1275551,13 +1274464,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert create event", + "title": "repository_vulnerability_alert reopen event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "create" + "reopen" ] }, "alert": { @@ -1277256,11 +1276169,11 @@ } } }, - "repository-vulnerability-alert-dismiss": { + "repository-vulnerability-alert-resolve": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was dismissed.", - "operationId": "repository-vulnerability-alert/dismiss", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1277327,13 +1276240,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert dismiss event", + "title": "repository_vulnerability_alert resolve event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "dismiss" + "resolve" ] }, "alert": { @@ -1277344,9 +1276257,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1277366,10 +1276276,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": "string", - "nullable": true - }, "dismiss_reason": { "type": "string" }, @@ -1277465,9 +1276371,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1277507,7 +1276410,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1279014,279 +1277918,855 @@ "type", "url" ] - } - }, - "required": [ - "action", - "alert", - "repository", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "repository_vulnerability_alert", - "supported-webhook-types": [ - "repository", - "organization" - ] - } - } - }, - "repository-vulnerability-alert-reopen": { - "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "repository_vulnerability_alert reopen event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "reopen" - ] - }, - "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", - "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], - "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "dismiss_reason": { - "type": "string" - }, - "dismissed_at": { - "type": "string" - }, - "dismisser": { - "title": "User", - "type": "object", - "nullable": true, - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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" - } - } - }, - "external_identifier": { - "type": "string" - }, - "external_reference": { - "type": "string", - "nullable": true, - "format": "uri" - }, - "fix_reason": { - "type": "string" - }, - "fixed_at": { - "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "severity": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "open" - ] - } - } + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_vulnerability_alert", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "secret-scanning-alert-assigned": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "secret_scanning_alert assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { + "type": "string", + "description": "The reason for resolving the alert.", + "nullable": true, + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true + }, + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, "enterprise": { "title": "Enterprise", @@ -1280795,8 +1280275,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1280810,21 +1280289,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-resolve": { + "secret-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was marked as resolved.", - "operationId": "repository-vulnerability-alert/resolve", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was created.", + "operationId": "secret-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1280889,179 +1280369,630 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert resolve event", + "title": "secret_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolve" + "created" ] }, "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, "created_at": { - "type": "string" + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "dismiss_reason": { - "type": "string" + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", - "type": "object", + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { + "type": "string", + "description": "The reason for resolving the alert.", "nullable": true, - "required": [ - "login", - "id" - ], + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "format": "uri" + "example": "octocat" }, - "deleted": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "email": { + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "events_url": { + "url": { "type": "string", - "format": "uri-template" + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "gravatar_id": { - "type": "string" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "html_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "id": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "login": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { "name": { + "nullable": true, "type": "string" }, - "node_id": { + "email": { + "nullable": true, "type": "string" }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "repos_url": { + "type": { "type": "string", - "format": "uri" + "example": "User" }, "site_admin": { "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, "starred_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "example": "User" }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } - } - }, - "external_identifier": { - "type": "string" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "external_reference": { + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "nullable": true, - "format": "uri" - }, - "fix_reason": { - "type": "string" + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true }, - "fixed_at": { + "push_protection_bypass_request_comment": { "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true }, - "node_id": { - "type": "string" + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true }, - "number": { - "type": "integer" + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true }, - "severity": { - "type": "string" + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" - ] + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true } } }, @@ -1282572,8 +1282503,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1282587,21 +1282517,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "secret-scanning-alert-created": { + "secret-scanning-alert-location-created": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was created.", - "operationId": "secret-scanning-alert/created", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", + "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -1282666,7 +1282597,7 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { @@ -1283293,74 +1283224,6 @@ } } }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1283382,6 +1283245,314 @@ "node_id" ] }, + "location": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "commit", + "wiki_commit", + "issue_title", + "issue_body", + "issue_comment", + "discussion_title", + "discussion_body", + "discussion_comment", + "pull_request_title", + "pull_request_body", + "pull_request_comment", + "pull_request_review", + "pull_request_review_comment" + ], + "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", + "example": "commit" + }, + "details": { + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/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", + "example": "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", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/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", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ] + } + } + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", @@ -1284798,10 +1284969,185 @@ } }, "required": [ - "action", + "location", "alert", - "repository" + "repository", + "sender" + ] + }, + "examples": { + "default": { + "value": { + "action": "created", + "alert": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "updated_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", + "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", + "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "publicly_leaked": false, + "multi_repo": false + }, + "location": { + "type": "commit", + "details": { + "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-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + } + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "hello-world", + "full_name": "octocat-repo/hello-world", + "private": false, + "owner": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/octocat-repo/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octocat-repo/hello-world", + "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", + "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", + "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", + "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", + "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", + "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", + "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", + "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", + "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", + "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", + "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", + "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", + "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", + "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", + "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", + "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", + "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", + "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", + "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:21:03Z", + "pushed_at": "2019-05-15T15:20:57Z", + "git_url": "git://github.com/octocat-repo/hello-world.git", + "ssh_url": "git@github.com:octocat-repo/hello-world.git", + "clone_url": "https://github.com/octocat-repo/hello-world.git", + "svn_url": "https://github.com/octocat-repo/hello-world", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false + }, + "sender": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Secret Scanning Alert Location Created Event", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" ] + }, + "examples": { + "default": { + "value": { + "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" + } + } } } } @@ -1284813,8 +1285159,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1284823,13 +1285170,13 @@ } } }, - "secret-scanning-alert-location-created": { + "secret-scanning-alert-publicly-leaked": { "post": { - "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", - "operationId": "secret-scanning-alert-location/created", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1284894,13 +1285241,13 @@ "content": { "application/json": { "schema": { - "title": "Secret Scanning Alert Location Created Event", + "title": "secret_scanning_alert publicly leaked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "publicly_leaked" ] }, "alert": { @@ -1285521,6 +1285868,74 @@ } } }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1285542,314 +1285957,6 @@ "node_id" ] }, - "location": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "commit", - "wiki_commit", - "issue_title", - "issue_body", - "issue_comment", - "discussion_title", - "discussion_body", - "discussion_comment", - "pull_request_title", - "pull_request_body", - "pull_request_comment", - "pull_request_review", - "pull_request_review_comment" - ], - "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", - "example": "commit" - }, - "details": { - "oneOf": [ - { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "example": "/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", - "example": "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", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "example": "/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", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_title_url" - ] - }, - { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_body_url" - ] - }, - { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "issue_comment_url" - ] - }, - { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082" - } - }, - "required": [ - "discussion_title_url" - ] - }, - { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussion-4566270" - } - }, - "required": [ - "discussion_body_url" - ] - }, - { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - } - }, - "required": [ - "discussion_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_title_url" - ] - }, - { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_body_url" - ] - }, - { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - } - }, - "required": [ - "pull_request_review_url" - ] - }, - { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } - ] - } - } - }, "organization": { "title": "Organization Simple", "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", @@ -1287266,185 +1287373,10 @@ } }, "required": [ - "location", + "action", "alert", - "repository", - "sender" - ] - }, - "examples": { - "default": { - "value": { - "action": "created", - "alert": { - "number": 42, - "created_at": "2020-11-06T18:18:30Z", - "updated_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", - "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", - "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", - "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, - "secret_type": "mailchimp_api_key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "publicly_leaked": false, - "multi_repo": false - }, - "location": { - "type": "commit", - "details": { - "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-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - } - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "hello-world", - "full_name": "octocat-repo/hello-world", - "private": false, - "owner": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/octocat-repo/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octocat-repo/hello-world", - "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", - "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", - "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", - "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", - "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", - "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", - "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", - "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", - "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", - "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", - "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", - "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", - "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", - "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", - "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", - "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", - "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", - "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", - "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:03Z", - "pushed_at": "2019-05-15T15:20:57Z", - "git_url": "git://github.com/octocat-repo/hello-world.git", - "ssh_url": "git@github.com:octocat-repo/hello-world.git", - "clone_url": "https://github.com/octocat-repo/hello-world.git", - "svn_url": "https://github.com/octocat-repo/hello-world", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false - }, - "sender": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "title": "Secret Scanning Alert Location Created Event", - "type": "object", - "properties": { - "payload": { - "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", - "type": "string" - } - }, - "required": [ - "payload" + "repository" ] - }, - "examples": { - "default": { - "value": { - "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" - } - } } } } @@ -1287456,9 +1287388,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1287467,11 +1287398,11 @@ } } }, - "secret-scanning-alert-publicly-leaked": { + "secret-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was detected in a public repo.", - "operationId": "secret-scanning-alert/publicly-leaked", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1287538,13 +1287469,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert publicly leaked event", + "title": "secret_scanning_alert reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "publicly_leaked" + "reopened" ] }, "alert": { @@ -1289695,11 +1289626,11 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-resolved": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1289766,13 +1289697,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert reopened event", + "title": "secret_scanning_alert resolved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "resolved" ] }, "alert": { @@ -1291923,11 +1291854,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-unassigned": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1291994,13 +1291925,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert resolved event", + "title": "secret_scanning_alert unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolved" + "unassigned" ] }, "alert": { @@ -1292621,6 +1292552,130 @@ } } }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index e891ea64d..24ac26fc0 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -57,8 +57,6 @@ tags: description: Interact with organizations. - name: packages description: Manage packages for authenticated users and organizations. -- name: projects-classic - description: Interact with GitHub Projects (classic). - name: pulls description: Interact with GitHub Pull Requests. - name: rate-limit @@ -865,7 +863,7 @@ paths: - subscriptions_url - type - url - type: &428 + type: &429 type: string description: The type of credit the user is receiving. enum: @@ -1031,7 +1029,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &750 + - &743 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1715,7 +1713,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &760 + schema: &753 title: Scim Error description: Scim Error type: object @@ -2217,6 +2215,13 @@ paths: enum: - read - write + artifact_metadata: + type: string + description: The level of permission to grant the access + token to create and retrieve build artifact metadata records. + enum: + - read + - write attestations: type: string description: The level of permission to create and retrieve @@ -8740,7 +8745,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &761 + '401': &754 description: Authorization failure '404': *6 x-github: @@ -12943,7 +12948,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &535 + instances_url: &528 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -12978,7 +12983,7 @@ paths: format: date-time readOnly: true nullable: true - dismissed_reason: &536 + dismissed_reason: &529 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -12987,13 +12992,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &537 + dismissed_comment: &530 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &538 + rule: &531 type: object properties: id: @@ -13046,7 +13051,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &539 + tool: &532 type: object properties: name: *107 @@ -13056,15 +13061,15 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *108 - most_recent_instance: &540 + most_recent_instance: &533 type: object properties: - ref: &533 + ref: &526 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &550 + analysis_key: &543 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -13075,7 +13080,7 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &551 + category: &544 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -16764,7 +16769,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &590 + - &583 name: has in: query description: |- @@ -16877,7 +16882,7 @@ paths: - unknown - direct - transitive - security_advisory: &591 + security_advisory: &584 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -17109,7 +17114,7 @@ paths: nullable: true maxLength: 280 fixed_at: *133 - auto_dismissed_at: &592 + auto_dismissed_at: &585 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -18247,7 +18252,7 @@ paths: - name - created_on examples: - default: &433 + default: &434 value: total_count: 2 network_configurations: @@ -18470,7 +18475,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - *41 - - &434 + - &435 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -18482,7 +18487,7 @@ paths: description: Response content: application/json: - schema: &435 + schema: &436 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -18516,7 +18521,7 @@ paths: - subnet_id - region examples: - default: &436 + default: &437 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -20522,7 +20527,7 @@ paths: - *160 rules: type: array - items: &716 + items: &709 title: Repository Rule type: object description: A repository rule. @@ -20531,7 +20536,7 @@ paths: - *166 - *167 - *168 - - &713 + - &706 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -20625,7 +20630,7 @@ paths: - *182 - *183 - *184 - - &714 + - &707 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. @@ -21020,6 +21025,25 @@ paths: schema: type: string - &419 + name: assignee + in: query + description: Filters alerts by assignee. Use `*` to get all assigned alerts, + `none` to get all unassigned alerts, or a GitHub username to get alerts + assigned to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: "*" + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts + - &420 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. @@ -21035,7 +21059,7 @@ paths: - *17 - *104 - *105 - - &420 + - &421 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -21044,7 +21068,7 @@ paths: required: false schema: type: string - - &421 + - &422 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -21053,7 +21077,7 @@ paths: schema: type: boolean default: false - - &422 + - &423 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -21062,7 +21086,7 @@ paths: schema: type: boolean default: false - - &423 + - &424 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -21078,7 +21102,7 @@ paths: application/json: schema: type: array - items: &424 + items: &425 type: object properties: number: *123 @@ -21097,14 +21121,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &728 + state: &721 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &729 + resolution: &722 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -21211,8 +21235,8 @@ paths: pull request. ' - oneOf: &730 - - &732 + oneOf: &723 + - &725 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -21264,7 +21288,7 @@ paths: - blob_url - commit_sha - commit_url - - &733 + - &726 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. @@ -21319,7 +21343,7 @@ paths: - page_url - commit_sha - commit_url - - &734 + - &727 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -21333,7 +21357,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &735 + - &728 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -21347,7 +21371,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &736 + - &729 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -21361,7 +21385,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &737 + - &730 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -21375,7 +21399,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &738 + - &731 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -21389,7 +21413,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &739 + - &732 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -21403,7 +21427,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &740 + - &733 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. @@ -21417,7 +21441,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &741 + - &734 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. @@ -21431,7 +21455,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &742 + - &735 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. @@ -21445,7 +21469,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &743 + - &736 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. @@ -21459,7 +21483,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &744 + - &737 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. @@ -21486,7 +21510,7 @@ paths: required: *21 nullable: true examples: - default: &425 + default: &426 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -21695,7 +21719,7 @@ paths: description: Response content: application/json: - schema: &426 + schema: &427 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. @@ -21778,7 +21802,7 @@ paths: description: Overrides for custom patterns defined by the organization. items: *191 examples: - default: &427 + default: &428 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -21914,7 +21938,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *41 - - &430 + - &431 name: advanced_security_product in: query description: | @@ -21934,7 +21958,7 @@ paths: description: Success content: application/json: - schema: &431 + schema: &432 type: object properties: total_advanced_security_committers: @@ -21989,7 +22013,7 @@ paths: required: - repositories examples: - default: &432 + default: &433 value: total_advanced_security_committers: 2 total_count: 2 @@ -22615,7 +22639,19 @@ paths: update-budget: value: message: Budget successfully updated. - budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa '400': *14 '401': *25 '403': *29 @@ -24702,7 +24738,7 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &650 + properties: &643 id: type: integer format: int64 @@ -25074,7 +25110,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &788 + sub_issues_summary: &781 title: Sub-issues Summary type: object properties: @@ -25094,7 +25130,7 @@ paths: type: string format: uri nullable: true - issue_dependencies_summary: &789 + issue_dependencies_summary: &782 title: Issue Dependencies Summary type: object properties: @@ -25113,7 +25149,7 @@ paths: - total_blocking issue_field_values: type: array - items: &790 + items: &783 title: Issue Field Value description: A value assigned to an issue field type: object @@ -25173,7 +25209,7 @@ paths: - node_id - data_type - value - required: &651 + required: &644 - assignee - closed_at - comments @@ -25194,7 +25230,7 @@ paths: - user - created_at - updated_at - comment: &648 + comment: &641 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -25752,7 +25788,7 @@ paths: url: type: string format: uri - user: &802 + user: &793 title: Public User description: Public User type: object @@ -29057,14 +29093,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &456 + - &455 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &457 + - &456 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -29126,7 +29162,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &468 + '301': &461 description: Moved permanently content: application/json: @@ -29148,7 +29184,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &680 + - &673 name: all description: If `true`, show notifications marked as read. in: query @@ -29156,7 +29192,7 @@ paths: schema: type: boolean default: false - - &681 + - &674 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -29166,7 +29202,7 @@ paths: type: boolean default: false - *217 - - &682 + - &675 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -29648,7 +29684,7 @@ paths: - url - subscription_url examples: - default: &683 + default: &676 value: - id: '1' repository: @@ -30619,7 +30655,7 @@ paths: type: array items: *151 examples: - default: &689 + default: &682 value: - property_name: environment value: production @@ -30669,7 +30705,7 @@ paths: required: - properties examples: - default: &690 + default: &683 value: properties: - property_name: environment @@ -31482,7 +31518,7 @@ paths: type: integer repository_cache_usages: type: array - items: &473 + items: &466 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -33596,7 +33632,7 @@ paths: type: array items: *274 examples: - default: &805 + default: &796 value: total_count: 1 repositories: @@ -34638,7 +34674,7 @@ paths: description: Response content: application/json: - schema: &493 + schema: &486 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -34667,7 +34703,7 @@ paths: - key_id - key examples: - default: &494 + default: &487 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -35080,7 +35116,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - *83 - - &478 + - &471 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -36262,12 +36298,12 @@ paths: required: - subject_digests examples: - default: &833 + default: &824 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &834 + withPredicateType: &825 value: subject_digests: - sha256:abc123 @@ -36325,7 +36361,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &835 + default: &826 value: attestations_subject_digests: - sha256:abc: @@ -36674,7 +36710,7 @@ paths: initiator: type: string examples: - default: &507 + default: &500 value: attestations: - bundle: @@ -37591,7 +37627,7 @@ paths: be returned. in: query required: false - schema: &534 + schema: &527 type: string description: Severity of a code scanning alert. enum: @@ -38637,7 +38673,7 @@ paths: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &563 + properties: &556 name: type: string description: The name of the machine. @@ -38679,7 +38715,7 @@ paths: - ready - in_progress nullable: true - required: &564 + required: &557 - name - display_name - operating_system @@ -39547,7 +39583,7 @@ paths: - updated_at - visibility examples: - default: &565 + default: &558 value: total_count: 2 secrets: @@ -39585,7 +39621,7 @@ paths: description: Response content: application/json: - schema: &566 + schema: &559 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -39614,7 +39650,7 @@ paths: - key_id - key examples: - default: &567 + default: &560 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -39646,7 +39682,7 @@ paths: application/json: schema: *318 examples: - default: &569 + default: &562 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -41355,7 +41391,7 @@ paths: description: Response content: application/json: - schema: &595 + schema: &588 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -41372,7 +41408,7 @@ paths: - key_id - key examples: - default: &596 + default: &589 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -41702,7 +41738,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *83 - - &604 + - &597 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -41710,7 +41746,7 @@ paths: required: false schema: type: string - - &605 + - &598 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -41718,7 +41754,7 @@ paths: required: false schema: type: string - - &606 + - &599 name: time_period description: |- The time period to filter by. @@ -41734,7 +41770,7 @@ paths: - week - month default: month - - &607 + - &600 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -41759,7 +41795,7 @@ paths: application/json: schema: type: array - items: &608 + items: &601 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -41915,7 +41951,7 @@ paths: format: uri example: https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &609 + default: &602 value: - id: 21 number: 42 @@ -42006,7 +42042,7 @@ paths: - *99 - *100 - *101 - - &610 + - &603 name: request_status description: The status of the dismissal request to filter on. When specified, only requests with this status will be returned. @@ -42032,7 +42068,7 @@ paths: application/json: schema: type: array - items: &611 + items: &604 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -42153,7 +42189,7 @@ paths: format: uri example: https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &612 + default: &605 value: - id: 21 number: 42 @@ -42498,7 +42534,7 @@ paths: description: Response content: application/json: - schema: &451 + schema: &452 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -42579,7 +42615,7 @@ paths: example: mona_lisa@github.com type: string examples: - default: &452 + default: &453 value: group_id: '123' group_name: Octocat admins @@ -42634,7 +42670,7 @@ paths: description: Response content: application/json: - schema: &449 + schema: &450 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -42671,7 +42707,7 @@ paths: example: 2019-06-03 22:27:15:000 -700 type: string examples: - default: &450 + default: &451 value: groups: - group_id: '123' @@ -43973,7 +44009,7 @@ paths: application/json: schema: *22 examples: - default: &643 + default: &636 value: id: 1 account: @@ -44198,7 +44234,7 @@ paths: required: true content: application/json: - schema: &644 + schema: &637 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -45059,7 +45095,7 @@ paths: application/json: schema: *365 examples: - default: &562 + default: &555 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -46304,7 +46340,7 @@ paths: parameters: - *83 - *371 - - &818 + - &809 name: repo_name description: repo_name parameter in: path @@ -47336,7 +47372,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &429 + items: &430 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -47630,7 +47666,7 @@ paths: - nuget - container - *83 - - &819 + - &810 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -47671,7 +47707,7 @@ paths: default: *377 '403': *29 '401': *25 - '400': &821 + '400': &812 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -49463,7 +49499,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &898 + properties: &889 id: type: number description: The unique identifier of the status update. @@ -49511,7 +49547,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &899 + required: &890 - id - node_id - created_at @@ -49725,7 +49761,7 @@ paths: content: oneOf: - *227 - - &577 + - &570 title: Pull Request Simple description: Pull Request Simple type: object @@ -49954,7 +49990,7 @@ paths: - review_comment - self author_association: *214 - auto_merge: &692 + auto_merge: &685 title: Auto merge description: The status of auto merging a pull request. type: object @@ -50329,7 +50365,7 @@ paths: - updated_at - project_url examples: - default: &838 + default: &829 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -50461,7 +50497,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization parameters: - *394 - - &839 + - &830 name: field_id description: The unique identifier of the field. in: path @@ -50476,7 +50512,7 @@ paths: application/json: schema: *398 examples: - default: &840 + default: &831 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -50485,17 +50521,29 @@ paths: project_url: https://api.github.com/projects/67890 options: - id: option_1 - name: Low + name: + html: Low + raw: Low color: GREEN - description: Low priority items + description: + html: Low priority items + raw: Low priority items - id: option_2 - name: Medium + name: + html: Medium + raw: Medium color: YELLOW - description: Medium priority items + description: + html: Medium priority items + raw: Medium priority items - id: option_3 - name: High + name: + html: High + raw: High color: RED - description: High priority items + description: + html: High priority items + raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' headers: @@ -52251,7 +52299,7 @@ paths: description: Response content: application/json: - schema: &467 + schema: &460 title: Full Repository description: Full Repository type: object @@ -52644,7 +52692,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &582 + properties: &575 url: type: string format: uri @@ -52660,7 +52708,7 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &583 + required: &576 - url - key - name @@ -52749,7 +52797,7 @@ paths: - network_count - subscribers_count examples: - default: &469 + default: &462 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -53302,7 +53350,7 @@ paths: - *83 - *17 - *19 - - &715 + - &708 name: targets description: | A comma-separated list of rule targets to filter by. @@ -53516,7 +53564,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - *83 - - &717 + - &710 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -53528,14 +53576,14 @@ paths: x-multi-segment: true - *300 - *101 - - &718 + - &711 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &719 + - &712 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -53555,7 +53603,7 @@ paths: description: Response content: application/json: - schema: &720 + schema: &713 title: Rule Suites description: Response type: array @@ -53610,7 +53658,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &721 + default: &714 value: - id: 21 actor_id: 12 @@ -53654,7 +53702,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *83 - - &722 + - &715 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -53670,7 +53718,7 @@ paths: description: Response content: application/json: - schema: &723 + schema: &716 title: Rule Suite description: Response type: object @@ -53769,7 +53817,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &724 + default: &717 value: id: 21 actor_id: 12 @@ -54097,10 +54145,11 @@ paths: - *417 - *418 - *419 + - *420 - *106 - *19 - *17 - - &726 + - &719 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -54110,7 +54159,7 @@ paths: required: false schema: type: string - - &727 + - &720 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -54120,10 +54169,10 @@ paths: required: false schema: type: string - - *420 - *421 - *422 - *423 + - *424 responses: '200': description: Response @@ -54131,9 +54180,9 @@ paths: application/json: schema: type: array - items: *424 + items: *425 examples: - default: *425 + default: *426 headers: Link: *43 '404': *6 @@ -54168,9 +54217,9 @@ paths: description: Response content: application/json: - schema: *426 + schema: *427 examples: - default: *427 + default: *428 '403': *29 '404': *6 patch: @@ -54323,7 +54372,7 @@ paths: application/json: schema: type: array - items: &748 + items: &741 description: A repository security advisory. type: object properties: @@ -54543,7 +54592,7 @@ paths: login: type: string description: The username of the user credited. - type: *428 + type: *429 credits_detailed: type: array nullable: true @@ -54553,7 +54602,7 @@ paths: type: object properties: user: *4 - type: *428 + type: *429 state: type: string description: The state of the user's acceptance of the @@ -54614,7 +54663,7 @@ paths: - private_fork additionalProperties: false examples: - default: &749 + default: &742 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -55001,7 +55050,7 @@ paths: application/json: schema: type: array - items: *429 + items: *430 examples: default: *375 x-github: @@ -55085,7 +55134,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - *83 - - *430 + - *431 - *17 - *19 responses: @@ -55093,9 +55142,9 @@ paths: description: Success content: application/json: - schema: *431 + schema: *432 examples: - default: *432 + default: *433 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -55376,7 +55425,7 @@ paths: type: array items: *143 examples: - default: *433 + default: *434 headers: Link: *43 x-github: @@ -55577,15 +55626,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - *83 - - *434 + - *435 responses: '200': description: Response content: application/json: - schema: *435 + schema: *436 examples: - default: *436 + default: *437 headers: Link: *43 x-github: @@ -55623,7 +55672,7 @@ paths: description: Response content: application/json: - schema: &458 + schema: &457 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -55669,7 +55718,7 @@ paths: type: string nullable: true examples: - default: &459 + default: &458 value: groups: - group_id: '123' @@ -55877,7 +55926,7 @@ paths: description: Response content: application/json: - schema: &437 + schema: &438 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -56204,7 +56253,7 @@ paths: - repos_count - organization examples: - default: &438 + default: &439 value: id: 1 node_id: MDQ6VGVhbTE= @@ -56281,9 +56330,9 @@ paths: description: Response content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '404': *6 x-github: githubCloudOnly: false @@ -56367,16 +56416,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '201': description: Response content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '404': *6 '422': *15 '403': *29 @@ -56446,7 +56495,7 @@ paths: application/json: schema: type: array - items: &439 + items: &440 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -56545,7 +56594,7 @@ paths: - updated_at - url examples: - default: &792 + default: &785 value: - author: login: octocat @@ -56654,9 +56703,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: &440 + default: &441 value: author: login: octocat @@ -56730,7 +56779,7 @@ paths: parameters: - *83 - *210 - - &441 + - &442 name: discussion_number description: The number that identifies the discussion. in: path @@ -56742,9 +56791,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: *440 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56768,7 +56817,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 requestBody: required: false content: @@ -56791,9 +56840,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: &793 + default: &786 value: author: login: octocat @@ -56865,7 +56914,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 responses: '204': description: Response @@ -56893,7 +56942,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 - *106 - *17 - *19 @@ -56904,7 +56953,7 @@ paths: application/json: schema: type: array - items: &442 + items: &443 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -56976,7 +57025,7 @@ paths: - updated_at - url examples: - default: &794 + default: &787 value: - author: login: octocat @@ -57046,7 +57095,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 requestBody: required: true content: @@ -57068,9 +57117,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: &443 + default: &444 value: author: login: octocat @@ -57138,8 +57187,8 @@ paths: parameters: - *83 - *210 - - *441 - - &444 + - *442 + - &445 name: comment_number description: The number that identifies the comment. in: path @@ -57151,9 +57200,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: *443 + default: *444 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57177,8 +57226,8 @@ paths: parameters: - *83 - *210 - - *441 - - *444 + - *442 + - *445 requestBody: required: true content: @@ -57200,9 +57249,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: &795 + default: &788 value: author: login: octocat @@ -57268,8 +57317,8 @@ paths: parameters: - *83 - *210 - - *441 - - *444 + - *442 + - *445 responses: '204': description: Response @@ -57297,8 +57346,8 @@ paths: parameters: - *83 - *210 - - *441 - - *444 + - *442 + - *445 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -57324,7 +57373,7 @@ paths: application/json: schema: type: array - items: &445 + items: &446 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -57367,7 +57416,7 @@ paths: - content - created_at examples: - default: &447 + default: &448 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -57419,8 +57468,8 @@ paths: parameters: - *83 - *210 - - *441 - - *444 + - *442 + - *445 requestBody: required: true content: @@ -57453,9 +57502,9 @@ paths: team discussion comment content: application/json: - schema: *445 + schema: *446 examples: - default: &446 + default: &447 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -57484,9 +57533,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57511,9 +57560,9 @@ paths: parameters: - *83 - *210 - - *441 - - *444 - - &448 + - *442 + - *445 + - &449 name: reaction_id description: The unique identifier of the reaction. in: path @@ -57547,7 +57596,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -57573,9 +57622,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 x-github: @@ -57603,7 +57652,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 requestBody: required: true content: @@ -57635,16 +57684,16 @@ paths: description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57669,8 +57718,8 @@ paths: parameters: - *83 - *210 - - *441 - - *448 + - *442 + - *449 responses: '204': description: Response @@ -57700,9 +57749,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *450 examples: - default: *450 + default: *451 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -57745,9 +57794,9 @@ paths: description: Response content: application/json: - schema: *451 + schema: *452 examples: - default: *452 + default: *453 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -57888,7 +57937,7 @@ paths: description: Response content: application/json: - schema: &453 + schema: &454 title: Team Membership description: Team Membership type: object @@ -57915,7 +57964,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &796 + response-if-user-is-a-team-maintainer: &789 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -57978,9 +58027,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *454 examples: - response-if-users-membership-with-team-is-now-pending: &797 + response-if-users-membership-with-team-is-now-pending: &790 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -58028,322 +58077,6 @@ paths: enabledForGitHubApps: true category: teams subcategory: members - "/orgs/{org}/teams/{team_slug}/projects": - get: - summary: List team projects - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/list-projects-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects - parameters: - - *83 - - *210 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &454 - title: Team Project - description: A team's access to a project. - type: object - properties: - owner_url: - type: string - url: - type: string - html_url: - type: string - columns_url: - type: string - id: - type: integer - node_id: - type: string - name: - type: string - body: - type: string - nullable: true - number: - type: integer - state: - type: string - creator: *4 - created_at: - type: string - updated_at: - type: string - organization_permission: - description: The organization permission for this project. Only - present when owner is an organization. - type: string - private: - description: Whether the project is private or not. Only present - when owner is an organization. - type: boolean - permissions: - type: object - properties: - read: - type: boolean - write: - type: boolean - admin: - type: boolean - required: - - read - - write - - admin - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at - - permissions - examples: - default: &798 - value: - - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false - headers: - Link: *43 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": - get: - summary: Check team permissions for a project - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/check-permissions-for-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project - parameters: - - *83 - - *210 - - &455 - name: project_id - description: The unique identifier of the project. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *454 - examples: - default: &799 - value: - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - put: - summary: Add or update team project permissions - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/add-or-update-project-permissions-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions - parameters: - - *83 - - *210 - - *455 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - nullable: true - examples: - default: - summary: Updates the permissions for the team to write for the project - value: - permission: write - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Remove a project from a team - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/remove-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team - parameters: - - *83 - - *210 - - *455 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/orgs/{org}/teams/{team_slug}/repos": get: summary: List team repositories @@ -58403,14 +58136,14 @@ paths: parameters: - *83 - *210 + - *455 - *456 - - *457 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &800 + schema: &791 title: Team Repository description: A team's access to a repository. type: object @@ -58981,8 +58714,8 @@ paths: parameters: - *83 - *210 + - *455 - *456 - - *457 requestBody: required: false content: @@ -59029,8 +58762,8 @@ paths: parameters: - *83 - *210 + - *455 - *456 - - *457 responses: '204': description: Response @@ -59063,9 +58796,9 @@ paths: description: Response content: application/json: - schema: *458 + schema: *457 examples: - default: *459 + default: *458 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -59131,7 +58864,7 @@ paths: description: Response content: application/json: - schema: *458 + schema: *457 examples: default: value: @@ -59176,7 +58909,7 @@ paths: type: array items: *303 examples: - response-if-child-teams-exist: &801 + response-if-child-teams-exist: &792 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -59289,979 +59022,6 @@ paths: deprecationDate: '2024-07-22' removalDate: '2025-07-22' deprecated: true - "/projects/columns/cards/{card_id}": - get: - summary: Get a project card - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card - parameters: - - &460 - name: card_id - description: The unique identifier of the card. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: &461 - title: Project Card - description: Project cards represent a scope of work. - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/projects/columns/cards/1478 - id: - description: The project card's ID - example: 42 - type: integer - format: int64 - node_id: - type: string - example: MDExOlByb2plY3RDYXJkMTQ3OA== - note: - type: string - example: Add payload for delete Project column - nullable: true - creator: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - created_at: - type: string - format: date-time - example: '2016-09-05T14:21:06Z' - updated_at: - type: string - format: date-time - example: '2016-09-05T14:20:22Z' - archived: - description: Whether or not the card is archived - example: false - type: boolean - column_name: - type: string - project_id: - type: string - column_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367 - content_url: - type: string - format: uri - example: https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: - type: string - format: uri - example: https://api.github.com/projects/120 - required: - - id - - node_id - - note - - url - - column_url - - project_url - - creator - - created_at - - updated_at - examples: - default: &462 - value: - url: https://api.github.com/projects/columns/cards/1478 - id: 1478 - node_id: MDExOlByb2plY3RDYXJkMTQ3OA== - note: Add payload for delete Project column - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2016-09-05T14:21:06Z' - updated_at: '2016-09-05T14:20:22Z' - archived: false - column_url: https://api.github.com/projects/columns/367 - content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: https://api.github.com/projects/120 - '304': *37 - '403': *29 - '401': *25 - '404': *6 - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update an existing project card - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/update-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card - parameters: - - *460 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - note: - description: The project card's note - example: Update all gems - type: string - nullable: true - archived: - description: Whether or not the card is archived - example: false - type: boolean - examples: - default: - summary: Change the note on the card - value: - note: Add payload for delete Project column - responses: - '200': - description: Response - content: - application/json: - schema: *461 - examples: - default: *462 - '304': *37 - '403': *29 - '401': *25 - '404': *6 - '422': *7 - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete a project card - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/delete-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card - parameters: - - *460 - responses: - '204': - description: Response - '304': *37 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': *25 - '404': *6 - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/columns/cards/{card_id}/moves": - post: - summary: Move a project card - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/move-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card - parameters: - - *460 - requestBody: - required: true - content: - application/json: - schema: - properties: - position: - description: 'The position of the card in a column. Can be one of: - `top`, `bottom`, or `after:` to place after the specified - card.' - example: bottom - type: string - pattern: "^(?:top|bottom|after:\\d+)$" - column_id: - description: The unique identifier of the column the card should - be moved to - example: 42 - type: integer - required: - - position - type: object - examples: - default: - summary: Move the card to the bottom of the column - value: - column_id: 42 - position: bottom - responses: - '201': - description: Response - content: - application/json: - schema: - type: object - properties: {} - additionalProperties: false - examples: - default: - value: - '304': *37 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: object - properties: - code: - type: string - message: - type: string - resource: - type: string - field: - type: string - '401': *25 - '503': - description: Response - content: - application/json: - schema: - type: object - properties: - code: - type: string - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: object - properties: - code: - type: string - message: - type: string - '422': *15 - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/columns/{column_id}": - get: - summary: Get a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-column - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column - parameters: - - &463 - name: column_id - description: The unique identifier of the column. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: &464 - title: Project Column - description: Project columns contain cards of work. - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/projects/columns/367 - project_url: - type: string - format: uri - example: https://api.github.com/projects/120 - cards_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367/cards - id: - description: The unique identifier of the project column - example: 42 - type: integer - node_id: - type: string - example: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: - description: Name of the project column - example: Remaining tasks - type: string - created_at: - type: string - format: date-time - example: '2016-09-05T14:18:44Z' - updated_at: - type: string - format: date-time - example: '2016-09-05T14:22:28Z' - required: - - id - - node_id - - url - - project_url - - cards_url - - name - - created_at - - updated_at - examples: - default: &465 - value: - url: https://api.github.com/projects/columns/367 - project_url: https://api.github.com/projects/120 - cards_url: https://api.github.com/projects/columns/367/cards - id: 367 - node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: To Do - created_at: '2016-09-05T14:18:44Z' - updated_at: '2016-09-05T14:22:28Z' - '304': *37 - '403': *29 - '404': *6 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update an existing project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/update-column - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-project-column - parameters: - - *463 - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project column - example: Remaining tasks - type: string - required: - - name - type: object - examples: - default: - summary: Rename the project column - value: - name: To Do - responses: - '200': - description: Response - content: - application/json: - schema: *464 - examples: - default: *465 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/delete-column - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#delete-a-project-column - parameters: - - *463 - responses: - '204': - description: Response - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/columns/{column_id}/cards": - get: - summary: List project cards - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/list-cards - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards - parameters: - - *463 - - name: archived_state - description: Filters the project cards that are returned by the card's state. - in: query - required: false - schema: - type: string - enum: - - all - - archived - - not_archived - default: not_archived - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *461 - examples: - default: - value: - - url: https://api.github.com/projects/columns/cards/1478 - id: 1478 - node_id: MDExOlByb2plY3RDYXJkMTQ3OA== - note: Add payload for delete Project column - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2016-09-05T14:21:06Z' - updated_at: '2016-09-05T14:20:22Z' - archived: false - column_url: https://api.github.com/projects/columns/367 - content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: https://api.github.com/projects/120 - headers: - Link: *43 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - post: - summary: Create a project card - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/create-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card - parameters: - - *463 - requestBody: - required: true - content: - application/json: - schema: - oneOf: - - type: object - properties: - note: - description: The project card's note - example: Update all gems - type: string - nullable: true - required: - - note - - type: object - properties: - content_id: - description: The unique identifier of the content associated with - the card - example: 42 - type: integer - content_type: - description: The piece of content associated with the card - example: PullRequest - type: string - required: - - content_id - - content_type - examples: - default: - summary: Create a new card - value: - note: Add payload for delete Project column - responses: - '201': - description: Response - content: - application/json: - schema: *461 - examples: - default: *462 - '304': *37 - '403': *29 - '401': *25 - '422': - description: Validation failed - content: - application/json: - schema: - oneOf: - - *249 - - *250 - '503': - description: Response - content: - application/json: - schema: - type: object - properties: - code: - type: string - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: object - properties: - code: - type: string - message: - type: string - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/columns/{column_id}/moves": - post: - summary: Move a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/move-column - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#move-a-project-column - parameters: - - *463 - requestBody: - required: true - content: - application/json: - schema: - properties: - position: - description: 'The position of the column in a project. Can be one - of: `first`, `last`, or `after:` to place after the - specified column.' - example: last - type: string - pattern: "^(?:first|last|after:\\d+)$" - required: - - position - type: object - examples: - default: - summary: Move the column to the end of the board - value: - position: last - responses: - '201': - description: Response - content: - application/json: - schema: - type: object - properties: {} - additionalProperties: false - examples: - default: - value: - '304': *37 - '403': *29 - '422': *7 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators": - get: - summary: List project collaborators - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/list-collaborators - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#list-project-collaborators - parameters: - - *455 - - name: affiliation - description: Filters the collaborators by their affiliation. `outside` means - outside collaborators of a project that are not a member of the project's - organization. `direct` means collaborators with permissions to a project, - regardless of organization membership status. `all` means all collaborators - the authenticated user can see. - in: query - required: false - schema: - type: string - enum: - - outside - - direct - - all - default: all - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *207 - headers: - Link: *43 - '404': *6 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators/{username}": - put: - summary: Add project collaborator - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/add-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#add-project-collaborator - parameters: - - *455 - - *138 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - description: The permission to grant the collaborator. - enum: - - read - - write - - admin - default: write - example: write - type: string - nullable: true - examples: - default: - summary: Applying write permissions for the new collaborator - value: - permission: write - responses: - '204': - description: Response - '404': *6 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Remove user as a collaborator - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/remove-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#remove-user-as-a-collaborator - parameters: - - *455 - - *138 - responses: - '204': - description: Response - '304': *37 - '404': *6 - '403': *29 - '422': *15 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators/{username}/permission": - get: - summary: Get project permission for a user - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-permission-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#get-project-permission-for-a-user - parameters: - - *455 - - *138 - responses: - '200': - description: Response - content: - application/json: - schema: - title: Project Collaborator Permission - description: Project Collaborator Permission - type: object - properties: - permission: - type: string - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - required: - - permission - - user - examples: - default: - value: - permission: admin - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - '404': *6 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/rate_limit": get: summary: Get rate limit status for the authenticated user @@ -60303,7 +59063,7 @@ paths: resources: type: object properties: - core: &466 + core: &459 title: Rate Limit type: object properties: @@ -60320,21 +59080,21 @@ paths: - remaining - reset - used - graphql: *466 - search: *466 - code_search: *466 - source_import: *466 - integration_manifest: *466 - code_scanning_upload: *466 - actions_runner_registration: *466 - scim: *466 - dependency_snapshots: *466 - dependency_sbom: *466 - code_scanning_autofix: *466 + graphql: *459 + search: *459 + code_search: *459 + source_import: *459 + integration_manifest: *459 + code_scanning_upload: *459 + actions_runner_registration: *459 + scim: *459 + dependency_snapshots: *459 + dependency_sbom: *459 + code_scanning_autofix: *459 required: - core - search - rate: *466 + rate: *459 required: - rate - resources @@ -60439,14 +59199,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response content: application/json: - schema: *467 + schema: *460 examples: default-response: summary: Default response @@ -60951,7 +59711,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *468 + '301': *461 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60969,8 +59729,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: false content: @@ -61227,10 +59987,10 @@ paths: description: Response content: application/json: - schema: *467 + schema: *460 examples: - default: *469 - '307': &470 + default: *462 + '307': &463 description: Temporary Redirect content: application/json: @@ -61259,8 +60019,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -61282,7 +60042,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository - '307': *470 + '307': *463 '404': *6 '409': *114 x-github: @@ -61306,11 +60066,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: + - *455 - *456 - - *457 - *17 - *19 - - &485 + - &478 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -61333,7 +60093,7 @@ paths: type: integer artifacts: type: array - items: &471 + items: &464 title: Artifact description: An artifact type: object @@ -61411,7 +60171,7 @@ paths: - expires_at - updated_at examples: - default: &486 + default: &479 value: total_count: 2 artifacts: @@ -61472,9 +60232,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: + - *455 - *456 - - *457 - - &472 + - &465 name: artifact_id description: The unique identifier of the artifact. in: path @@ -61486,7 +60246,7 @@ paths: description: Response content: application/json: - schema: *471 + schema: *464 examples: default: value: @@ -61524,9 +60284,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: + - *455 - *456 - - *457 - - *472 + - *465 responses: '204': description: Response @@ -61550,9 +60310,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: + - *455 - *456 - - *457 - - *472 + - *465 - name: archive_format in: path required: true @@ -61566,7 +60326,7 @@ paths: example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': &647 + '410': &640 description: Gone content: application/json: @@ -61593,14 +60353,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response content: application/json: - schema: *473 + schema: *466 examples: default: value: @@ -61626,11 +60386,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-github-actions-caches-for-a-repository parameters: + - *455 - *456 - - *457 - *17 - *19 - - &474 + - &467 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -61664,7 +60424,7 @@ paths: description: Response content: application/json: - schema: &475 + schema: &468 title: Repository actions caches description: Repository actions caches type: object @@ -61706,7 +60466,7 @@ paths: - total_count - actions_caches examples: - default: &476 + default: &469 value: total_count: 1 actions_caches: @@ -61738,23 +60498,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: + - *455 - *456 - - *457 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *474 + - *467 responses: '200': description: Response content: application/json: - schema: *475 + schema: *468 examples: - default: *476 + default: *469 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61774,8 +60534,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: + - *455 - *456 - - *457 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -61806,9 +60566,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: + - *455 - *456 - - *457 - - &477 + - &470 name: job_id description: The unique identifier of the job. in: path @@ -61820,7 +60580,7 @@ paths: description: Response content: application/json: - schema: &489 + schema: &482 title: Job description: Information of a job execution in a workflow run type: object @@ -62127,9 +60887,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: + - *455 - *456 - - *457 - - *477 + - *470 responses: '302': description: Response @@ -62157,9 +60917,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: + - *455 - *456 - - *457 - - *477 + - *470 requestBody: required: false content: @@ -62204,8 +60964,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Status response @@ -62255,8 +61015,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -62319,8 +61079,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -62338,7 +61098,7 @@ paths: type: integer secrets: type: array - items: &491 + items: &484 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -62358,7 +61118,7 @@ paths: - created_at - updated_at examples: - default: &492 + default: &485 value: total_count: 2 secrets: @@ -62391,9 +61151,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: + - *455 - *456 - - *457 - - *478 + - *471 - *19 responses: '200': @@ -62410,7 +61170,7 @@ paths: type: integer variables: type: array - items: &495 + items: &488 title: Actions Variable type: object properties: @@ -62440,7 +61200,7 @@ paths: - created_at - updated_at examples: - default: &496 + default: &489 value: total_count: 2 variables: @@ -62473,8 +61233,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -62483,7 +61243,7 @@ paths: schema: type: object properties: - enabled: &479 + enabled: &472 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *56 @@ -62518,8 +61278,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -62530,7 +61290,7 @@ paths: schema: type: object properties: - enabled: *479 + enabled: *472 allowed_actions: *56 sha_pinning_required: *57 required: @@ -62563,14 +61323,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response content: application/json: - schema: &480 + schema: &473 type: object properties: access_level: @@ -62588,7 +61348,7 @@ paths: required: - access_level examples: - default: &481 + default: &474 value: access_level: organization x-github: @@ -62613,15 +61373,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: application/json: - schema: *480 + schema: *473 examples: - default: *481 + default: *474 responses: '204': description: Response @@ -62645,8 +61405,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -62676,8 +61436,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: + - *455 - *456 - - *457 responses: '204': description: Empty response for successful settings update @@ -62711,8 +61471,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -62739,8 +61499,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -62774,8 +61534,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -62803,8 +61563,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -62835,8 +61595,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -62867,8 +61627,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -62900,8 +61660,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -62930,8 +61690,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: + - *455 - *456 - - *457 responses: '204': description: Success response @@ -62971,8 +61731,8 @@ paths: in: query schema: type: string + - *455 - *456 - - *457 - *17 - *19 responses: @@ -63016,8 +61776,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -63049,8 +61809,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -63124,8 +61884,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: + - *455 - *456 - - *457 responses: '201': description: Response @@ -63161,8 +61921,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: + - *455 - *456 - - *457 responses: '201': description: Response @@ -63192,8 +61952,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: + - *455 - *456 - - *457 - *71 responses: '200': @@ -63223,8 +61983,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: + - *455 - *456 - - *457 - *71 responses: '204': @@ -63251,8 +62011,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: + - *455 - *456 - - *457 - *71 responses: '200': *77 @@ -63277,8 +62037,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: + - *455 - *456 - - *457 - *71 requestBody: required: true @@ -63327,8 +62087,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: + - *455 - *456 - - *457 - *71 requestBody: required: true @@ -63378,8 +62138,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: + - *455 - *456 - - *457 - *71 responses: '200': *281 @@ -63409,8 +62169,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: + - *455 - *456 - - *457 - *71 - *282 responses: @@ -63440,9 +62200,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: + - *455 - *456 - - *457 - - &499 + - &492 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -63450,7 +62210,7 @@ paths: required: false schema: type: string - - &500 + - &493 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -63458,7 +62218,7 @@ paths: required: false schema: type: string - - &501 + - &494 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -63467,7 +62227,7 @@ paths: required: false schema: type: string - - &502 + - &495 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -63494,7 +62254,7 @@ paths: - pending - *17 - *19 - - &503 + - &496 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -63503,7 +62263,7 @@ paths: schema: type: string format: date-time - - &482 + - &475 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -63512,13 +62272,13 @@ paths: schema: type: boolean default: false - - &504 + - &497 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &505 + - &498 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -63541,7 +62301,7 @@ paths: type: integer workflow_runs: type: array - items: &483 + items: &476 title: Workflow Run description: An invocation of a workflow type: object @@ -63636,7 +62396,7 @@ paths: that triggered the run. type: array nullable: true - items: &524 + items: &517 title: Pull Request Minimal type: object properties: @@ -63755,7 +62515,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &528 + properties: &521 id: type: string description: SHA for the commit @@ -63806,7 +62566,7 @@ paths: - name - email nullable: true - required: &529 + required: &522 - id - tree_id - message @@ -63853,7 +62613,7 @@ paths: - workflow_url - pull_requests examples: - default: &506 + default: &499 value: total_count: 1 workflow_runs: @@ -64089,24 +62849,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: + - *455 - *456 - - *457 - - &484 + - &477 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *482 + - *475 responses: '200': description: Response content: application/json: - schema: *483 + schema: *476 examples: - default: &487 + default: &480 value: id: 30433642 name: Build @@ -64347,9 +63107,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: + - *455 - *456 - - *457 - - *484 + - *477 responses: '204': description: Response @@ -64372,9 +63132,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: + - *455 - *456 - - *457 - - *484 + - *477 responses: '200': description: Response @@ -64493,9 +63253,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: + - *455 - *456 - - *457 - - *484 + - *477 responses: '201': description: Response @@ -64528,12 +63288,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: + - *455 - *456 - - *457 - - *484 + - *477 - *17 - *19 - - *485 + - *478 responses: '200': description: Response @@ -64549,9 +63309,9 @@ paths: type: integer artifacts: type: array - items: *471 + items: *464 examples: - default: *486 + default: *479 headers: Link: *43 x-github: @@ -64575,25 +63335,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: + - *455 - *456 - - *457 - - *484 - - &488 + - *477 + - &481 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *482 + - *475 responses: '200': description: Response content: application/json: - schema: *483 + schema: *476 examples: - default: *487 + default: *480 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64616,10 +63376,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: + - *455 - *456 - - *457 - - *484 - - *488 + - *477 + - *481 - *17 - *19 responses: @@ -64637,9 +63397,9 @@ paths: type: integer jobs: type: array - items: *489 + items: *482 examples: - default: &490 + default: &483 value: total_count: 1 jobs: @@ -64752,10 +63512,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: + - *455 - *456 - - *457 - - *484 - - *488 + - *477 + - *481 responses: '302': description: Response @@ -64783,9 +63543,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: + - *455 - *456 - - *457 - - *484 + - *477 responses: '202': description: Response @@ -64818,9 +63578,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: + - *455 - *456 - - *457 - - *484 + - *477 requestBody: required: true content: @@ -64887,9 +63647,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: + - *455 - *456 - - *457 - - *484 + - *477 responses: '202': description: Response @@ -64922,9 +63682,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: + - *455 - *456 - - *457 - - *484 + - *477 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -64954,9 +63714,9 @@ paths: type: integer jobs: type: array - items: *489 + items: *482 examples: - default: *490 + default: *483 headers: Link: *43 x-github: @@ -64981,9 +63741,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: + - *455 - *456 - - *457 - - *484 + - *477 responses: '302': description: Response @@ -65010,9 +63770,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: + - *455 - *456 - - *457 - - *484 + - *477 responses: '204': description: Response @@ -65039,9 +63799,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: + - *455 - *456 - - *457 - - *484 + - *477 responses: '200': description: Response @@ -65101,7 +63861,7 @@ paths: items: type: object properties: - type: &613 + type: &606 type: string description: The type of reviewer. enum: @@ -65186,9 +63946,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: + - *455 - *456 - - *457 - - *484 + - *477 requestBody: required: true content: @@ -65235,7 +63995,7 @@ paths: application/json: schema: type: array - items: &599 + items: &592 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -65341,7 +64101,7 @@ paths: - created_at - updated_at examples: - default: &600 + default: &593 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -65397,9 +64157,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: + - *455 - *456 - - *457 - - *484 + - *477 requestBody: required: false content: @@ -65443,9 +64203,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: + - *455 - *456 - - *457 - - *484 + - *477 requestBody: required: false content: @@ -65499,9 +64259,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: + - *455 - *456 - - *457 - - *484 + - *477 responses: '200': description: Response @@ -65638,8 +64398,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -65657,9 +64417,9 @@ paths: type: integer secrets: type: array - items: *491 + items: *484 examples: - default: *492 + default: *485 headers: Link: *43 x-github: @@ -65684,16 +64444,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: + - *455 - *456 - - *457 responses: '200': description: Response content: application/json: - schema: *493 + schema: *486 examples: - default: *494 + default: *487 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65715,17 +64475,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: + - *455 - *456 - - *457 - *284 responses: '200': description: Response content: application/json: - schema: *491 + schema: *484 examples: - default: &626 + default: &619 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -65751,8 +64511,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: + - *455 - *456 - - *457 - *284 requestBody: required: true @@ -65810,8 +64570,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: + - *455 - *456 - - *457 - *284 responses: '204': @@ -65837,9 +64597,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: + - *455 - *456 - - *457 - - *478 + - *471 - *19 responses: '200': @@ -65856,9 +64616,9 @@ paths: type: integer variables: type: array - items: *495 + items: *488 examples: - default: *496 + default: *489 headers: Link: *43 x-github: @@ -65881,8 +64641,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -65934,17 +64694,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: + - *455 - *456 - - *457 - *287 responses: '200': description: Response content: application/json: - schema: *495 + schema: *488 examples: - default: &627 + default: &620 value: name: USERNAME value: octocat @@ -65970,8 +64730,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: + - *455 - *456 - - *457 - *287 requestBody: required: true @@ -66014,8 +64774,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: + - *455 - *456 - - *457 - *287 responses: '204': @@ -66041,8 +64801,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -66060,7 +64820,7 @@ paths: type: integer workflows: type: array - items: &497 + items: &490 title: Workflow description: A GitHub Actions workflow type: object @@ -66167,9 +64927,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: + - *455 - *456 - - *457 - - &498 + - &491 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -66184,7 +64944,7 @@ paths: description: Response content: application/json: - schema: *497 + schema: *490 examples: default: value: @@ -66217,9 +64977,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: + - *455 - *456 - - *457 - - *498 + - *491 responses: '204': description: Response @@ -66244,9 +65004,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: + - *455 - *456 - - *457 - - *498 + - *491 responses: '204': description: Response @@ -66297,9 +65057,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: + - *455 - *456 - - *457 - - *498 + - *491 responses: '204': description: Response @@ -66326,19 +65086,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: + - *455 - *456 - - *457 - - *498 - - *499 - - *500 - - *501 - - *502 + - *491 + - *492 + - *493 + - *494 + - *495 - *17 - *19 - - *503 - - *482 - - *504 - - *505 + - *496 + - *475 + - *497 + - *498 responses: '200': description: Response @@ -66354,9 +65114,9 @@ paths: type: integer workflow_runs: type: array - items: *483 + items: *476 examples: - default: *506 + default: *499 headers: Link: *43 x-github: @@ -66389,9 +65149,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: + - *455 - *456 - - *457 - - *498 + - *491 responses: '200': description: Response @@ -66452,8 +65212,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: + - *455 - *456 - - *457 - *106 - *17 - *104 @@ -66617,8 +65377,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -66655,8 +65415,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned parameters: + - *455 - *456 - - *457 - name: assignee in: path required: true @@ -66692,8 +65452,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -66805,8 +65565,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: + - *455 - *456 - - *457 - *17 - *104 - *105 @@ -66863,7 +65623,7 @@ paths: initiator: type: string examples: - default: *507 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66883,8 +65643,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -66892,7 +65652,7 @@ paths: application/json: schema: type: array - items: &508 + items: &501 title: Autolink reference description: An autolink reference. type: object @@ -66946,8 +65706,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -66986,9 +65746,9 @@ paths: description: response content: application/json: - schema: *508 + schema: *501 examples: - default: &509 + default: &502 value: id: 1 key_prefix: TICKET- @@ -67019,9 +65779,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: + - *455 - *456 - - *457 - - &510 + - &503 name: autolink_id description: The unique identifier of the autolink. in: path @@ -67033,9 +65793,9 @@ paths: description: Response content: application/json: - schema: *508 + schema: *501 examples: - default: *509 + default: *502 '404': *6 x-github: githubCloudOnly: false @@ -67055,9 +65815,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: + - *455 - *456 - - *457 - - *510 + - *503 responses: '204': description: Response @@ -67081,8 +65841,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response if Dependabot is enabled @@ -67130,8 +65890,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -67152,8 +65912,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -67173,8 +65933,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: + - *455 - *456 - - *457 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -67212,7 +65972,7 @@ paths: - url protected: type: boolean - protection: &512 + protection: &505 title: Branch Protection description: Branch Protection type: object @@ -67254,7 +66014,7 @@ paths: required: - contexts - checks - enforce_admins: &515 + enforce_admins: &508 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -67269,7 +66029,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &517 + required_pull_request_reviews: &510 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -67345,7 +66105,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &514 + restrictions: &507 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -67622,9 +66382,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: + - *455 - *456 - - *457 - - &513 + - &506 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql). @@ -67638,14 +66398,14 @@ paths: description: Response content: application/json: - schema: &523 + schema: &516 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &573 + commit: &566 title: Commit description: Commit type: object @@ -67679,7 +66439,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &511 + properties: &504 name: type: string example: '"Chris Wanstrath"' @@ -67688,13 +66448,14 @@ paths: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true committer: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *511 + properties: *504 nullable: true message: type: string @@ -67715,7 +66476,7 @@ paths: required: - sha - url - verification: &633 + verification: &626 title: Verification type: object properties: @@ -67785,7 +66546,7 @@ paths: type: integer files: type: array - items: &586 + items: &579 title: Diff Entry description: Diff Entry type: object @@ -67869,7 +66630,7 @@ paths: - self protected: type: boolean - protection: *512 + protection: *505 protection_url: type: string format: uri @@ -67976,7 +66737,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *468 + '301': *461 '404': *6 x-github: githubCloudOnly: false @@ -67998,15 +66759,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response content: application/json: - schema: *512 + schema: *505 examples: default: value: @@ -68200,9 +66961,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: true content: @@ -68457,7 +67218,7 @@ paths: url: type: string format: uri - required_status_checks: &520 + required_status_checks: &513 title: Status Check Policy description: Status Check Policy type: object @@ -68609,7 +67370,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *514 + restrictions: *507 required_conversation_resolution: type: object properties: @@ -68721,9 +67482,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '204': description: Response @@ -68748,17 +67509,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response content: application/json: - schema: *515 + schema: *508 examples: - default: &516 + default: &509 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -68780,17 +67541,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response content: application/json: - schema: *515 + schema: *508 examples: - default: *516 + default: *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68809,9 +67570,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '204': description: Response @@ -68836,17 +67597,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response content: application/json: - schema: *517 + schema: *510 examples: - default: &518 + default: &511 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -68942,9 +67703,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: false content: @@ -69042,9 +67803,9 @@ paths: description: Response content: application/json: - schema: *517 + schema: *510 examples: - default: *518 + default: *511 '422': *15 x-github: githubCloudOnly: false @@ -69065,9 +67826,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '204': description: Response @@ -69094,17 +67855,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response content: application/json: - schema: *515 + schema: *508 examples: - default: &519 + default: &512 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -69127,17 +67888,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response content: application/json: - schema: *515 + schema: *508 examples: - default: *519 + default: *512 '404': *6 x-github: githubCloudOnly: false @@ -69157,9 +67918,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '204': description: Response @@ -69184,17 +67945,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response content: application/json: - schema: *520 + schema: *513 examples: - default: &521 + default: &514 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -69220,9 +67981,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: false content: @@ -69274,9 +68035,9 @@ paths: description: Response content: application/json: - schema: *520 + schema: *513 examples: - default: *521 + default: *514 '404': *6 '422': *15 x-github: @@ -69298,9 +68059,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '204': description: Response @@ -69324,9 +68085,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response @@ -69360,9 +68121,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: false content: @@ -69429,9 +68190,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: false content: @@ -69495,9 +68256,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: content: application/json: @@ -69563,15 +68324,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response content: application/json: - schema: *514 + schema: *507 examples: default: value: @@ -69662,9 +68423,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '204': description: Response @@ -69687,9 +68448,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response @@ -69699,7 +68460,7 @@ paths: type: array items: *5 examples: - default: &522 + default: &515 value: - id: 1 slug: octoapp @@ -69756,9 +68517,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: true content: @@ -69792,7 +68553,7 @@ paths: type: array items: *5 examples: - default: *522 + default: *515 '422': *15 x-github: githubCloudOnly: false @@ -69813,9 +68574,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: true content: @@ -69849,7 +68610,7 @@ paths: type: array items: *5 examples: - default: *522 + default: *515 '422': *15 x-github: githubCloudOnly: false @@ -69870,9 +68631,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: true content: @@ -69906,7 +68667,7 @@ paths: type: array items: *5 examples: - default: *522 + default: *515 '422': *15 x-github: githubCloudOnly: false @@ -69928,9 +68689,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response @@ -69960,9 +68721,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: false content: @@ -70021,9 +68782,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: false content: @@ -70082,9 +68843,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: content: application/json: @@ -70143,9 +68904,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: + - *455 - *456 - - *457 - - *513 + - *506 responses: '200': description: Response @@ -70179,9 +68940,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: true content: @@ -70239,9 +69000,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: true content: @@ -70299,9 +69060,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: true content: @@ -70361,9 +69122,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: + - *455 - *456 - - *457 - - *513 + - *506 requestBody: required: true content: @@ -70385,7 +69146,7 @@ paths: description: Response content: application/json: - schema: *523 + schema: *516 examples: default: value: @@ -70499,8 +69260,8 @@ paths: category: repos subcategory: bypass-requests parameters: + - *455 - *456 - - *457 - *99 - *100 - *101 @@ -70536,8 +69297,8 @@ paths: category: repos subcategory: bypass-requests parameters: + - *455 - *456 - - *457 - name: bypass_request_number in: path required: true @@ -70610,8 +69371,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: + - *455 - *456 - - *457 - *99 - *100 - *101 @@ -70651,8 +69412,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: + - *455 - *456 - - *457 - name: bypass_request_number in: path required: true @@ -70722,8 +69483,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: + - *455 - *456 - - *457 - name: bypass_request_number in: path required: true @@ -70794,8 +69555,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: + - *455 - *456 - - *457 - name: bypass_response_id in: path required: true @@ -70828,8 +69589,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -71108,7 +69869,7 @@ paths: description: Response content: application/json: - schema: &525 + schema: &518 title: CheckRun description: A check performed on the code of a given code change type: object @@ -71227,8 +69988,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *524 - deployment: &851 + items: *517 + deployment: &842 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -71508,9 +70269,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: + - *455 - *456 - - *457 - - &526 + - &519 name: check_run_id description: The unique identifier of the check run. in: path @@ -71522,9 +70283,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *518 examples: - default: &527 + default: &520 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -71624,9 +70385,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: + - *455 - *456 - - *457 - - *526 + - *519 requestBody: required: true content: @@ -71866,9 +70627,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *518 examples: - default: *527 + default: *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71888,9 +70649,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: + - *455 - *456 - - *457 - - *526 + - *519 - *17 - *19 responses: @@ -71985,9 +70746,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: + - *455 - *456 - - *457 - - *526 + - *519 responses: '201': description: Response @@ -72031,8 +70792,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -72054,7 +70815,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &530 + schema: &523 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -72118,7 +70879,7 @@ paths: nullable: true pull_requests: type: array - items: *524 + items: *517 nullable: true app: title: GitHub app @@ -72140,12 +70901,12 @@ paths: type: string format: date-time nullable: true - head_commit: &882 + head_commit: &873 title: Simple Commit description: A commit. type: object - properties: *528 - required: *529 + properties: *521 + required: *522 latest_check_runs_count: type: integer check_runs_url: @@ -72173,7 +70934,7 @@ paths: - check_runs_url - pull_requests examples: - default: &531 + default: &524 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -72464,9 +71225,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *530 + schema: *523 examples: - default: *531 + default: *524 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72485,8 +71246,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -72795,9 +71556,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: + - *455 - *456 - - *457 - - &532 + - &525 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -72809,9 +71570,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *523 examples: - default: *531 + default: *524 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72834,17 +71595,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-in-a-check-suite parameters: + - *455 - *456 - - *457 - - *532 - - &579 + - *525 + - &572 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &580 + - &573 name: status description: Returns check runs with the specified `status`. in: query @@ -72883,9 +71644,9 @@ paths: type: integer check_runs: type: array - items: *525 + items: *518 examples: - default: &581 + default: &574 value: total_count: 1 check_runs: @@ -72987,9 +71748,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: + - *455 - *456 - - *457 - - *532 + - *525 responses: '201': description: Response @@ -73022,21 +71783,21 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: + - *455 - *456 - - *457 - *307 - *308 - *19 - *17 - - &548 + - &541 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *533 - - &549 + schema: *526 + - &542 name: pr description: The number of the pull request for the results you want to list. in: query @@ -73067,7 +71828,7 @@ paths: be returned. in: query required: false - schema: *534 + schema: *527 responses: '200': description: Response @@ -73083,7 +71844,7 @@ paths: updated_at: *131 url: *128 html_url: *129 - instances_url: *535 + instances_url: *528 state: *109 fixed_at: *133 dismissed_by: @@ -73094,11 +71855,11 @@ paths: required: *21 nullable: true dismissed_at: *132 - dismissed_reason: *536 - dismissed_comment: *537 - rule: *538 - tool: *539 - most_recent_instance: *540 + dismissed_reason: *529 + dismissed_comment: *530 + rule: *531 + tool: *532 + most_recent_instance: *533 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -73224,7 +71985,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &541 + '403': &534 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -73251,9 +72012,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: + - *455 - *456 - - *457 - - &542 + - &535 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -73267,7 +72028,7 @@ paths: description: Response content: application/json: - schema: &543 + schema: &536 type: object properties: number: *123 @@ -73275,7 +72036,7 @@ paths: updated_at: *131 url: *128 html_url: *129 - instances_url: *535 + instances_url: *528 state: *109 fixed_at: *133 dismissed_by: @@ -73286,8 +72047,8 @@ paths: required: *21 nullable: true dismissed_at: *132 - dismissed_reason: *536 - dismissed_comment: *537 + dismissed_reason: *529 + dismissed_comment: *530 rule: type: object properties: @@ -73341,8 +72102,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *539 - most_recent_instance: *540 + tool: *532 + most_recent_instance: *533 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -73441,7 +72202,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *541 + '403': *534 '404': *6 '503': *190 x-github: @@ -73461,9 +72222,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: + - *455 - *456 - - *457 - - *542 + - *535 requestBody: required: true content: @@ -73478,8 +72239,8 @@ paths: enum: - open - dismissed - dismissed_reason: *536 - dismissed_comment: *537 + dismissed_reason: *529 + dismissed_comment: *530 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -73498,7 +72259,7 @@ paths: description: Response content: application/json: - schema: *543 + schema: *536 examples: default: value: @@ -73574,7 +72335,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &547 + '403': &540 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -73601,15 +72362,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: + - *455 - *456 - - *457 - - *542 + - *535 responses: '200': description: Response content: application/json: - schema: &544 + schema: &537 type: object properties: status: @@ -73635,13 +72396,13 @@ paths: - description - started_at examples: - default: &545 + default: &538 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &546 + '400': &539 description: Bad Request content: application/json: @@ -73652,7 +72413,7 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *541 + '403': *534 '404': *6 '503': *190 x-github: @@ -73677,29 +72438,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: + - *455 - *456 - - *457 - - *542 + - *535 responses: '200': description: OK content: application/json: - schema: *544 + schema: *537 examples: - default: *545 + default: *538 '202': description: Accepted content: application/json: - schema: *544 + schema: *537 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *546 + '400': *539 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -73731,9 +72492,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: + - *455 - *456 - - *457 - - *542 + - *535 requestBody: required: false content: @@ -73778,8 +72539,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *546 - '403': *547 + '400': *539 + '403': *540 '404': *6 '422': description: Unprocessable Entity @@ -73803,13 +72564,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: + - *455 - *456 - - *457 - - *542 + - *535 - *19 - *17 - - *548 - - *549 + - *541 + - *542 responses: '200': description: Response @@ -73817,7 +72578,7 @@ paths: application/json: schema: type: array - items: *540 + items: *533 examples: default: value: @@ -73856,7 +72617,7 @@ paths: end_column: 50 classifications: - source - '403': *541 + '403': *534 '404': *6 '503': *190 x-github: @@ -73890,25 +72651,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: + - *455 - *456 - - *457 - *307 - *308 - *19 - *17 - - *549 + - *542 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *533 + schema: *526 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &552 + schema: &545 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -73929,23 +72690,23 @@ paths: application/json: schema: type: array - items: &553 + items: &546 type: object properties: - ref: *533 - commit_sha: &561 + ref: *526 + commit_sha: &554 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *550 + analysis_key: *543 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *551 + category: *544 error: type: string example: error reading field xyz @@ -73969,8 +72730,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *552 - tool: *539 + sarif_id: *545 + tool: *532 deletable: type: boolean warning: @@ -74031,7 +72792,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *541 + '403': *534 '404': *6 '503': *190 x-github: @@ -74067,8 +72828,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: + - *455 - *456 - - *457 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -74081,7 +72842,7 @@ paths: description: Response content: application/json: - schema: *553 + schema: *546 examples: response: summary: application/json response @@ -74135,7 +72896,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *541 + '403': *534 '404': *6 '422': description: Response if analysis could not be processed @@ -74222,8 +72983,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: + - *455 - *456 - - *457 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -74276,7 +73037,7 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *547 + '403': *540 '404': *6 '503': *190 x-github: @@ -74298,8 +73059,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -74307,7 +73068,7 @@ paths: application/json: schema: type: array - items: &554 + items: &547 title: CodeQL Database description: A CodeQL database. type: object @@ -74418,7 +73179,7 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *541 + '403': *534 '404': *6 '503': *190 x-github: @@ -74447,8 +73208,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: + - *455 - *456 - - *457 - name: language in: path description: The language of the CodeQL database. @@ -74460,7 +73221,7 @@ paths: description: Response content: application/json: - schema: *554 + schema: *547 examples: default: value: @@ -74492,9 +73253,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &588 + '302': &581 description: Found - '403': *541 + '403': *534 '404': *6 '503': *190 x-github: @@ -74516,8 +73277,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: + - *455 - *456 - - *457 - name: language in: path description: The language of the CodeQL database. @@ -74527,7 +73288,7 @@ paths: responses: '204': description: Response - '403': *547 + '403': *540 '404': *6 '503': *190 x-github: @@ -74555,8 +73316,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -74565,7 +73326,7 @@ paths: type: object additionalProperties: false properties: - language: &555 + language: &548 type: string description: The language targeted by the CodeQL query enum: @@ -74645,7 +73406,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &559 + schema: &552 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -74655,7 +73416,7 @@ paths: description: The ID of the variant analysis. controller_repo: *115 actor: *4 - query_language: *555 + query_language: *548 query_pack_url: type: string description: The download url for the query pack. @@ -74702,7 +73463,7 @@ paths: items: type: object properties: - repository: &556 + repository: &549 title: Repository Identifier description: Repository Identifier type: object @@ -74738,7 +73499,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &560 + analysis_status: &553 type: string description: The new status of the CodeQL variant analysis repository task. @@ -74770,7 +73531,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &557 + access_mismatch_repos: &550 type: object properties: repository_count: @@ -74784,7 +73545,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *556 + items: *549 required: - repository_count - repositories @@ -74806,8 +73567,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *557 - over_limit_repos: *557 + no_codeql_db_repos: *550 + over_limit_repos: *550 required: - access_mismatch_repos - not_found_repos @@ -74823,7 +73584,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &558 + value: &551 summary: Default response value: id: 1 @@ -74975,10 +73736,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *558 + value: *551 repository_lists: summary: Response for a successful variant analysis submission - value: *558 + value: *551 '404': *6 '422': description: Unable to process variant analysis submission @@ -75006,8 +73767,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: + - *455 - *456 - - *457 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -75019,9 +73780,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *552 examples: - default: *558 + default: *551 '404': *6 '503': *190 x-github: @@ -75044,7 +73805,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *456 + - *455 - name: repo in: path description: The name of the controller repository. @@ -75079,7 +73840,7 @@ paths: type: object properties: repository: *115 - analysis_status: *560 + analysis_status: *553 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -75204,8 +73965,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -75290,7 +74051,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *541 + '403': *534 '404': *6 '503': *190 x-github: @@ -75311,8 +74072,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -75404,7 +74165,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *547 + '403': *540 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -75475,8 +74236,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -75484,7 +74245,7 @@ paths: schema: type: object properties: - commit_sha: *561 + commit_sha: *554 ref: type: string description: |- @@ -75542,7 +74303,7 @@ paths: schema: type: object properties: - id: *552 + id: *545 url: type: string description: The REST API URL for checking the status of the upload. @@ -75556,7 +74317,7 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *547 + '403': *540 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -75579,8 +74340,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: + - *455 - *456 - - *457 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -75626,7 +74387,7 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *541 + '403': *534 '404': description: Not Found if the sarif id does not match any upload '503': *190 @@ -75651,8 +74412,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -75733,8 +74494,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: + - *455 - *456 - - *457 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -75854,8 +74615,8 @@ paths: parameters: - *17 - *19 + - *455 - *456 - - *457 responses: '200': description: Response @@ -76169,8 +74930,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -76235,7 +74996,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *555 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -76243,7 +75004,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *555 '400': *14 '401': *25 '403': *29 @@ -76272,8 +75033,8 @@ paths: parameters: - *17 - *19 + - *455 - *456 - - *457 responses: '200': description: Response @@ -76337,8 +75098,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: + - *455 - *456 - - *457 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -76373,14 +75134,14 @@ paths: type: integer machines: type: array - items: &808 + items: &799 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *563 - required: *564 + properties: *556 + required: *557 examples: - default: &809 + default: &800 value: total_count: 2 machines: @@ -76420,8 +75181,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: + - *455 - *456 - - *457 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -76505,8 +75266,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: + - *455 - *456 - - *457 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -76572,8 +75333,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -76591,7 +75352,7 @@ paths: type: integer secrets: type: array - items: &568 + items: &561 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -76611,7 +75372,7 @@ paths: - created_at - updated_at examples: - default: *565 + default: *558 headers: Link: *43 x-github: @@ -76634,16 +75395,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: + - *455 - *456 - - *457 responses: '200': description: Response content: application/json: - schema: *566 + schema: *559 examples: - default: *567 + default: *560 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -76663,17 +75424,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: + - *455 - *456 - - *457 - *284 responses: '200': description: Response content: application/json: - schema: *568 + schema: *561 examples: - default: *569 + default: *562 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76693,8 +75454,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: + - *455 - *456 - - *457 - *284 requestBody: required: true @@ -76747,8 +75508,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: + - *455 - *456 - - *457 - *284 responses: '204': @@ -76777,8 +75538,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: + - *455 - *456 - - *457 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -76820,7 +75581,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &570 + properties: &563 login: type: string example: octocat @@ -76913,7 +75674,7 @@ paths: user_view_type: type: string example: public - required: &571 + required: &564 - avatar_url - events_url - followers_url @@ -76987,8 +75748,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: + - *455 - *456 - - *457 - *138 responses: '204': @@ -77035,8 +75796,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: + - *455 - *456 - - *457 - *138 requestBody: required: false @@ -77063,7 +75824,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &646 + schema: &639 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -77292,8 +76053,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: + - *455 - *456 - - *457 - *138 responses: '204': @@ -77325,8 +76086,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: + - *455 - *456 - - *457 - *138 responses: '200': @@ -77347,8 +76108,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *570 - required: *571 + properties: *563 + required: *564 nullable: true required: - permission @@ -77403,8 +76164,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -77414,7 +76175,7 @@ paths: application/json: schema: type: array - items: &572 + items: &565 title: Commit Comment description: Commit Comment type: object @@ -77472,7 +76233,7 @@ paths: - created_at - updated_at examples: - default: &575 + default: &568 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -77531,17 +76292,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: + - *455 - *456 - - *457 - *226 responses: '200': description: Response content: application/json: - schema: *572 + schema: *565 examples: - default: &576 + default: &569 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -77598,8 +76359,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: + - *455 - *456 - - *457 - *226 requestBody: required: true @@ -77622,7 +76383,7 @@ paths: description: Response content: application/json: - schema: *572 + schema: *565 examples: default: value: @@ -77673,8 +76434,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: + - *455 - *456 - - *457 - *226 responses: '204': @@ -77696,8 +76457,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: + - *455 - *456 - - *457 - *226 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -77724,9 +76485,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 '404': *6 @@ -77747,8 +76508,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: + - *455 - *456 - - *457 - *226 requestBody: required: true @@ -77781,16 +76542,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Reaction created content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '422': *15 x-github: githubCloudOnly: false @@ -77812,10 +76573,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: + - *455 - *456 - - *457 - *226 - - *448 + - *449 responses: '204': description: Response @@ -77864,8 +76625,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: + - *455 - *456 - - *457 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -77921,9 +76682,9 @@ paths: application/json: schema: type: array - items: *573 + items: *566 examples: - default: &699 + default: &692 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -78017,9 +76778,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: + - *455 - *456 - - *457 - - &574 + - &567 name: commit_sha description: The SHA of the commit. in: path @@ -78091,9 +76852,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: + - *455 - *456 - - *457 - - *574 + - *567 - *17 - *19 responses: @@ -78103,9 +76864,9 @@ paths: application/json: schema: type: array - items: *572 + items: *565 examples: - default: *575 + default: *568 headers: Link: *43 x-github: @@ -78133,9 +76894,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: + - *455 - *456 - - *457 - - *574 + - *567 requestBody: required: true content: @@ -78170,9 +76931,9 @@ paths: description: Response content: application/json: - schema: *572 + schema: *565 examples: - default: *576 + default: *569 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -78200,9 +76961,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: + - *455 - *456 - - *457 - - *574 + - *567 - *17 - *19 responses: @@ -78212,9 +76973,9 @@ paths: application/json: schema: type: array - items: *577 + items: *570 examples: - default: &691 + default: &684 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -78751,11 +77512,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: + - *455 - *456 - - *457 - *19 - *17 - - &578 + - &571 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -78770,9 +77531,9 @@ paths: description: Response content: application/json: - schema: *573 + schema: *566 examples: - default: &676 + default: &669 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -78885,11 +77646,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-for-a-git-reference parameters: + - *455 - *456 - - *457 - - *578 - - *579 - - *580 + - *571 + - *572 + - *573 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -78923,9 +77684,9 @@ paths: type: integer check_runs: type: array - items: *525 + items: *518 examples: - default: *581 + default: *574 headers: Link: *43 x-github: @@ -78950,9 +77711,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#list-check-suites-for-a-git-reference parameters: + - *455 - *456 - - *457 - - *578 + - *571 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -78960,7 +77721,7 @@ paths: schema: type: integer example: 1 - - *579 + - *572 - *17 - *19 responses: @@ -78978,7 +77739,7 @@ paths: type: integer check_suites: type: array - items: *530 + items: *523 examples: default: value: @@ -79178,9 +77939,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: + - *455 - *456 - - *457 - - *578 + - *571 - *17 - *19 responses: @@ -79378,9 +78139,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: + - *455 - *456 - - *457 - - *578 + - *571 - *17 - *19 responses: @@ -79390,7 +78151,7 @@ paths: application/json: schema: type: array - items: &753 + items: &746 title: Status description: The status of a commit. type: object @@ -79471,7 +78232,7 @@ paths: site_admin: false headers: Link: *43 - '301': *468 + '301': *461 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79499,8 +78260,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -79529,20 +78290,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *582 - required: *583 + properties: *575 + required: *576 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &584 + properties: &577 url: type: string format: uri html_url: type: string format: uri - required: &585 + required: &578 - url - html_url nullable: true @@ -79556,26 +78317,26 @@ paths: contributing: title: Community Health File type: object - properties: *584 - required: *585 + properties: *577 + required: *578 nullable: true readme: title: Community Health File type: object - properties: *584 - required: *585 + properties: *577 + required: *578 nullable: true issue_template: title: Community Health File type: object - properties: *584 - required: *585 + properties: *577 + required: *578 nullable: true pull_request_template: title: Community Health File type: object - properties: *584 - required: *585 + properties: *577 + required: *578 nullable: true required: - code_of_conduct @@ -79702,8 +78463,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: + - *455 - *456 - - *457 - *19 - *17 - name: basehead @@ -79746,8 +78507,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *573 - merge_base_commit: *573 + base_commit: *566 + merge_base_commit: *566 status: type: string enum: @@ -79767,10 +78528,10 @@ paths: example: 6 commits: type: array - items: *573 + items: *566 files: type: array - items: *586 + items: *579 required: - url - html_url @@ -80056,8 +78817,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: + - *455 - *456 - - *457 - name: path description: path parameter in: path @@ -80200,7 +78961,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &587 + response-if-content-is-a-file: &580 summary: Response if content is a file value: type: file @@ -80332,7 +79093,7 @@ paths: - size - type - url - - &704 + - &697 title: Content File description: Content File type: object @@ -80533,7 +79294,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *587 + response-if-content-is-a-file: *580 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -80602,7 +79363,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *588 + '302': *581 '304': *37 x-github: githubCloudOnly: false @@ -80625,8 +79386,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: + - *455 - *456 - - *457 - name: path description: path parameter in: path @@ -80719,7 +79480,7 @@ paths: description: Response content: application/json: - schema: &589 + schema: &582 title: File Commit description: File Commit type: object @@ -80871,7 +79632,7 @@ paths: description: Response content: application/json: - schema: *589 + schema: *582 examples: example-for-creating-a-file: value: @@ -80925,7 +79686,7 @@ paths: schema: oneOf: - *3 - - &628 + - &621 description: Repository rule violation was detected type: object properties: @@ -80946,7 +79707,7 @@ paths: items: type: object properties: - placeholder_id: &745 + placeholder_id: &738 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -80978,8 +79739,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: + - *455 - *456 - - *457 - name: path description: path parameter in: path @@ -81040,7 +79801,7 @@ paths: description: Response content: application/json: - schema: *589 + schema: *582 examples: default: value: @@ -81095,8 +79856,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: + - *455 - *456 - - *457 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -81219,8 +79980,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: + - *455 - *456 - - *457 - *323 - *324 - *325 @@ -81232,7 +79993,7 @@ paths: schema: type: string - *327 - - *590 + - *583 - *328 - *329 - *106 @@ -81253,7 +80014,7 @@ paths: application/json: schema: type: array - items: &593 + items: &586 type: object description: A Dependabot alert. properties: @@ -81299,7 +80060,7 @@ paths: - unknown - direct - transitive - security_advisory: *591 + security_advisory: *584 security_vulnerability: *127 url: *128 html_url: *129 @@ -81330,7 +80091,7 @@ paths: nullable: true maxLength: 280 fixed_at: *133 - auto_dismissed_at: *592 + auto_dismissed_at: *585 required: - number - state @@ -81560,9 +80321,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: + - *455 - *456 - - *457 - - &594 + - &587 name: alert_number in: path description: |- @@ -81577,7 +80338,7 @@ paths: description: Response content: application/json: - schema: *593 + schema: *586 examples: default: value: @@ -81690,9 +80451,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: + - *455 - *456 - - *457 - - *594 + - *587 requestBody: required: true content: @@ -81737,7 +80498,7 @@ paths: description: Response content: application/json: - schema: *593 + schema: *586 examples: default: value: @@ -81866,8 +80627,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -81885,7 +80646,7 @@ paths: type: integer secrets: type: array - items: &597 + items: &590 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -81938,16 +80699,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: + - *455 - *456 - - *457 responses: '200': description: Response content: application/json: - schema: *595 + schema: *588 examples: - default: *596 + default: *589 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81967,15 +80728,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: + - *455 - *456 - - *457 - *284 responses: '200': description: Response content: application/json: - schema: *597 + schema: *590 examples: default: value: @@ -82001,8 +80762,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: + - *455 - *456 - - *457 - *284 requestBody: required: true @@ -82055,8 +80816,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: + - *455 - *456 - - *457 - *284 responses: '204': @@ -82079,8 +80840,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: + - *455 - *456 - - *457 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -82240,8 +81001,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -82480,8 +81241,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -82556,7 +81317,7 @@ paths: - version - url additionalProperties: false - metadata: &598 + metadata: &591 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -82589,7 +81350,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *598 + metadata: *591 resolved: type: object description: A collection of resolved package dependencies. @@ -82602,7 +81363,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *598 + metadata: *591 relationship: type: string description: A notation of whether a dependency is requested @@ -82731,8 +81492,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: + - *455 - *456 - - *457 - name: sha description: The SHA recorded at creation time. in: query @@ -82772,9 +81533,9 @@ paths: application/json: schema: type: array - items: *599 + items: *592 examples: - default: *600 + default: *593 headers: Link: *43 x-github: @@ -82840,8 +81601,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -82922,7 +81683,7 @@ paths: description: Response content: application/json: - schema: *599 + schema: *592 examples: simple-example: summary: Simple example @@ -82995,9 +81756,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: + - *455 - *456 - - *457 - - &601 + - &594 name: deployment_id description: deployment_id parameter in: path @@ -83009,7 +81770,7 @@ paths: description: Response content: application/json: - schema: *599 + schema: *592 examples: default: value: @@ -83074,9 +81835,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: + - *455 - *456 - - *457 - - *601 + - *594 responses: '204': description: Response @@ -83098,9 +81859,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: + - *455 - *456 - - *457 - - *601 + - *594 - *17 - *19 responses: @@ -83110,7 +81871,7 @@ paths: application/json: schema: type: array - items: &602 + items: &595 title: Deployment Status description: The status of a deployment. type: object @@ -83271,9 +82032,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: + - *455 - *456 - - *457 - - *601 + - *594 requestBody: required: true content: @@ -83348,9 +82109,9 @@ paths: description: Response content: application/json: - schema: *602 + schema: *595 examples: - default: &603 + default: &596 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -83406,9 +82167,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: + - *455 - *456 - - *457 - - *601 + - *594 - name: status_id in: path required: true @@ -83419,9 +82180,9 @@ paths: description: Response content: application/json: - schema: *602 + schema: *595 examples: - default: *603 + default: *596 '404': *6 x-github: githubCloudOnly: false @@ -83448,12 +82209,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: + - *455 - *456 - - *457 - - *604 - - *605 - - *606 - - *607 + - *597 + - *598 + - *599 + - *600 - *17 - *19 responses: @@ -83463,9 +82224,9 @@ paths: application/json: schema: type: array - items: *608 + items: *601 examples: - default: *609 + default: *602 '404': *6 '403': *29 '500': *40 @@ -83489,8 +82250,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: + - *455 - *456 - - *457 - name: alert_number in: path required: true @@ -83502,7 +82263,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *608 + schema: *601 examples: default: value: @@ -83558,8 +82319,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: + - *455 - *456 - - *457 - name: alert_number in: path required: true @@ -83618,12 +82379,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: + - *455 - *456 - - *457 - *99 - *100 - *101 - - *610 + - *603 - *17 - *19 responses: @@ -83633,9 +82394,9 @@ paths: application/json: schema: type: array - items: *611 + items: *604 examples: - default: *612 + default: *605 '404': *6 '403': *29 '500': *40 @@ -83660,8 +82421,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: + - *455 - *456 - - *457 - name: alert_number in: path required: true @@ -83673,7 +82434,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *611 + schema: *604 examples: default: value: @@ -83731,8 +82492,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: + - *455 - *456 - - *457 - name: alert_number in: path required: true @@ -83801,8 +82562,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -83859,8 +82620,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -83877,7 +82638,7 @@ paths: type: integer environments: type: array - items: &614 + items: &607 title: Environment description: Details of a deployment environment type: object @@ -83929,7 +82690,7 @@ paths: type: type: string example: wait_timer - wait_timer: &616 + wait_timer: &609 type: integer example: 30 description: The amount of time to delay a job after @@ -83966,7 +82727,7 @@ paths: items: type: object properties: - type: *613 + type: *606 reviewer: anyOf: - *4 @@ -83990,7 +82751,7 @@ paths: - id - node_id - type - deployment_branch_policy: &617 + deployment_branch_policy: &610 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -84106,9 +82867,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: + - *455 - *456 - - *457 - - &615 + - &608 name: environment_name in: path required: true @@ -84121,9 +82882,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *607 examples: - default: &618 + default: &611 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -84207,9 +82968,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: + - *455 - *456 - - *457 - - *615 + - *608 requestBody: required: false content: @@ -84218,7 +82979,7 @@ paths: type: object nullable: true properties: - wait_timer: *616 + wait_timer: *609 prevent_self_review: type: boolean example: false @@ -84235,13 +82996,13 @@ paths: items: type: object properties: - type: *613 + type: *606 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *617 + deployment_branch_policy: *610 additionalProperties: false examples: default: @@ -84261,9 +83022,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *607 examples: - default: *618 + default: *611 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -84287,9 +83048,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: + - *455 - *456 - - *457 - - *615 + - *608 responses: '204': description: Default response @@ -84314,9 +83075,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: + - *455 - *456 - - *457 - - *615 + - *608 - *17 - *19 responses: @@ -84334,7 +83095,7 @@ paths: example: 2 branch_policies: type: array - items: &619 + items: &612 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -84391,9 +83152,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: + - *455 - *456 - - *457 - - *615 + - *608 requestBody: required: true content: @@ -84439,9 +83200,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *612 examples: - example-wildcard: &620 + example-wildcard: &613 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -84483,10 +83244,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: + - *455 - *456 - - *457 - - *615 - - &621 + - *608 + - &614 name: branch_policy_id in: path required: true @@ -84498,9 +83259,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *612 examples: - default: *620 + default: *613 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84519,10 +83280,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: + - *455 - *456 - - *457 - - *615 - - *621 + - *608 + - *614 requestBody: required: true content: @@ -84550,9 +83311,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *612 examples: - default: *620 + default: *613 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84571,10 +83332,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: + - *455 - *456 - - *457 - - *615 - - *621 + - *608 + - *614 responses: '204': description: Response @@ -84599,9 +83360,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *615 - - *457 + - *608 - *456 + - *455 responses: '200': description: List of deployment protection rules @@ -84617,7 +83378,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &622 + items: &615 title: Deployment protection rule description: Deployment protection rule type: object @@ -84636,7 +83397,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &623 + app: &616 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -84735,9 +83496,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *615 - - *457 + - *608 - *456 + - *455 requestBody: content: application/json: @@ -84758,9 +83519,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *622 + schema: *615 examples: - default: &624 + default: &617 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -84795,9 +83556,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *615 - - *457 + - *608 - *456 + - *455 - *19 - *17 responses: @@ -84816,7 +83577,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *623 + items: *616 examples: default: value: @@ -84851,10 +83612,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: + - *455 - *456 - - *457 - - *615 - - &625 + - *608 + - &618 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -84866,9 +83627,9 @@ paths: description: Response content: application/json: - schema: *622 + schema: *615 examples: - default: *624 + default: *617 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84889,10 +83650,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *615 - - *457 + - *608 - *456 - - *625 + - *455 + - *618 responses: '204': description: Response @@ -84918,9 +83679,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: + - *455 - *456 - - *457 - - *615 + - *608 - *17 - *19 responses: @@ -84938,9 +83699,9 @@ paths: type: integer secrets: type: array - items: *491 + items: *484 examples: - default: *492 + default: *485 headers: Link: *43 x-github: @@ -84965,17 +83726,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: + - *455 - *456 - - *457 - - *615 + - *608 responses: '200': description: Response content: application/json: - schema: *493 + schema: *486 examples: - default: *494 + default: *487 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84997,18 +83758,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: + - *455 - *456 - - *457 - - *615 + - *608 - *284 responses: '200': description: Response content: application/json: - schema: *491 + schema: *484 examples: - default: *626 + default: *619 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85030,9 +83791,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: + - *455 - *456 - - *457 - - *615 + - *608 - *284 requestBody: required: true @@ -85090,9 +83851,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: + - *455 - *456 - - *457 - - *615 + - *608 - *284 responses: '204': @@ -85118,10 +83879,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: + - *455 - *456 - - *457 - - *615 - - *478 + - *608 + - *471 - *19 responses: '200': @@ -85138,9 +83899,9 @@ paths: type: integer variables: type: array - items: *495 + items: *488 examples: - default: *496 + default: *489 headers: Link: *43 x-github: @@ -85163,9 +83924,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: + - *455 - *456 - - *457 - - *615 + - *608 requestBody: required: true content: @@ -85217,18 +83978,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: + - *455 - *456 - - *457 - - *615 + - *608 - *287 responses: '200': description: Response content: application/json: - schema: *495 + schema: *488 examples: - default: *627 + default: *620 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85249,10 +84010,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: + - *455 - *456 - - *457 - *287 - - *615 + - *608 requestBody: required: true content: @@ -85294,10 +84055,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: + - *455 - *456 - - *457 - *287 - - *615 + - *608 responses: '204': description: Response @@ -85319,8 +84080,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -85388,8 +84149,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: + - *455 - *456 - - *457 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -85548,8 +84309,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: + - *455 - *456 - - *457 requestBody: required: false content: @@ -85581,9 +84342,9 @@ paths: description: Response content: application/json: - schema: *467 + schema: *460 examples: - default: *469 + default: *462 '400': *14 '422': *15 '403': *29 @@ -85604,8 +84365,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -85665,7 +84426,7 @@ paths: schema: oneOf: - *249 - - *628 + - *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85690,8 +84451,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: + - *455 - *456 - - *457 - name: file_sha in: path required: true @@ -85790,8 +84551,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -85900,7 +84661,7 @@ paths: description: Response content: application/json: - schema: &629 + schema: &622 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -86114,15 +84875,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: + - *455 - *456 - - *457 - - *574 + - *567 responses: '200': description: Response content: application/json: - schema: *629 + schema: *622 examples: default: value: @@ -86178,9 +84939,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: + - *455 - *456 - - *457 - - &630 + - &623 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -86197,7 +84958,7 @@ paths: application/json: schema: type: array - items: &631 + items: &624 title: Git Reference description: Git references within a repository type: object @@ -86272,17 +85033,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: + - *455 - *456 - - *457 - - *630 + - *623 responses: '200': description: Response content: application/json: - schema: *631 + schema: *624 examples: - default: &632 + default: &625 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -86311,8 +85072,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -86341,9 +85102,9 @@ paths: description: Response content: application/json: - schema: *631 + schema: *624 examples: - default: *632 + default: *625 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -86369,9 +85130,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: + - *455 - *456 - - *457 - - *630 + - *623 requestBody: required: true content: @@ -86400,9 +85161,9 @@ paths: description: Response content: application/json: - schema: *631 + schema: *624 examples: - default: *632 + default: *625 '422': *15 '409': *114 x-github: @@ -86420,9 +85181,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: + - *455 - *456 - - *457 - - *630 + - *623 responses: '204': description: Response @@ -86477,8 +85238,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -86545,7 +85306,7 @@ paths: description: Response content: application/json: - schema: &634 + schema: &627 title: Git Tag description: Metadata for a Git tag type: object @@ -86596,7 +85357,7 @@ paths: - sha - type - url - verification: *633 + verification: *626 required: - sha - url @@ -86606,7 +85367,7 @@ paths: - tag - message examples: - default: &635 + default: &628 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -86679,8 +85440,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: + - *455 - *456 - - *457 - name: tag_sha in: path required: true @@ -86691,9 +85452,9 @@ paths: description: Response content: application/json: - schema: *634 + schema: *627 examples: - default: *635 + default: *628 '404': *6 '409': *114 x-github: @@ -86717,8 +85478,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -86791,7 +85552,7 @@ paths: description: Response content: application/json: - schema: &636 + schema: &629 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -86887,8 +85648,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: + - *455 - *456 - - *457 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -86911,7 +85672,7 @@ paths: description: Response content: application/json: - schema: *636 + schema: *629 examples: default-response: summary: Default response @@ -86970,8 +85731,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -86981,7 +85742,7 @@ paths: application/json: schema: type: array - items: &637 + items: &630 title: Webhook description: Webhooks for repositories. type: object @@ -87035,7 +85796,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &890 + last_response: &881 title: Hook Response type: object properties: @@ -87109,8 +85870,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: + - *455 - *456 - - *457 requestBody: required: false content: @@ -87162,9 +85923,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *630 examples: - default: &638 + default: &631 value: type: Repository id: 12345678 @@ -87212,17 +85973,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: + - *455 - *456 - - *457 - *337 responses: '200': description: Response content: application/json: - schema: *637 + schema: *630 examples: - default: *638 + default: *631 '404': *6 x-github: githubCloudOnly: false @@ -87242,8 +86003,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: + - *455 - *456 - - *457 - *337 requestBody: required: true @@ -87289,9 +86050,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *630 examples: - default: *638 + default: *631 '422': *15 '404': *6 x-github: @@ -87312,8 +86073,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: + - *455 - *456 - - *457 - *337 responses: '204': @@ -87338,8 +86099,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: + - *455 - *456 - - *457 - *337 responses: '200': @@ -87367,8 +86128,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: + - *455 - *456 - - *457 - *337 requestBody: required: false @@ -87413,8 +86174,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: + - *455 - *456 - - *457 - *337 - *17 - *338 @@ -87446,8 +86207,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: + - *455 - *456 - - *457 - *337 - *16 responses: @@ -87476,8 +86237,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: + - *455 - *456 - - *457 - *337 - *16 responses: @@ -87501,8 +86262,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: + - *455 - *456 - - *457 - *337 responses: '204': @@ -87528,8 +86289,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: + - *455 - *456 - - *457 - *337 responses: '204': @@ -87553,8 +86314,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response if immutable releases are enabled @@ -87600,8 +86361,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: + - *455 - *456 - - *457 responses: '204': *150 '409': *114 @@ -87621,8 +86382,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: + - *455 - *456 - - *457 responses: '204': *150 '409': *114 @@ -87679,14 +86440,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: + - *455 - *456 - - *457 responses: '200': description: Response content: application/json: - schema: &639 + schema: &632 title: Import description: A repository import from an external source. type: object @@ -87785,7 +86546,7 @@ paths: - html_url - authors_url examples: - default: &642 + default: &635 value: vcs: subversion use_lfs: true @@ -87801,7 +86562,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &640 + '503': &633 description: Unavailable due to service under maintenance. content: application/json: @@ -87830,8 +86591,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -87879,7 +86640,7 @@ paths: description: Response content: application/json: - schema: *639 + schema: *632 examples: default: value: @@ -87904,7 +86665,7 @@ paths: type: string '422': *15 '404': *6 - '503': *640 + '503': *633 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87932,8 +86693,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: + - *455 - *456 - - *457 requestBody: required: false content: @@ -87982,7 +86743,7 @@ paths: description: Response content: application/json: - schema: *639 + schema: *632 examples: example-1: summary: Example 1 @@ -88030,7 +86791,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *640 + '503': *633 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88053,12 +86814,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: + - *455 - *456 - - *457 responses: '204': description: Response - '503': *640 + '503': *633 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88084,9 +86845,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: + - *455 - *456 - - *457 - - &830 + - &821 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -88100,7 +86861,7 @@ paths: application/json: schema: type: array - items: &641 + items: &634 title: Porter Author description: Porter Author type: object @@ -88154,7 +86915,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *640 + '503': *633 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88179,8 +86940,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: + - *455 - *456 - - *457 - name: author_id in: path required: true @@ -88210,7 +86971,7 @@ paths: description: Response content: application/json: - schema: *641 + schema: *634 examples: default: value: @@ -88223,7 +86984,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *640 + '503': *633 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88247,8 +87008,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -88289,7 +87050,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *640 + '503': *633 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88317,8 +87078,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -88345,11 +87106,11 @@ paths: description: Response content: application/json: - schema: *639 + schema: *632 examples: - default: *642 + default: *635 '422': *15 - '503': *640 + '503': *633 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88372,8 +87133,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -88381,8 +87142,8 @@ paths: application/json: schema: *22 examples: - default: *643 - '301': *468 + default: *636 + '301': *461 '404': *6 x-github: githubCloudOnly: false @@ -88402,8 +87163,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -88416,7 +87177,7 @@ paths: properties: {} additionalProperties: false examples: - default: &645 + default: &638 value: limit: collaborators_only origin: repository @@ -88441,13 +87202,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: application/json: - schema: *644 + schema: *637 examples: default: summary: Example request body @@ -88461,7 +87222,7 @@ paths: application/json: schema: *355 examples: - default: *645 + default: *638 '409': description: Response x-github: @@ -88483,8 +87244,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -88507,8 +87268,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -88518,9 +87279,9 @@ paths: application/json: schema: type: array - items: *646 + items: *639 examples: - default: &823 + default: &814 value: - id: 1 repository: @@ -88651,8 +87412,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: + - *455 - *456 - - *457 - *359 requestBody: required: false @@ -88682,7 +87443,7 @@ paths: description: Response content: application/json: - schema: *646 + schema: *639 examples: default: value: @@ -88813,8 +87574,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: + - *455 - *456 - - *457 - *359 responses: '204': @@ -88846,8 +87607,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: + - *455 - *456 - - *457 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -88920,7 +87681,7 @@ paths: type: array items: *227 examples: - default: &656 + default: &649 value: - id: 1 node_id: MDU6SXNzdWUx @@ -89068,7 +87829,7 @@ paths: state_reason: completed headers: Link: *43 - '301': *468 + '301': *461 '422': *15 '404': *6 x-github: @@ -89097,8 +87858,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -89182,7 +87943,7 @@ paths: application/json: schema: *227 examples: - default: &653 + default: &646 value: id: 1 node_id: MDU6SXNzdWUx @@ -89338,7 +88099,7 @@ paths: '422': *15 '503': *190 '404': *6 - '410': *647 + '410': *640 x-github: triggersNotification: true githubCloudOnly: false @@ -89366,8 +88127,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: + - *455 - *456 - - *457 - *237 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -89388,9 +88149,9 @@ paths: application/json: schema: type: array - items: *648 + items: *641 examples: - default: &655 + default: &648 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -89448,17 +88209,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: + - *455 - *456 - - *457 - *226 responses: '200': description: Response content: application/json: - schema: *648 + schema: *641 examples: - default: &649 + default: &642 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -89512,8 +88273,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: + - *455 - *456 - - *457 - *226 requestBody: required: true @@ -89536,9 +88297,9 @@ paths: description: Response content: application/json: - schema: *648 + schema: *641 examples: - default: *649 + default: *642 '422': *15 x-github: githubCloudOnly: false @@ -89556,8 +88317,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: + - *455 - *456 - - *457 - *226 responses: '204': @@ -89578,8 +88339,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: + - *455 - *456 - - *457 - *226 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -89606,9 +88367,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 '404': *6 @@ -89629,8 +88390,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: + - *455 - *456 - - *457 - *226 requestBody: required: true @@ -89663,16 +88424,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Reaction created content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '422': *15 x-github: githubCloudOnly: false @@ -89694,10 +88455,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: + - *455 - *456 - - *457 - *226 - - *448 + - *449 responses: '204': description: Response @@ -89717,8 +88478,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -89728,7 +88489,7 @@ paths: application/json: schema: type: array - items: &652 + items: &645 title: Issue Event description: Issue Event type: object @@ -89771,8 +88532,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *650 - required: *651 + properties: *643 + required: *644 nullable: true label: title: Issue Event Label @@ -90079,8 +88840,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: + - *455 - *456 - - *457 - name: event_id in: path required: true @@ -90091,7 +88852,7 @@ paths: description: Response content: application/json: - schema: *652 + schema: *645 examples: default: value: @@ -90284,7 +89045,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *647 + '410': *640 '403': *29 x-github: githubCloudOnly: false @@ -90318,9 +89079,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: + - *455 - *456 - - *457 - - &654 + - &647 name: issue_number description: The number that identifies the issue. in: path @@ -90334,10 +89095,10 @@ paths: application/json: schema: *227 examples: - default: *653 - '301': *468 + default: *646 + '301': *461 '404': *6 - '410': *647 + '410': *640 '304': *37 x-github: githubCloudOnly: false @@ -90362,9 +89123,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: false content: @@ -90470,13 +89231,13 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *646 '422': *15 '503': *190 '403': *29 - '301': *468 + '301': *461 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90494,9 +89255,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: false content: @@ -90524,7 +89285,7 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *646 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90540,9 +89301,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: content: application/json: @@ -90569,7 +89330,7 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *646 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90591,9 +89352,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 - name: assignee in: path required: true @@ -90633,9 +89394,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: + - *455 - *456 - - *457 - - *654 + - *647 - *217 - *17 - *19 @@ -90646,13 +89407,13 @@ paths: application/json: schema: type: array - items: *648 + items: *641 examples: - default: *655 + default: *648 headers: Link: *43 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90681,9 +89442,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: true content: @@ -90705,16 +89466,16 @@ paths: description: Response content: application/json: - schema: *648 + schema: *641 examples: - default: *649 + default: *642 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *647 + '410': *640 '422': *15 '404': *6 x-github: @@ -90742,9 +89503,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: + - *455 - *456 - - *457 - - *654 + - *647 - *17 - *19 responses: @@ -90756,12 +89517,12 @@ paths: type: array items: *227 examples: - default: *656 + default: *649 headers: Link: *43 - '301': *468 + '301': *461 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90789,9 +89550,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: true content: @@ -90815,15 +89576,15 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *646 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *468 + '301': *461 '403': *29 - '410': *647 + '410': *640 '422': *15 '404': *6 x-github: @@ -90854,9 +89615,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: + - *455 - *456 - - *457 - - *654 + - *647 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -90870,13 +89631,13 @@ paths: application/json: schema: *227 examples: - default: *653 - '301': *468 + default: *646 + '301': *461 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *647 + '410': *640 x-github: triggersNotification: true githubCloudOnly: false @@ -90902,9 +89663,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: + - *455 - *456 - - *457 - - *654 + - *647 - *17 - *19 responses: @@ -90916,12 +89677,12 @@ paths: type: array items: *227 examples: - default: *656 + default: *649 headers: Link: *43 - '301': *468 + '301': *461 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90938,9 +89699,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: + - *455 - *456 - - *457 - - *654 + - *647 - *17 - *19 responses: @@ -90954,7 +89715,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &659 + - &652 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -91008,7 +89769,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &660 + - &653 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -91144,7 +89905,7 @@ paths: - performed_via_github_app - assignee - assigner - - &661 + - &654 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -91195,7 +89956,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &662 + - &655 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -91246,7 +90007,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &663 + - &656 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -91300,7 +90061,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &664 + - &657 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -91347,7 +90108,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &665 + - &658 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -91394,7 +90155,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &666 + - &659 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -91454,7 +90215,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &667 + - &660 title: Locked Issue Event description: Locked Issue Event type: object @@ -91502,7 +90263,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &668 + - &661 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -91568,7 +90329,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &669 + - &662 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -91634,7 +90395,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &670 + - &663 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -91700,7 +90461,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &671 + - &664 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -91791,7 +90552,7 @@ paths: color: red headers: Link: *43 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91808,9 +90569,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 - *17 - *19 responses: @@ -91820,7 +90581,7 @@ paths: application/json: schema: type: array - items: &657 + items: &650 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -91867,7 +90628,7 @@ paths: - color - default examples: - default: &658 + default: &651 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -91885,9 +90646,9 @@ paths: default: false headers: Link: *43 - '301': *468 + '301': *461 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91904,9 +90665,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: false content: @@ -91965,12 +90726,12 @@ paths: application/json: schema: type: array - items: *657 + items: *650 examples: - default: *658 - '301': *468 + default: *651 + '301': *461 '404': *6 - '410': *647 + '410': *640 '422': *15 x-github: githubCloudOnly: false @@ -91987,9 +90748,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: false content: @@ -92049,12 +90810,12 @@ paths: application/json: schema: type: array - items: *657 + items: *650 examples: - default: *658 - '301': *468 + default: *651 + '301': *461 '404': *6 - '410': *647 + '410': *640 '422': *15 x-github: githubCloudOnly: false @@ -92071,15 +90832,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 responses: '204': description: Response - '301': *468 + '301': *461 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92098,9 +90859,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 - name: name in: path required: true @@ -92113,7 +90874,7 @@ paths: application/json: schema: type: array - items: *657 + items: *650 examples: default: value: @@ -92124,9 +90885,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *468 + '301': *461 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92146,9 +90907,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: false content: @@ -92176,7 +90937,7 @@ paths: '204': description: Response '403': *29 - '410': *647 + '410': *640 '404': *6 '422': *15 x-github: @@ -92194,9 +90955,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 responses: '204': description: Response @@ -92226,9 +90987,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 responses: '200': description: Response @@ -92236,10 +90997,10 @@ paths: application/json: schema: *227 examples: - default: *653 - '301': *468 + default: *646 + '301': *461 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92256,9 +91017,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -92284,13 +91045,13 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92308,9 +91069,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: true content: @@ -92342,16 +91103,16 @@ paths: description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '422': *15 x-github: githubCloudOnly: false @@ -92373,10 +91134,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: + - *455 - *456 - - *457 - - *654 - - *448 + - *647 + - *449 responses: '204': description: Response @@ -92405,9 +91166,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: true content: @@ -92431,7 +91192,7 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *646 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -92464,9 +91225,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: + - *455 - *456 - - *457 - - *654 + - *647 - *17 - *19 responses: @@ -92478,11 +91239,11 @@ paths: type: array items: *227 examples: - default: *656 + default: *649 headers: Link: *43 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92510,9 +91271,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: true content: @@ -92541,14 +91302,14 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *646 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *647 + '410': *640 '422': *15 '404': *6 x-github: @@ -92568,9 +91329,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 requestBody: required: true content: @@ -92603,7 +91364,7 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *646 '403': *29 '404': *6 '422': *7 @@ -92625,9 +91386,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: + - *455 - *456 - - *457 - - *654 + - *647 - *17 - *19 responses: @@ -92642,19 +91403,19 @@ paths: description: Timeline Event type: object anyOf: + - *652 + - *653 + - *654 + - *655 + - *656 + - *657 + - *658 - *659 - *660 - *661 - *662 - *663 - *664 - - *665 - - *666 - - *667 - - *668 - - *669 - - *670 - - *671 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -92963,7 +91724,7 @@ paths: type: string comments: type: array - items: &693 + items: &686 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -93172,7 +91933,7 @@ paths: type: string comments: type: array - items: *572 + items: *565 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -93461,7 +92222,7 @@ paths: headers: Link: *43 '404': *6 - '410': *647 + '410': *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93478,8 +92239,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -93489,7 +92250,7 @@ paths: application/json: schema: type: array - items: &672 + items: &665 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -93555,8 +92316,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -93592,9 +92353,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *665 examples: - default: &673 + default: &666 value: id: 1 key: ssh-rsa AAA... @@ -93628,9 +92389,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: + - *455 - *456 - - *457 - - &674 + - &667 name: key_id description: The unique identifier of the key. in: path @@ -93642,9 +92403,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *665 examples: - default: *673 + default: *666 '404': *6 x-github: githubCloudOnly: false @@ -93662,9 +92423,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: + - *455 - *456 - - *457 - - *674 + - *667 responses: '204': description: Response @@ -93684,8 +92445,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -93695,9 +92456,9 @@ paths: application/json: schema: type: array - items: *657 + items: *650 examples: - default: *658 + default: *651 headers: Link: *43 '404': *6 @@ -93718,8 +92479,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -93755,9 +92516,9 @@ paths: description: Response content: application/json: - schema: *657 + schema: *650 examples: - default: &675 + default: &668 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -93789,8 +92550,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: + - *455 - *456 - - *457 - name: name in: path required: true @@ -93801,9 +92562,9 @@ paths: description: Response content: application/json: - schema: *657 + schema: *650 examples: - default: *675 + default: *668 '404': *6 x-github: githubCloudOnly: false @@ -93820,8 +92581,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: + - *455 - *456 - - *457 - name: name in: path required: true @@ -93860,7 +92621,7 @@ paths: description: Response content: application/json: - schema: *657 + schema: *650 examples: default: value: @@ -93886,8 +92647,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: + - *455 - *456 - - *457 - name: name in: path required: true @@ -93913,8 +92674,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -93950,8 +92711,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: + - *455 - *456 - - *457 responses: '202': *39 '403': @@ -93979,8 +92740,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -94006,9 +92767,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: + - *455 - *456 - - *457 - - *548 + - *541 responses: '200': description: Response @@ -94153,8 +92914,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -94219,8 +92980,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -94254,9 +93015,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *573 + schema: *566 examples: - default: *676 + default: *669 '204': description: Response when already merged '404': @@ -94281,8 +93042,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: + - *455 - *456 - - *457 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -94323,7 +93084,7 @@ paths: application/json: schema: type: array - items: &677 + items: &670 title: Milestone description: A collection of related issues and pull requests. type: object @@ -94384,8 +93145,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -94425,9 +93186,9 @@ paths: description: Response content: application/json: - schema: *677 + schema: *670 examples: - default: &678 + default: &671 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -94486,9 +93247,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: + - *455 - *456 - - *457 - - &679 + - &672 name: milestone_number description: The number that identifies the milestone. in: path @@ -94500,9 +93261,9 @@ paths: description: Response content: application/json: - schema: *677 + schema: *670 examples: - default: *678 + default: *671 '404': *6 x-github: githubCloudOnly: false @@ -94519,9 +93280,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: + - *455 - *456 - - *457 - - *679 + - *672 requestBody: required: false content: @@ -94559,9 +93320,9 @@ paths: description: Response content: application/json: - schema: *677 + schema: *670 examples: - default: *678 + default: *671 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94577,9 +93338,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: + - *455 - *456 - - *457 - - *679 + - *672 responses: '204': description: Response @@ -94600,9 +93361,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: + - *455 - *456 - - *457 - - *679 + - *672 - *17 - *19 responses: @@ -94612,9 +93373,9 @@ paths: application/json: schema: type: array - items: *657 + items: *650 examples: - default: *658 + default: *651 headers: Link: *43 x-github: @@ -94633,12 +93394,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: + - *455 - *456 - - *457 - - *680 - - *681 + - *673 + - *674 - *217 - - *682 + - *675 - *17 - *19 responses: @@ -94650,7 +93411,7 @@ paths: type: array items: *240 examples: - default: *683 + default: *676 headers: Link: *43 x-github: @@ -94674,8 +93435,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: + - *455 - *456 - - *457 requestBody: required: false content: @@ -94733,14 +93494,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: + - *455 - *456 - - *457 responses: '200': description: Response content: application/json: - schema: &684 + schema: &677 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -94865,7 +93626,7 @@ paths: - custom_404 - public examples: - default: &685 + default: &678 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -94906,8 +93667,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -94961,9 +93722,9 @@ paths: description: Response content: application/json: - schema: *684 + schema: *677 examples: - default: *685 + default: *678 '422': *15 '409': *114 x-github: @@ -94986,8 +93747,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#update-information-about-a-apiname-pages-site parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -95094,8 +93855,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -95121,8 +93882,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -95132,7 +93893,7 @@ paths: application/json: schema: type: array - items: &686 + items: &679 title: Page Build description: Page Build type: object @@ -95226,8 +93987,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: + - *455 - *456 - - *457 responses: '201': description: Response @@ -95272,16 +94033,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: + - *455 - *456 - - *457 responses: '200': description: Response content: application/json: - schema: *686 + schema: *679 examples: - default: &687 + default: &680 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -95329,8 +94090,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: + - *455 - *456 - - *457 - name: build_id in: path required: true @@ -95341,9 +94102,9 @@ paths: description: Response content: application/json: - schema: *686 + schema: *679 examples: - default: *687 + default: *680 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95363,8 +94124,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -95469,9 +94230,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: + - *455 - *456 - - *457 - - &688 + - &681 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -95529,9 +94290,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: + - *455 - *456 - - *457 - - *688 + - *681 responses: '204': *150 '404': *6 @@ -95558,8 +94319,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -95817,8 +94578,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Private vulnerability reporting status @@ -95855,8 +94616,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: + - *455 - *456 - - *457 responses: '204': *150 '422': *14 @@ -95877,8 +94638,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: + - *455 - *456 - - *457 responses: '204': *150 '422': *14 @@ -95900,8 +94661,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -95911,7 +94672,7 @@ paths: type: array items: *151 examples: - default: *689 + default: *682 '403': *29 '404': *6 x-github: @@ -95933,8 +94694,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -95950,7 +94711,7 @@ paths: required: - properties examples: - default: *690 + default: *683 responses: '204': description: No Content when custom property values are successfully created @@ -95988,8 +94749,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: + - *455 - *456 - - *457 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -96049,9 +94810,9 @@ paths: application/json: schema: type: array - items: *577 + items: *570 examples: - default: *691 + default: *684 headers: Link: *43 '304': *37 @@ -96083,8 +94844,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -96149,7 +94910,7 @@ paths: description: Response content: application/json: - schema: &695 + schema: &688 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -96306,7 +95067,7 @@ paths: nullable: true requested_teams: type: array - items: *429 + items: *430 nullable: true head: type: object @@ -96363,7 +95124,7 @@ paths: - review_comment - self author_association: *214 - auto_merge: *692 + auto_merge: *685 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -96455,7 +95216,7 @@ paths: - merged_by - review_comments examples: - default: &696 + default: &689 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -96982,8 +95743,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: + - *455 - *456 - - *457 - name: sort in: query required: false @@ -97012,9 +95773,9 @@ paths: application/json: schema: type: array - items: *693 + items: *686 examples: - default: &698 + default: &691 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -97091,17 +95852,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: + - *455 - *456 - - *457 - *226 responses: '200': description: Response content: application/json: - schema: *693 + schema: *686 examples: - default: &694 + default: &687 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -97176,8 +95937,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: + - *455 - *456 - - *457 - *226 requestBody: required: true @@ -97200,9 +95961,9 @@ paths: description: Response content: application/json: - schema: *693 + schema: *686 examples: - default: *694 + default: *687 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97218,8 +95979,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: + - *455 - *456 - - *457 - *226 responses: '204': @@ -97241,8 +96002,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: + - *455 - *456 - - *457 - *226 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -97269,9 +96030,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 '404': *6 @@ -97292,8 +96053,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: + - *455 - *456 - - *457 - *226 requestBody: required: true @@ -97326,16 +96087,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Reaction created content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '422': *15 x-github: githubCloudOnly: false @@ -97357,10 +96118,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: + - *455 - *456 - - *457 - *226 - - *448 + - *449 responses: '204': description: Response @@ -97403,9 +96164,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: + - *455 - *456 - - *457 - - &697 + - &690 name: pull_number description: The number that identifies the pull request. in: path @@ -97418,9 +96179,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *695 + schema: *688 examples: - default: *696 + default: *689 '304': *37 '404': *6 '406': @@ -97455,9 +96216,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 requestBody: required: false content: @@ -97499,9 +96260,9 @@ paths: description: Response content: application/json: - schema: *695 + schema: *688 examples: - default: *696 + default: *689 '422': *15 '403': *29 x-github: @@ -97523,9 +96284,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 requestBody: required: true content: @@ -97587,7 +96348,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *555 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -97595,7 +96356,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *555 '401': *25 '403': *29 '404': *6 @@ -97625,9 +96386,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 - *237 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -97648,9 +96409,9 @@ paths: application/json: schema: type: array - items: *693 + items: *686 examples: - default: *698 + default: *691 headers: Link: *43 x-github: @@ -97683,9 +96444,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 requestBody: required: true content: @@ -97790,7 +96551,7 @@ paths: description: Response content: application/json: - schema: *693 + schema: *686 examples: example-for-a-multi-line-comment: value: @@ -97878,9 +96639,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment parameters: + - *455 - *456 - - *457 - - *697 + - *690 - *226 requestBody: required: true @@ -97903,7 +96664,7 @@ paths: description: Response content: application/json: - schema: *693 + schema: *686 examples: default: value: @@ -97989,9 +96750,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 - *17 - *19 responses: @@ -98001,9 +96762,9 @@ paths: application/json: schema: type: array - items: *573 + items: *566 examples: - default: *699 + default: *692 headers: Link: *43 x-github: @@ -98033,9 +96794,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: + - *455 - *456 - - *457 - - *697 + - *690 - *17 - *19 responses: @@ -98045,7 +96806,7 @@ paths: application/json: schema: type: array - items: *586 + items: *579 examples: default: value: @@ -98083,9 +96844,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: + - *455 - *456 - - *457 - - *697 + - *690 responses: '204': description: Response if pull request has been merged @@ -98108,9 +96869,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 requestBody: required: false content: @@ -98221,9 +96982,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 responses: '200': description: Response @@ -98298,9 +97059,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 requestBody: required: false content: @@ -98337,7 +97098,7 @@ paths: description: Response content: application/json: - schema: *577 + schema: *570 examples: default: value: @@ -98873,9 +97634,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 requestBody: required: true content: @@ -98909,7 +97670,7 @@ paths: description: Response content: application/json: - schema: *577 + schema: *570 examples: default: value: @@ -99414,9 +98175,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 - *17 - *19 responses: @@ -99426,7 +98187,7 @@ paths: application/json: schema: type: array - items: &700 + items: &693 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -99577,9 +98338,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 + - *690 requestBody: required: false content: @@ -99665,9 +98426,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *693 examples: - default: &702 + default: &695 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -99730,10 +98491,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 - - &701 + - *690 + - &694 name: review_id description: The unique identifier of the review. in: path @@ -99745,9 +98506,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *693 examples: - default: &703 + default: &696 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -99806,10 +98567,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 - - *701 + - *690 + - *694 requestBody: required: true content: @@ -99832,7 +98593,7 @@ paths: description: Response content: application/json: - schema: *700 + schema: *693 examples: default: value: @@ -99894,18 +98655,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 - - *701 + - *690 + - *694 responses: '200': description: Response content: application/json: - schema: *700 + schema: *693 examples: - default: *702 + default: *695 '422': *7 '404': *6 x-github: @@ -99932,10 +98693,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: + - *455 - *456 - - *457 - - *697 - - *701 + - *690 + - *694 - *17 - *19 responses: @@ -100170,10 +98931,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 - - *701 + - *690 + - *694 requestBody: required: true content: @@ -100201,7 +98962,7 @@ paths: description: Response content: application/json: - schema: *700 + schema: *693 examples: default: value: @@ -100264,10 +99025,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: + - *455 - *456 - - *457 - - *697 - - *701 + - *690 + - *694 requestBody: required: true content: @@ -100302,9 +99063,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *693 examples: - default: *703 + default: *696 '404': *6 '422': *7 '403': *29 @@ -100326,9 +99087,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: + - *455 - *456 - - *457 - - *697 + - *690 requestBody: required: false content: @@ -100391,8 +99152,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: + - *455 - *456 - - *457 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -100405,9 +99166,9 @@ paths: description: Response content: application/json: - schema: *704 + schema: *697 examples: - default: &705 + default: &698 value: type: file encoding: base64 @@ -100449,8 +99210,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme-for-a-directory parameters: + - *455 - *456 - - *457 - name: dir description: The alternate path to look for a README file in: path @@ -100470,9 +99231,9 @@ paths: description: Response content: application/json: - schema: *704 + schema: *697 examples: - default: *705 + default: *698 '404': *6 '422': *15 x-github: @@ -100494,8 +99255,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -100505,7 +99266,7 @@ paths: application/json: schema: type: array - items: &706 + items: &699 title: Release description: A release. type: object @@ -100576,7 +99337,7 @@ paths: author: *4 assets: type: array - items: &707 + items: &700 title: Release Asset description: Data related to a release. type: object @@ -100763,8 +99524,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -100840,9 +99601,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *699 examples: - default: &710 + default: &703 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -100947,9 +99708,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: + - *455 - *456 - - *457 - - &708 + - &701 name: asset_id description: The unique identifier of the asset. in: path @@ -100961,9 +99722,9 @@ paths: description: Response content: application/json: - schema: *707 + schema: *700 examples: - default: &709 + default: &702 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -100998,7 +99759,7 @@ paths: type: User site_admin: false '404': *6 - '302': *588 + '302': *581 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101014,9 +99775,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: + - *455 - *456 - - *457 - - *708 + - *701 requestBody: required: false content: @@ -101044,9 +99805,9 @@ paths: description: Response content: application/json: - schema: *707 + schema: *700 examples: - default: *709 + default: *702 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101062,9 +99823,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: + - *455 - *456 - - *457 - - *708 + - *701 responses: '204': description: Response @@ -101088,8 +99849,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#generate-release-notes-content-for-a-release parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -101174,16 +99935,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: + - *455 - *456 - - *457 responses: '200': description: Response content: application/json: - schema: *706 + schema: *699 examples: - default: *710 + default: *703 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101200,8 +99961,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: + - *455 - *456 - - *457 - name: tag description: tag parameter in: path @@ -101214,9 +99975,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *699 examples: - default: *710 + default: *703 '404': *6 x-github: githubCloudOnly: false @@ -101238,9 +99999,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: + - *455 - *456 - - *457 - - &711 + - &704 name: release_id description: The unique identifier of the release. in: path @@ -101254,9 +100015,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *706 + schema: *699 examples: - default: *710 + default: *703 '401': description: Unauthorized x-github: @@ -101274,9 +100035,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: + - *455 - *456 - - *457 - - *711 + - *704 requestBody: required: false content: @@ -101340,9 +100101,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *699 examples: - default: *710 + default: *703 '404': description: Not Found if the discussion category name is invalid content: @@ -101363,9 +100124,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: + - *455 - *456 - - *457 - - *711 + - *704 responses: '204': description: Response @@ -101385,9 +100146,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: + - *455 - *456 - - *457 - - *711 + - *704 - *17 - *19 responses: @@ -101397,7 +100158,7 @@ paths: application/json: schema: type: array - items: *707 + items: *700 examples: default: value: @@ -101479,9 +100240,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: + - *455 - *456 - - *457 - - *711 + - *704 - name: name in: query required: true @@ -101507,7 +100268,7 @@ paths: description: Response for successful upload content: application/json: - schema: *707 + schema: *700 examples: response-for-successful-upload: value: @@ -101562,9 +100323,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: + - *455 - *456 - - *457 - - *711 + - *704 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -101588,9 +100349,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 '404': *6 @@ -101611,9 +100372,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: + - *455 - *456 - - *457 - - *711 + - *704 requestBody: required: true content: @@ -101643,16 +100404,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Reaction created content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '422': *15 x-github: githubCloudOnly: false @@ -101674,10 +100435,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: + - *455 - *456 - - *457 - - *711 - - *448 + - *704 + - *449 responses: '204': description: Response @@ -101701,9 +100462,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: + - *455 - *456 - - *457 - - *513 + - *506 - *17 - *19 responses: @@ -101720,7 +100481,7 @@ paths: oneOf: - allOf: - *165 - - &712 + - &705 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -101741,67 +100502,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *166 - - *712 + - *705 - allOf: - *167 - - *712 + - *705 - allOf: - *168 - - *712 + - *705 - allOf: - - *713 - - *712 + - *706 + - *705 - allOf: - *169 - - *712 + - *705 - allOf: - *170 - - *712 + - *705 - allOf: - *171 - - *712 + - *705 - allOf: - *172 - - *712 + - *705 - allOf: - *173 - - *712 + - *705 - allOf: - *174 - - *712 + - *705 - allOf: - *175 - - *712 + - *705 - allOf: - *176 - - *712 + - *705 - allOf: - *177 - - *712 + - *705 - allOf: - *178 - - *712 + - *705 - allOf: - *179 - - *712 + - *705 - allOf: - *180 - - *712 + - *705 - allOf: - *181 - - *712 + - *705 - allOf: - *182 - - *712 + - *705 - allOf: - *183 - - *712 + - *705 - allOf: - *184 - - *712 + - *705 - allOf: - - *714 - - *712 + - *707 + - *705 examples: default: value: @@ -101840,8 +100601,8 @@ paths: category: repos subcategory: rules parameters: + - *455 - *456 - - *457 - *17 - *19 - name: includes_parents @@ -101852,7 +100613,7 @@ paths: schema: type: boolean default: true - - *715 + - *708 responses: '200': description: Response @@ -101907,8 +100668,8 @@ paths: category: repos subcategory: rules parameters: + - *455 - *456 - - *457 requestBody: description: Request body required: true @@ -101937,7 +100698,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *716 + items: *709 required: - name - enforcement @@ -101970,7 +100731,7 @@ paths: application/json: schema: *185 examples: - default: &725 + default: &718 value: id: 42 name: super cool ruleset @@ -102017,12 +100778,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: + - *455 - *456 - - *457 - - *717 + - *710 - *101 - - *718 - - *719 + - *711 + - *712 - *17 - *19 responses: @@ -102030,9 +100791,9 @@ paths: description: Response content: application/json: - schema: *720 + schema: *713 examples: - default: *721 + default: *714 '404': *6 '500': *40 x-github: @@ -102053,17 +100814,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: + - *455 - *456 - - *457 - - *722 + - *715 responses: '200': description: Response content: application/json: - schema: *723 + schema: *716 examples: - default: *724 + default: *717 '404': *6 '500': *40 x-github: @@ -102091,8 +100852,8 @@ paths: category: repos subcategory: rules parameters: + - *455 - *456 - - *457 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102114,7 +100875,7 @@ paths: application/json: schema: *185 examples: - default: *725 + default: *718 '404': *6 '500': *40 put: @@ -102132,8 +100893,8 @@ paths: category: repos subcategory: rules parameters: + - *455 - *456 - - *457 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102167,7 +100928,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *716 + items: *709 examples: default: value: @@ -102197,7 +100958,7 @@ paths: application/json: schema: *185 examples: - default: *725 + default: *718 '404': *6 '500': *40 delete: @@ -102215,8 +100976,8 @@ paths: category: repos subcategory: rules parameters: + - *455 - *456 - - *457 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102239,8 +101000,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: + - *455 - *456 - - *457 - *17 - *19 - name: ruleset_id @@ -102277,8 +101038,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: + - *455 - *456 - - *457 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102351,21 +101112,22 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: + - *455 - *456 - - *457 - *416 - *417 - *418 - *419 + - *420 - *106 - *19 - *17 - - *726 - - *727 - - *420 + - *719 + - *720 - *421 - *422 - *423 + - *424 responses: '200': description: Response @@ -102373,7 +101135,7 @@ paths: application/json: schema: type: array - items: &731 + items: &724 type: object properties: number: *123 @@ -102392,8 +101154,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *728 - resolution: *729 + state: *721 + resolution: *722 resolved_at: type: string format: date-time @@ -102489,7 +101251,7 @@ paths: pull request. ' - oneOf: *730 + oneOf: *723 nullable: true has_more_locations: type: boolean @@ -102638,16 +101400,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: + - *455 - *456 - - *457 - - *542 - - *423 + - *535 + - *424 responses: '200': description: Response content: application/json: - schema: *731 + schema: *724 examples: default: value: @@ -102689,6 +101451,8 @@ paths: description: |- Updates the status of a secret scanning alert in an eligible repository. + You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. 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. @@ -102699,9 +101463,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: + - *455 - *456 - - *457 - - *542 + - *535 requestBody: required: true content: @@ -102709,27 +101473,42 @@ paths: schema: type: object properties: - state: *728 - resolution: *729 + state: *721 + resolution: *722 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: string nullable: true + assignee: + description: The username of the user to assign to the alert. Set + to `null` to unassign the alert. + type: string + nullable: true anyOf: - required: - state + - required: + - assignee examples: default: value: state: resolved resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: responses: '200': description: Response content: application/json: - schema: *731 + schema: *724 examples: default: value: @@ -102774,6 +101553,25 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false '400': description: Bad request, resolution comment is invalid or the resolution was not changed. @@ -102781,7 +101579,8 @@ paths: description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': - description: State does not match the resolution or resolution comment + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository '503': *190 x-github: enabledForGitHubApps: true @@ -102804,9 +101603,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: + - *455 - *456 - - *457 - - *542 + - *535 - *19 - *17 responses: @@ -102817,7 +101616,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &912 + items: &903 type: object properties: type: @@ -102843,19 +101642,19 @@ paths: example: commit details: oneOf: + - *725 + - *726 + - *727 + - *728 + - *729 + - *730 + - *731 - *732 - *733 - *734 - *735 - *736 - *737 - - *738 - - *739 - - *740 - - *741 - - *742 - - *743 - - *744 examples: default: value: @@ -102941,8 +101740,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -102950,14 +101749,14 @@ paths: schema: type: object properties: - reason: &746 + reason: &739 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *745 + placeholder_id: *738 required: - reason - placeholder_id @@ -102974,7 +101773,7 @@ paths: schema: type: object properties: - reason: *746 + reason: *739 expire_at: type: string format: date-time @@ -103020,8 +101819,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: + - *455 - *456 - - *457 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -103036,7 +101835,7 @@ paths: properties: incremental_scans: type: array - items: &747 + items: &740 description: Information on a single scan performed by secret scanning on the repository type: object @@ -103062,15 +101861,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *747 + items: *740 backfill_scans: type: array - items: *747 + items: *740 custom_pattern_backfill_scans: type: array items: allOf: - - *747 + - *740 - type: object properties: pattern_name: @@ -103140,8 +101939,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: + - *455 - *456 - - *457 - *106 - name: sort description: The property to sort the results by. @@ -103185,9 +101984,9 @@ paths: application/json: schema: type: array - items: *748 + items: *741 examples: - default: *749 + default: *742 '400': *14 '404': *6 x-github: @@ -103210,8 +102009,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -103284,7 +102083,7 @@ paths: login: type: string description: The username of the user credited. - type: *428 + type: *429 required: - login - type @@ -103371,9 +102170,9 @@ paths: description: Response content: application/json: - schema: *748 + schema: *741 examples: - default: &751 + default: &744 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -103606,8 +102405,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -103711,7 +102510,7 @@ paths: description: Response content: application/json: - schema: *748 + schema: *741 examples: default: value: @@ -103858,17 +102657,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: + - *455 - *456 - - *457 - - *750 + - *743 responses: '200': description: Response content: application/json: - schema: *748 + schema: *741 examples: - default: *751 + default: *744 '403': *29 '404': *6 x-github: @@ -103892,9 +102691,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: + - *455 - *456 - - *457 - - *750 + - *743 requestBody: required: true content: @@ -103967,7 +102766,7 @@ paths: login: type: string description: The username of the user credited. - type: *428 + type: *429 required: - login - type @@ -104053,10 +102852,10 @@ paths: description: Response content: application/json: - schema: *748 + schema: *741 examples: - default: *751 - add_credit: *751 + default: *744 + add_credit: *744 '403': *29 '404': *6 '422': @@ -104094,9 +102893,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: + - *455 - *456 - - *457 - - *750 + - *743 responses: '202': *39 '400': *14 @@ -104123,17 +102922,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: + - *455 - *456 - - *457 - - *750 + - *743 responses: '202': description: Response content: application/json: - schema: *467 + schema: *460 examples: - default: *469 + default: *462 '400': *14 '422': *15 '403': *29 @@ -104159,8 +102958,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -104259,8 +103058,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: + - *455 - *456 - - *457 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -104269,7 +103068,7 @@ paths: application/json: schema: type: array - items: &752 + items: &745 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -104302,8 +103101,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -104379,8 +103178,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -104476,8 +103275,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: + - *455 - *456 - - *457 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -104631,8 +103430,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: + - *455 - *456 - - *457 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -104642,7 +103441,7 @@ paths: application/json: schema: type: array - items: *752 + items: *745 examples: default: value: @@ -104675,8 +103474,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: + - *455 - *456 - - *457 - name: sha in: path required: true @@ -104730,7 +103529,7 @@ paths: description: Response content: application/json: - schema: *753 + schema: *746 examples: default: value: @@ -104784,8 +103583,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -104817,14 +103616,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: + - *455 - *456 - - *457 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &754 + schema: &747 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -104892,8 +103691,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: + - *455 - *456 - - *457 requestBody: required: false content: @@ -104919,7 +103718,7 @@ paths: description: Response content: application/json: - schema: *754 + schema: *747 examples: default: value: @@ -104946,8 +103745,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -104967,8 +103766,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -105047,8 +103846,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -105056,7 +103855,7 @@ paths: application/json: schema: type: array - items: &755 + items: &748 title: Tag protection description: Tag protection type: object @@ -105108,8 +103907,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -105132,7 +103931,7 @@ paths: description: Response content: application/json: - schema: *755 + schema: *748 examples: default: value: @@ -105163,8 +103962,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: + - *455 - *456 - - *457 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -105201,8 +104000,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: + - *455 - *456 - - *457 - name: ref in: path required: true @@ -105238,8 +104037,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: + - *455 - *456 - - *457 - *17 - *19 responses: @@ -105271,8 +104070,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: + - *455 - *456 - - *457 - *19 - *17 responses: @@ -105280,7 +104079,7 @@ paths: description: Response content: application/json: - schema: &756 + schema: &749 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -105292,7 +104091,7 @@ paths: required: - names examples: - default: &757 + default: &750 value: names: - octocat @@ -105315,8 +104114,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -105347,9 +104146,9 @@ paths: description: Response content: application/json: - schema: *756 + schema: *749 examples: - default: *757 + default: *750 '404': *6 '422': *7 x-github: @@ -105370,9 +104169,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: + - *455 - *456 - - *457 - - &758 + - &751 name: per description: The time frame to display results for. in: query @@ -105401,7 +104200,7 @@ paths: example: 128 clones: type: array - items: &759 + items: &752 title: Traffic type: object properties: @@ -105488,8 +104287,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -105579,8 +104378,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: + - *455 - *456 - - *457 responses: '200': description: Response @@ -105640,9 +104439,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: + - *455 - *456 - - *457 - - *758 + - *751 responses: '200': description: Response @@ -105661,7 +104460,7 @@ paths: example: 3782 views: type: array - items: *759 + items: *752 required: - uniques - count @@ -105738,8 +104537,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: + - *455 - *456 - - *457 requestBody: required: true content: @@ -106013,8 +104812,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: + - *455 - *456 - - *457 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -106037,8 +104836,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -106060,8 +104859,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -106087,8 +104886,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: + - *455 - *456 - - *457 - name: ref in: path required: true @@ -106180,9 +104979,9 @@ paths: description: Response content: application/json: - schema: *467 + schema: *460 examples: - default: *469 + default: *462 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -106333,7 +105132,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &767 + - &760 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -106342,7 +105141,7 @@ paths: schema: type: string example: members - - &772 + - &765 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -106353,7 +105152,7 @@ paths: default: 1 format: int32 example: 1 - - &773 + - &766 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -106395,7 +105194,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &762 + items: &755 allOf: - type: object required: @@ -106470,7 +105269,7 @@ paths: - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 - meta: &774 + meta: &767 type: object description: The metadata associated with the creation/updates to the user. @@ -106530,30 +105329,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &763 + '400': &756 description: Bad request content: application/json: - schema: *760 + schema: *753 application/scim+json: - schema: *760 - '401': *761 - '403': &764 + schema: *753 + '401': *754 + '403': &757 description: Permission denied - '429': &765 + '429': &758 description: Too many requests content: application/json: - schema: *760 + schema: *753 application/scim+json: - schema: *760 - '500': &766 + schema: *753 + '500': &759 description: Internal server error content: application/json: - schema: *760 + schema: *753 application/scim+json: - schema: *760 + schema: *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106577,7 +105376,7 @@ paths: required: true content: application/json: - schema: &770 + schema: &763 type: object required: - schemas @@ -106637,9 +105436,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *762 + schema: *755 examples: - group: &768 + group: &761 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -106658,13 +105457,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 - '400': *763 - '401': *761 - '403': *764 - '409': &771 + '400': *756 + '401': *754 + '403': *757 + '409': &764 description: Duplicate record detected - '429': *765 - '500': *766 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106681,7 +105480,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group parameters: - - &769 + - &762 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -106689,22 +105488,22 @@ paths: schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 - - *767 + - *760 - *41 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *762 + schema: *755 examples: - default: *768 - '400': *763 - '401': *761 - '403': *764 + default: *761 + '400': *756 + '401': *754 + '403': *757 '404': *6 - '429': *765 - '500': *766 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106723,13 +105522,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group parameters: - - *769 + - *762 - *41 requestBody: required: true content: application/json: - schema: *770 + schema: *763 examples: group: summary: Group @@ -106755,17 +105554,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *762 + schema: *755 examples: - group: *768 - groupWithMembers: *768 - '400': *763 - '401': *761 - '403': *764 + group: *761 + groupWithMembers: *761 + '400': *756 + '401': *754 + '403': *757 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *764 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106789,13 +105588,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group parameters: - - *769 + - *762 - *41 requestBody: required: true content: application/json: - schema: &781 + schema: &774 type: object required: - Operations @@ -106855,17 +105654,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *762 + schema: *755 examples: - updateGroup: *768 - addMembers: *768 - '400': *763 - '401': *761 - '403': *764 + updateGroup: *761 + addMembers: *761 + '400': *756 + '401': *754 + '403': *757 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *764 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106881,17 +105680,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise parameters: - - *769 + - *762 - *41 responses: '204': description: Group was deleted, no content - '400': *763 - '401': *761 - '403': *764 + '400': *756 + '401': *754 + '403': *757 '404': *6 - '429': *765 - '500': *766 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106925,8 +105724,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *772 - - *773 + - *765 + - *766 - *41 responses: '200': @@ -106959,7 +105758,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &776 + items: &769 allOf: - type: object required: @@ -107038,7 +105837,7 @@ paths: description: Whether this email address is the primary address. example: true - roles: &775 + roles: &768 type: array description: The roles assigned to the user. items: @@ -107094,7 +105893,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *774 + meta: *767 startIndex: type: integer description: A starting index for the returned page @@ -107131,11 +105930,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *763 - '401': *761 - '403': *764 - '429': *765 - '500': *766 + '400': *756 + '401': *754 + '403': *757 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107159,7 +105958,7 @@ paths: required: true content: application/json: - schema: &779 + schema: &772 type: object required: - schemas @@ -107241,9 +106040,9 @@ paths: type: boolean description: Whether this email address is the primary address. example: true - roles: *775 + roles: *768 examples: - user: &780 + user: &773 summary: User value: schemas: @@ -107290,9 +106089,9 @@ paths: description: User has been created content: application/scim+json: - schema: *776 + schema: *769 examples: - user: &777 + user: &770 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -107318,13 +106117,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 - enterpriseOwner: *777 - '400': *763 - '401': *761 - '403': *764 - '409': *771 - '429': *765 - '500': *766 + enterpriseOwner: *770 + '400': *756 + '401': *754 + '403': *757 + '409': *764 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107341,7 +106140,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user parameters: - - &778 + - &771 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -107354,15 +106153,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *776 + schema: *769 examples: - default: *777 - '400': *763 - '401': *761 - '403': *764 + default: *770 + '400': *756 + '401': *754 + '403': *757 '404': *6 - '429': *765 - '500': *766 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107384,30 +106183,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user parameters: - - *778 + - *771 - *41 requestBody: required: true content: application/json: - schema: *779 + schema: *772 examples: - user: *780 + user: *773 responses: '200': description: User was updated content: application/scim+json: - schema: *776 + schema: *769 examples: - user: *777 - '400': *763 - '401': *761 - '403': *764 + user: *770 + '400': *756 + '401': *754 + '403': *757 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *764 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107442,13 +106241,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user parameters: - - *778 + - *771 - *41 requestBody: required: true content: application/json: - schema: *781 + schema: *774 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -107488,18 +106287,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *776 + schema: *769 examples: - userMultiValuedProperties: *777 - userSingleValuedProperties: *777 - disableUser: *777 - '400': *763 - '401': *761 - '403': *764 + userMultiValuedProperties: *770 + userSingleValuedProperties: *770 + disableUser: *770 + '400': *756 + '401': *754 + '403': *757 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *764 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107519,17 +106318,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise parameters: - - *778 + - *771 - *41 responses: '204': description: User was deleted, no content - '400': *763 - '401': *761 - '403': *764 + '400': *756 + '401': *754 + '403': *757 '404': *6 - '429': *765 - '500': *766 + '429': *758 + '500': *759 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107616,7 +106415,7 @@ paths: example: 1 Resources: type: array - items: &782 + items: &775 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -107847,22 +106646,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *37 - '404': &783 + '404': &776 description: Resource not found content: application/json: - schema: *760 + schema: *753 application/scim+json: - schema: *760 - '403': &784 + schema: *753 + '403': &777 description: Forbidden content: application/json: - schema: *760 + schema: *753 application/scim+json: - schema: *760 - '400': *763 - '429': *765 + schema: *753 + '400': *756 + '429': *758 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -107888,9 +106687,9 @@ paths: description: Response content: application/scim+json: - schema: *782 + schema: *775 examples: - default: &785 + default: &778 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -107913,17 +106712,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *37 - '404': *783 - '403': *784 - '500': *766 + '404': *776 + '403': *777 + '500': *759 '409': description: Conflict content: application/json: - schema: *760 + schema: *753 application/scim+json: - schema: *760 - '400': *763 + schema: *753 + '400': *756 requestBody: required: true content: @@ -108021,17 +106820,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - *83 - - *778 + - *771 responses: '200': description: Response content: application/scim+json: - schema: *782 + schema: *775 examples: - default: *785 - '404': *783 - '403': *784 + default: *778 + '404': *776 + '403': *777 '304': *37 x-github: githubCloudOnly: true @@ -108055,18 +106854,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - *83 - - *778 + - *771 responses: '200': description: Response content: application/scim+json: - schema: *782 + schema: *775 examples: - default: *785 + default: *778 '304': *37 - '404': *783 - '403': *784 + '404': *776 + '403': *777 requestBody: required: true content: @@ -108179,19 +106978,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - *83 - - *778 + - *771 responses: '200': description: Response content: application/scim+json: - schema: *782 + schema: *775 examples: - default: *785 + default: *778 '304': *37 - '404': *783 - '403': *784 - '400': *763 + '404': *776 + '403': *777 + '400': *756 '429': description: Response content: @@ -108282,12 +107081,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - *83 - - *778 + - *771 responses: '204': description: Response - '404': *783 - '403': *784 + '404': *776 + '403': *777 '304': *37 x-github: githubCloudOnly: true @@ -108420,7 +107219,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &786 + text_matches: &779 title: Search Result Text Matches type: array items: @@ -108583,7 +107382,7 @@ paths: enum: - author-date - committer-date - - &787 + - &780 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -108654,7 +107453,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *511 + properties: *504 nullable: true comment_count: type: integer @@ -108674,7 +107473,7 @@ paths: url: type: string format: uri - verification: *633 + verification: *626 required: - author - committer @@ -108693,7 +107492,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *511 + properties: *504 nullable: true parents: type: array @@ -108711,7 +107510,7 @@ paths: type: number node_id: type: string - text_matches: *786 + text_matches: *779 required: - sha - node_id @@ -108904,7 +107703,7 @@ paths: - interactions - created - updated - - *787 + - *780 - *17 - *19 - name: advanced_search @@ -109001,11 +107800,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: type: string state_reason: @@ -109037,7 +107836,7 @@ paths: type: string format: date-time nullable: true - text_matches: *786 + text_matches: *779 pull_request: type: object properties: @@ -109262,7 +108061,7 @@ paths: enum: - created - updated - - *787 + - *780 - *17 - *19 responses: @@ -109306,7 +108105,7 @@ paths: nullable: true score: type: number - text_matches: *786 + text_matches: *779 required: - id - node_id @@ -109392,7 +108191,7 @@ paths: - forks - help-wanted-issues - updated - - *787 + - *780 - *17 - *19 responses: @@ -109631,7 +108430,7 @@ paths: - admin - pull - push - text_matches: *786 + text_matches: *779 temp_clone_token: type: string allow_merge_commit: @@ -109932,7 +108731,7 @@ paths: type: string format: uri nullable: true - text_matches: *786 + text_matches: *779 related: type: array nullable: true @@ -110125,7 +108924,7 @@ paths: - followers - repositories - joined - - *787 + - *780 - *17 - *19 responses: @@ -110229,7 +109028,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *786 + text_matches: *779 blog: type: string nullable: true @@ -110308,7 +109107,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &791 + - &784 name: team_id description: The unique identifier of the team. in: path @@ -110320,9 +109119,9 @@ paths: description: Response content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '404': *6 x-github: githubCloudOnly: false @@ -110349,7 +109148,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *791 + - *784 requestBody: required: true content: @@ -110412,16 +109211,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '201': description: Response content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '404': *6 '422': *15 '403': *29 @@ -110449,7 +109248,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *791 + - *784 responses: '204': description: Response @@ -110480,7 +109279,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *791 + - *784 - *106 - *17 - *19 @@ -110491,9 +109290,9 @@ paths: application/json: schema: type: array - items: *439 + items: *440 examples: - default: *792 + default: *785 headers: Link: *43 x-github: @@ -110522,7 +109321,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *791 + - *784 requestBody: required: true content: @@ -110556,9 +109355,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: *440 + default: *441 x-github: triggersNotification: true githubCloudOnly: false @@ -110585,16 +109384,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *791 - - *441 + - *784 + - *442 responses: '200': description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: *440 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110619,8 +109418,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *791 - - *441 + - *784 + - *442 requestBody: required: false content: @@ -110643,9 +109442,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: *793 + default: *786 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110670,8 +109469,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *791 - - *441 + - *784 + - *442 responses: '204': description: Response @@ -110700,8 +109499,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *791 - - *441 + - *784 + - *442 - *106 - *17 - *19 @@ -110712,9 +109511,9 @@ paths: application/json: schema: type: array - items: *442 + items: *443 examples: - default: *794 + default: *787 headers: Link: *43 x-github: @@ -110743,8 +109542,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *791 - - *441 + - *784 + - *442 requestBody: required: true content: @@ -110766,9 +109565,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: *443 + default: *444 x-github: triggersNotification: true githubCloudOnly: false @@ -110795,17 +109594,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *784 + - *442 + - *445 responses: '200': description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: *443 + default: *444 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110830,9 +109629,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *784 + - *442 + - *445 requestBody: required: true content: @@ -110854,9 +109653,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: *795 + default: *788 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110881,9 +109680,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *784 + - *442 + - *445 responses: '204': description: Response @@ -110912,9 +109711,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *784 + - *442 + - *445 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -110940,9 +109739,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 x-github: @@ -110971,9 +109770,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *784 + - *442 + - *445 requestBody: required: true content: @@ -111005,9 +109804,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111033,8 +109832,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *791 - - *441 + - *784 + - *442 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -111060,9 +109859,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 x-github: @@ -111091,8 +109890,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *791 - - *441 + - *784 + - *442 requestBody: required: true content: @@ -111124,9 +109923,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -111150,7 +109949,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *791 + - *784 - *17 - *19 responses: @@ -111188,7 +109987,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *791 + - *784 - name: role description: Filters members returned by their role in the team. in: query @@ -111239,7 +110038,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *791 + - *784 - *138 responses: '204': @@ -111276,7 +110075,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *791 + - *784 - *138 responses: '204': @@ -111316,7 +110115,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *791 + - *784 - *138 responses: '204': @@ -111353,16 +110152,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *791 + - *784 - *138 responses: '200': description: Response content: application/json: - schema: *453 + schema: *454 examples: - response-if-user-is-a-team-maintainer: *796 + response-if-user-is-a-team-maintainer: *789 '404': *6 x-github: githubCloudOnly: false @@ -111395,7 +110194,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *791 + - *784 - *138 requestBody: required: false @@ -111421,9 +110220,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *454 examples: - response-if-users-membership-with-team-is-now-pending: *797 + response-if-users-membership-with-team-is-now-pending: *790 '403': description: Forbidden if team synchronization is set up '422': @@ -111457,7 +110256,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *791 + - *784 - *138 responses: '204': @@ -111472,174 +110271,6 @@ paths: category: teams subcategory: members deprecated: true - "/teams/{team_id}/projects": - get: - summary: List team projects (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/list-projects-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy - parameters: - - *791 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *454 - examples: - default: *798 - headers: - Link: *43 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - "/teams/{team_id}/projects/{project_id}": - get: - summary: Check team permissions for a project (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/check-permissions-for-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project-legacy - parameters: - - *791 - - *455 - responses: - '200': - description: Response - content: - application/json: - schema: *454 - examples: - default: *799 - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - put: - summary: Add or update team project permissions (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/add-or-update-project-permissions-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions-legacy - parameters: - - *791 - - *455 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - examples: - default: - summary: Example of setting permission to read - value: - permission: read - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - delete: - summary: Remove a project from a team (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/remove-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team-legacy - parameters: - - *791 - - *455 - responses: - '204': - description: Response - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true "/teams/{team_id}/repos": get: summary: List team repositories (Legacy) @@ -111653,7 +110284,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *791 + - *784 - *17 - *19 responses: @@ -111695,15 +110326,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *791 + - *784 + - *455 - *456 - - *457 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *800 + schema: *791 examples: alternative-response-with-extra-repository-information: value: @@ -111854,9 +110485,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *791 + - *784 + - *455 - *456 - - *457 requestBody: required: false content: @@ -111906,9 +110537,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *791 + - *784 + - *455 - *456 - - *457 responses: '204': description: Response @@ -111937,15 +110568,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy parameters: - - *791 + - *784 responses: '200': description: Response content: application/json: - schema: *458 + schema: *457 examples: - default: *459 + default: *458 '403': *29 '404': *6 x-github: @@ -111972,7 +110603,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy parameters: - - *791 + - *784 requestBody: required: true content: @@ -112029,7 +110660,7 @@ paths: description: Response content: application/json: - schema: *458 + schema: *457 examples: default: value: @@ -112060,7 +110691,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *791 + - *784 - *17 - *19 responses: @@ -112072,7 +110703,7 @@ paths: type: array items: *303 examples: - response-if-child-teams-exist: *801 + response-if-child-teams-exist: *792 headers: Link: *43 '404': *6 @@ -112105,7 +110736,7 @@ paths: application/json: schema: oneOf: - - &803 + - &794 title: Private User description: Private User type: object @@ -112308,7 +110939,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *802 + - *793 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -112461,7 +111092,7 @@ paths: description: Response content: application/json: - schema: *803 + schema: *794 examples: default: value: @@ -112807,7 +111438,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *555 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -112815,7 +111446,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *555 '401': *25 '403': *29 '404': *6 @@ -112859,7 +111490,7 @@ paths: type: integer secrets: type: array - items: &804 + items: &795 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -112899,7 +111530,7 @@ paths: - visibility - selected_repositories_url examples: - default: *565 + default: *558 headers: Link: *43 x-github: @@ -112975,7 +111606,7 @@ paths: description: Response content: application/json: - schema: *804 + schema: *795 examples: default: value: @@ -113121,7 +111752,7 @@ paths: type: array items: *274 examples: - default: *805 + default: *796 '401': *25 '403': *29 '404': *6 @@ -113273,7 +111904,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *555 '304': *37 '500': *40 '401': *25 @@ -113331,7 +111962,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *555 '401': *25 '403': *29 '404': *6 @@ -113388,7 +112019,7 @@ paths: description: Response content: application/json: - schema: &806 + schema: &797 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -113429,7 +112060,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &807 + default: &798 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -113474,9 +112105,9 @@ paths: description: Response content: application/json: - schema: *806 + schema: *797 examples: - default: *807 + default: *798 '404': *6 x-github: githubCloudOnly: false @@ -113513,9 +112144,9 @@ paths: type: integer machines: type: array - items: *808 + items: *799 examples: - default: *809 + default: *800 '304': *37 '500': *40 '401': *25 @@ -113594,13 +112225,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *467 + repository: *460 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *563 - required: *564 + properties: *556 + required: *557 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -114382,7 +113013,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *555 '304': *37 '500': *40 '400': *14 @@ -114422,7 +113053,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *555 '500': *40 '401': *25 '403': *29 @@ -114454,7 +113085,7 @@ paths: type: array items: *376 examples: - default: &820 + default: &811 value: - id: 197 name: hello_docker @@ -114555,7 +113186,7 @@ paths: application/json: schema: type: array - items: &810 + items: &801 title: Email description: Email type: object @@ -114620,9 +113251,9 @@ paths: application/json: schema: type: array - items: *810 + items: *801 examples: - default: &822 + default: &813 value: - email: octocat@github.com verified: true @@ -114697,7 +113328,7 @@ paths: application/json: schema: type: array - items: *810 + items: *801 examples: default: value: @@ -114953,7 +113584,7 @@ paths: application/json: schema: type: array - items: &811 + items: &802 title: GPG Key description: A unique encryption key type: object @@ -115084,7 +113715,7 @@ paths: - subkeys - revoked examples: - default: &836 + default: &827 value: - id: 3 name: Octocat's GPG Key @@ -115169,9 +113800,9 @@ paths: description: Response content: application/json: - schema: *811 + schema: *802 examples: - default: &812 + default: &803 value: id: 3 name: Octocat's GPG Key @@ -115228,7 +113859,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &813 + - &804 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -115240,9 +113871,9 @@ paths: description: Response content: application/json: - schema: *811 + schema: *802 examples: - default: *812 + default: *803 '404': *6 '304': *37 '403': *29 @@ -115265,7 +113896,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *813 + - *804 responses: '204': description: Response @@ -115570,7 +114201,7 @@ paths: required: true content: application/json: - schema: *644 + schema: *637 examples: default: value: @@ -115720,7 +114351,7 @@ paths: application/json: schema: type: array - items: &814 + items: &805 title: Key description: Key type: object @@ -115821,9 +114452,9 @@ paths: description: Response content: application/json: - schema: *814 + schema: *805 examples: - default: &815 + default: &806 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -115856,15 +114487,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *674 + - *667 responses: '200': description: Response content: application/json: - schema: *814 + schema: *805 examples: - default: *815 + default: *806 '404': *6 '304': *37 '403': *29 @@ -115887,7 +114518,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *674 + - *667 responses: '204': description: Response @@ -115920,7 +114551,7 @@ paths: application/json: schema: type: array - items: &816 + items: &807 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -115988,7 +114619,7 @@ paths: - account - plan examples: - default: &817 + default: &808 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -116050,9 +114681,9 @@ paths: application/json: schema: type: array - items: *816 + items: *807 examples: - default: *817 + default: *808 headers: Link: *43 '304': *37 @@ -117047,7 +115678,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - *371 - - *818 + - *809 responses: '204': description: Response @@ -117162,7 +115793,7 @@ paths: - docker - nuget - container - - *819 + - *810 - *19 - *17 responses: @@ -117174,8 +115805,8 @@ paths: type: array items: *376 examples: - default: *820 - '400': *821 + default: *811 + '400': *812 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -117204,7 +115835,7 @@ paths: application/json: schema: *376 examples: - default: &837 + default: &828 value: id: 40201 name: octo-name @@ -117566,9 +116197,9 @@ paths: application/json: schema: type: array - items: *810 + items: *801 examples: - default: *822 + default: *813 headers: Link: *43 '304': *37 @@ -117681,7 +116312,7 @@ paths: type: array items: *74 examples: - default: &829 + default: &820 summary: Default response value: - id: 1296269 @@ -117985,9 +116616,9 @@ paths: description: Response content: application/json: - schema: *467 + schema: *460 examples: - default: *469 + default: *462 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -118025,9 +116656,9 @@ paths: application/json: schema: type: array - items: *646 + items: *639 examples: - default: *823 + default: *814 headers: Link: *43 '304': *37 @@ -118106,7 +116737,7 @@ paths: application/json: schema: type: array - items: &824 + items: &815 title: Social account description: Social media account type: object @@ -118121,7 +116752,7 @@ paths: - provider - url examples: - default: &825 + default: &816 value: - provider: twitter url: https://twitter.com/github @@ -118183,9 +116814,9 @@ paths: application/json: schema: type: array - items: *824 + items: *815 examples: - default: *825 + default: *816 '422': *15 '304': *37 '404': *6 @@ -118272,7 +116903,7 @@ paths: application/json: schema: type: array - items: &826 + items: &817 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -118292,7 +116923,7 @@ paths: - title - created_at examples: - default: &841 + default: &832 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -118356,9 +116987,9 @@ paths: description: Response content: application/json: - schema: *826 + schema: *817 examples: - default: &827 + default: &818 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -118388,7 +117019,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &828 + - &819 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -118400,9 +117031,9 @@ paths: description: Response content: application/json: - schema: *826 + schema: *817 examples: - default: *827 + default: *818 '404': *6 '304': *37 '403': *29 @@ -118425,7 +117056,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *828 + - *819 responses: '204': description: Response @@ -118454,7 +117085,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &842 + - &833 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -118479,11 +117110,11 @@ paths: type: array items: *74 examples: - default-response: *829 + default-response: *820 application/vnd.github.v3.star+json: schema: type: array - items: &843 + items: &834 title: Starred Repository description: Starred Repository type: object @@ -118639,8 +117270,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: + - *455 - *456 - - *457 responses: '204': description: Response if this repository is starred by you @@ -118668,8 +117299,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -118693,8 +117324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: + - *455 - *456 - - *457 responses: '204': description: Response @@ -118766,7 +117397,7 @@ paths: application/json: schema: type: array - items: *437 + items: *438 examples: default: value: @@ -118852,10 +117483,10 @@ paths: application/json: schema: oneOf: - - *803 - - *802 + - *794 + - *793 examples: - default-response: &831 + default-response: &822 summary: Default response value: login: octocat @@ -118890,7 +117521,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &832 + response-with-git-hub-plan-information: &823 summary: Response with GitHub plan information value: login: octocat @@ -119012,7 +117643,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *830 + - *821 - *17 responses: '200': @@ -119061,11 +117692,11 @@ paths: application/json: schema: oneOf: - - *803 - - *802 + - *794 + - *793 examples: - default-response: *831 - response-with-git-hub-plan-information: *832 + default-response: *822 + response-with-git-hub-plan-information: *823 '404': *6 x-github: githubCloudOnly: false @@ -119115,8 +117746,8 @@ paths: required: - subject_digests examples: - default: *833 - withPredicateType: *834 + default: *824 + withPredicateType: *825 responses: '200': description: Response @@ -119169,7 +117800,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *835 + default: *826 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -119374,7 +118005,7 @@ paths: initiator: type: string examples: - default: *507 + default: *500 '201': description: Response content: @@ -119415,7 +118046,7 @@ paths: type: array items: *376 examples: - default: *820 + default: *811 '403': *29 '401': *25 x-github: @@ -119799,9 +118430,9 @@ paths: application/json: schema: type: array - items: *811 + items: *802 examples: - default: *836 + default: *827 headers: Link: *43 x-github: @@ -119905,7 +118536,7 @@ paths: application/json: schema: *22 examples: - default: *643 + default: *636 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120029,7 +118660,7 @@ paths: - docker - nuget - container - - *819 + - *810 - *138 - *19 - *17 @@ -120042,10 +118673,10 @@ paths: type: array items: *376 examples: - default: *820 + default: *811 '403': *29 '401': *25 - '400': *821 + '400': *812 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120075,7 +118706,7 @@ paths: application/json: schema: *376 examples: - default: *837 + default: *828 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120424,7 +119055,7 @@ paths: type: array items: *398 examples: - default: *838 + default: *829 headers: Link: *43 '304': *37 @@ -120435,6 +119066,257 @@ paths: enabledForGitHubApps: true category: projects subcategory: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-field-to-user-owned-project + parameters: + - *138 + - *394 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + - single_select + - iteration + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + iteration_configuration: + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: The duration of the iteration in days. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + properties: + title: + type: string + description: The title for the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + required: + - name + - data_type + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + iteration_field: + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + responses: + '201': + description: Response + content: + application/json: + schema: *398 + examples: + text_field: + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + number_field: + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + date_field: + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + single_select_field: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + iteration_field: + value: + id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' + '304': *37 + '403': *29 + '401': *25 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields "/users/{username}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for user @@ -120447,7 +119329,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user parameters: - *394 - - *839 + - *830 - *138 responses: '200': @@ -120456,7 +119338,7 @@ paths: application/json: schema: *398 examples: - default: *840 + default: *831 headers: Link: *43 '304': *37 @@ -120991,9 +119873,9 @@ paths: application/json: schema: type: array - items: *824 + items: *815 examples: - default: *825 + default: *816 headers: Link: *43 x-github: @@ -121023,9 +119905,9 @@ paths: application/json: schema: type: array - items: *826 + items: *817 examples: - default: *841 + default: *832 headers: Link: *43 x-github: @@ -121050,7 +119932,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - *138 - - *842 + - *833 - *106 - *17 - *19 @@ -121062,11 +119944,11 @@ paths: schema: anyOf: - type: array - items: *843 + items: *834 - type: array items: *74 examples: - default-response: *829 + default-response: *820 headers: Link: *43 x-github: @@ -121225,7 +120107,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &844 + enterprise: &835 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -121283,7 +120165,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &845 + installation: &836 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -121302,7 +120184,7 @@ x-webhooks: required: - id - node_id - organization: &846 + organization: &837 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -121362,13 +120244,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &847 + repository: &838 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &884 + properties: &875 id: description: Unique identifier of the repository example: 42 @@ -122051,7 +120933,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &885 + required: &876 - archive_url - assignees_url - blobs_url @@ -122202,10 +121084,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -122281,11 +121163,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - rule: &848 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + rule: &839 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -122508,11 +121390,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - rule: *848 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + rule: *839 sender: *4 required: - action @@ -122695,11 +121577,11 @@ x-webhooks: - everyone required: - from - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - rule: *848 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + rule: *839 sender: *4 required: - action @@ -122772,7 +121654,7 @@ x-webhooks: required: true content: application/json: - schema: &868 + schema: &859 title: Exemption request cancellation event type: object properties: @@ -122780,11 +121662,11 @@ x-webhooks: type: string enum: - cancelled - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: &849 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + exemption_request: &840 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -123017,7 +121899,7 @@ x-webhooks: type: array description: The responses to the exemption request. nullable: true - items: &850 + items: &841 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -123127,7 +122009,7 @@ x-webhooks: required: true content: application/json: - schema: &869 + schema: &860 title: Exemption request completed event type: object properties: @@ -123135,11 +122017,11 @@ x-webhooks: type: string enum: - completed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + exemption_request: *840 sender: *4 required: - action @@ -123211,7 +122093,7 @@ x-webhooks: required: true content: application/json: - schema: &866 + schema: &857 title: Exemption request created event type: object properties: @@ -123219,11 +122101,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + exemption_request: *840 sender: *4 required: - action @@ -123295,7 +122177,7 @@ x-webhooks: required: true content: application/json: - schema: &870 + schema: &861 title: Exemption response dismissed event type: object properties: @@ -123303,12 +122185,12 @@ x-webhooks: type: string enum: - response_dismissed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 - exemption_response: *850 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + exemption_request: *840 + exemption_response: *841 sender: *4 required: - action @@ -123382,7 +122264,7 @@ x-webhooks: required: true content: application/json: - schema: &867 + schema: &858 title: Exemption response submitted event type: object properties: @@ -123390,12 +122272,12 @@ x-webhooks: type: string enum: - response_submitted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 - exemption_response: *850 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + exemption_request: *840 + exemption_response: *841 sender: *4 required: - action @@ -123479,7 +122361,7 @@ x-webhooks: type: string enum: - completed - check_run: &852 + check_run: &843 title: CheckRun description: A check performed on the code of a given code change type: object @@ -123532,7 +122414,7 @@ x-webhooks: type: string pull_requests: type: array - items: *524 + items: *517 repository: *274 status: example: completed @@ -123570,7 +122452,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *851 + deployment: *842 details_url: example: https://example.com type: string @@ -123620,7 +122502,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *524 + items: *517 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -123655,10 +122537,10 @@ x-webhooks: - output - app - pull_requests - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + installation: *836 + enterprise: *835 + organization: *837 + repository: *838 sender: *4 required: - check_run @@ -124051,11 +122933,11 @@ x-webhooks: type: string enum: - created - check_run: *852 - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + check_run: *843 + installation: *836 + enterprise: *835 + organization: *837 + repository: *838 sender: *4 required: - check_run @@ -124451,11 +123333,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *852 - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + check_run: *843 + installation: *836 + enterprise: *835 + organization: *837 + repository: *838 requested_action: description: The action requested by the user. type: object @@ -124860,11 +123742,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *852 - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + check_run: *843 + installation: *836 + enterprise: *835 + organization: *837 + repository: *838 sender: *4 required: - check_run @@ -125841,10 +124723,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -126117,6 +124999,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -126529,10 +125416,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -126800,6 +125687,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -127211,10 +126103,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -127380,7 +126272,7 @@ x-webhooks: required: - login - id - dismissed_comment: *537 + dismissed_comment: *530 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -127525,20 +126417,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &853 + commit_oid: &844 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *844 - installation: *845 - organization: *846 - ref: &854 + enterprise: *835 + installation: *836 + organization: *837 + ref: &845 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *847 + repository: *838 sender: *4 required: - action @@ -127703,7 +126595,7 @@ x-webhooks: required: - login - id - dismissed_comment: *537 + dismissed_comment: *530 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -127933,12 +126825,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *844 + enterprise: *835 + installation: *836 + organization: *837 + ref: *845 + repository: *838 sender: *4 required: - action @@ -128033,7 +126925,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *537 + dismissed_comment: *530 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -128204,12 +127096,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *844 + enterprise: *835 + installation: *836 + organization: *837 + ref: *845 + repository: *838 sender: *4 required: - action @@ -128375,7 +127267,7 @@ x-webhooks: required: - login - id - dismissed_comment: *537 + dismissed_comment: *530 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -128541,12 +127433,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *844 + enterprise: *835 + installation: *836 + organization: *837 + ref: *845 + repository: *838 sender: *4 required: - action @@ -128646,7 +127538,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *537 + dismissed_comment: *530 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -128814,16 +127706,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *847 + repository: *838 sender: *4 required: - action @@ -128920,7 +127812,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *537 + dismissed_comment: *530 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -129060,12 +127952,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *844 + enterprise: *835 + installation: *836 + organization: *837 + ref: *845 + repository: *838 sender: *4 required: - action @@ -129322,10 +128214,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -129405,18 +128297,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *846 - pusher_type: &855 + organization: *837 + pusher_type: &846 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &856 + ref: &847 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -129426,7 +128318,7 @@ x-webhooks: enum: - tag - branch - repository: *847 + repository: *838 sender: *4 required: - ref @@ -129509,9 +128401,9 @@ x-webhooks: enum: - created definition: *152 - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 sender: *4 required: - action @@ -129596,9 +128488,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 sender: *4 required: - action @@ -129676,9 +128568,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *152 - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 sender: *4 required: - action @@ -129756,9 +128648,9 @@ x-webhooks: enum: - updated definition: *152 - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 sender: *4 required: - action @@ -129835,10 +128727,10 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - repository: *847 - organization: *846 + enterprise: *835 + installation: *836 + repository: *838 + organization: *837 sender: *4 new_property_values: type: array @@ -129923,18 +128815,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - pusher_type: *855 - ref: *856 + enterprise: *835 + installation: *836 + organization: *837 + pusher_type: *846 + ref: *847 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *847 + repository: *838 sender: *4 required: - ref @@ -130018,11 +128910,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *586 + installation: *836 + organization: *837 + enterprise: *835 + repository: *838 sender: *4 required: - action @@ -130106,11 +128998,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *586 + installation: *836 + organization: *837 + enterprise: *835 + repository: *838 sender: *4 required: - action @@ -130194,11 +129086,11 @@ x-webhooks: type: string enum: - created - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *586 + installation: *836 + organization: *837 + enterprise: *835 + repository: *838 sender: *4 required: - action @@ -130280,11 +129172,11 @@ x-webhooks: type: string enum: - dismissed - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *586 + installation: *836 + organization: *837 + enterprise: *835 + repository: *838 sender: *4 required: - action @@ -130366,11 +129258,11 @@ x-webhooks: type: string enum: - fixed - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *586 + installation: *836 + organization: *837 + enterprise: *835 + repository: *838 sender: *4 required: - action @@ -130453,11 +129345,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *586 + installation: *836 + organization: *837 + enterprise: *835 + repository: *838 sender: *4 required: - action @@ -130539,11 +129431,11 @@ x-webhooks: type: string enum: - reopened - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *586 + installation: *836 + organization: *837 + enterprise: *835 + repository: *838 sender: *4 required: - action @@ -130620,9 +129512,9 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - key: &857 + enterprise: *835 + installation: *836 + key: &848 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -130658,8 +129550,8 @@ x-webhooks: - verified - created_at - read_only - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -130736,11 +129628,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - key: *857 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + key: *848 + organization: *837 + repository: *838 sender: *4 required: - action @@ -131301,12 +130193,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - workflow: &861 + workflow: &852 title: Workflow type: object nullable: true @@ -132032,13 +130924,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *599 + deployment: *592 pull_requests: type: array - items: *695 - repository: *847 - organization: *846 - installation: *845 + items: *688 + repository: *838 + organization: *837 + installation: *836 sender: *4 responses: '200': @@ -132109,7 +131001,7 @@ x-webhooks: type: string enum: - approved - approver: &858 + approver: &849 type: object properties: avatar_url: @@ -132152,11 +131044,11 @@ x-webhooks: type: string comment: type: string - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - reviewers: &859 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + reviewers: &850 type: array items: type: object @@ -132235,7 +131127,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &860 + workflow_job_run: &851 type: object properties: conclusion: @@ -132966,18 +131858,18 @@ x-webhooks: type: string enum: - rejected - approver: *858 + approver: *849 comment: type: string - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - reviewers: *859 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + reviewers: *850 sender: *4 since: type: string - workflow_job_run: *860 + workflow_job_run: *851 workflow_job_runs: type: array items: @@ -133681,13 +132573,13 @@ x-webhooks: type: string enum: - requested - enterprise: *844 + enterprise: *835 environment: type: string - installation: *845 - organization: *846 - repository: *847 - requestor: &871 + installation: *836 + organization: *837 + repository: *838 + requestor: &862 title: User type: object nullable: true @@ -135586,12 +134478,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - workflow: *861 + workflow: *852 workflow_run: title: Deployment Workflow Run type: object @@ -136271,7 +135163,7 @@ x-webhooks: type: string enum: - answered - answer: &864 + answer: &855 type: object properties: author_association: @@ -136428,7 +135320,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &862 + discussion: &853 title: Discussion description: A Discussion in a repository. type: object @@ -136714,7 +135606,7 @@ x-webhooks: - id labels: type: array - items: *657 + items: *650 required: - repository_url - category @@ -136736,10 +135628,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -136866,11 +135758,11 @@ x-webhooks: - from required: - category - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -136953,11 +135845,11 @@ x-webhooks: type: string enum: - closed - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -137039,7 +135931,7 @@ x-webhooks: type: string enum: - created - comment: &863 + comment: &854 type: object properties: author_association: @@ -137196,11 +136088,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -137283,12 +136175,12 @@ x-webhooks: type: string enum: - deleted - comment: *863 - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + comment: *854 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -137383,12 +136275,12 @@ x-webhooks: - from required: - body - comment: *863 - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + comment: *854 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -137472,11 +136364,11 @@ x-webhooks: type: string enum: - created - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -137558,11 +136450,11 @@ x-webhooks: type: string enum: - deleted - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -137662,11 +136554,11 @@ x-webhooks: type: string required: - from - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -137748,10 +136640,10 @@ x-webhooks: type: string enum: - labeled - discussion: *862 - enterprise: *844 - installation: *845 - label: &865 + discussion: *853 + enterprise: *835 + installation: *836 + label: &856 title: Label type: object properties: @@ -137783,8 +136675,8 @@ x-webhooks: - color - default - description - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -137867,11 +136759,11 @@ x-webhooks: type: string enum: - locked - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -137953,11 +136845,11 @@ x-webhooks: type: string enum: - pinned - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -138039,11 +136931,11 @@ x-webhooks: type: string enum: - reopened - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -138128,16 +137020,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *862 - new_repository: *847 + new_discussion: *853 + new_repository: *838 required: - new_discussion - new_repository - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -138220,10 +137112,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *862 - old_answer: *864 - organization: *846 - repository: *847 + discussion: *853 + old_answer: *855 + organization: *837 + repository: *838 sender: *4 required: - action @@ -138305,12 +137197,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *862 - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + label: *856 + organization: *837 + repository: *838 sender: *4 required: - action @@ -138393,11 +137285,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -138479,11 +137371,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *853 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -138552,7 +137444,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *857 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138615,7 +137507,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *858 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138681,7 +137573,7 @@ x-webhooks: required: true content: application/json: - schema: *868 + schema: *859 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138747,7 +137639,7 @@ x-webhooks: required: true content: application/json: - schema: *869 + schema: *860 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138813,7 +137705,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *857 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138879,7 +137771,7 @@ x-webhooks: required: true content: application/json: - schema: *870 + schema: *861 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138945,7 +137837,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *858 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139010,7 +137902,7 @@ x-webhooks: required: true content: application/json: - schema: *868 + schema: *859 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139075,7 +137967,7 @@ x-webhooks: required: true content: application/json: - schema: *869 + schema: *860 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139140,7 +138032,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *857 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139205,7 +138097,7 @@ x-webhooks: required: true content: application/json: - schema: *870 + schema: *861 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139271,7 +138163,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *858 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139338,7 +138230,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *844 + enterprise: *835 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -139998,9 +138890,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *845 - organization: *846 - repository: *847 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - forkee @@ -140146,9 +139038,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 pages: description: The pages that were updated. type: array @@ -140185,7 +139077,7 @@ x-webhooks: - action - sha - html_url - repository: *847 + repository: *838 sender: *4 required: - pages @@ -140261,10 +139153,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 + enterprise: *835 installation: *22 - organization: *846 - repositories: &872 + organization: *837 + repositories: &863 description: An array of repository objects that the installation can access. type: array @@ -140290,8 +139182,8 @@ x-webhooks: - name - full_name - private - repository: *847 - requester: *871 + repository: *838 + requester: *862 sender: *4 required: - action @@ -140366,11 +139258,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 + enterprise: *835 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *837 + repositories: *863 + repository: *838 requester: nullable: true sender: *4 @@ -140446,11 +139338,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *844 + enterprise: *835 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *837 + repositories: *863 + repository: *838 requester: nullable: true sender: *4 @@ -140526,10 +139418,10 @@ x-webhooks: type: string enum: - added - enterprise: *844 + enterprise: *835 installation: *22 - organization: *846 - repositories_added: &873 + organization: *837 + repositories_added: &864 description: An array of repository objects, which were added to the installation. type: array @@ -140575,15 +139467,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *847 - repository_selection: &874 + repository: *838 + repository_selection: &865 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *871 + requester: *862 sender: *4 required: - action @@ -140662,10 +139554,10 @@ x-webhooks: type: string enum: - removed - enterprise: *844 + enterprise: *835 installation: *22 - organization: *846 - repositories_added: *873 + organization: *837 + repositories_added: *864 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -140692,9 +139584,9 @@ x-webhooks: - name - full_name - private - repository: *847 - repository_selection: *874 - requester: *871 + repository: *838 + repository_selection: *865 + requester: *862 sender: *4 required: - action @@ -140773,11 +139665,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *844 + enterprise: *835 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *837 + repositories: *863 + repository: *838 requester: nullable: true sender: *4 @@ -140956,10 +139848,10 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 target_type: type: string @@ -141038,11 +139930,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *844 + enterprise: *835 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *837 + repositories: *863 + repository: *838 requester: nullable: true sender: *4 @@ -141294,8 +140186,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -142089,8 +140981,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142439,8 +141331,8 @@ x-webhooks: - state - locked - assignee - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -142520,7 +141412,7 @@ x-webhooks: type: string enum: - deleted - comment: &875 + comment: &866 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -142685,8 +141577,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -143476,8 +142368,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143828,8 +142720,8 @@ x-webhooks: - state - locked - assignee - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -143909,7 +142801,7 @@ x-webhooks: type: string enum: - edited - changes: &904 + changes: &895 description: The changes to the comment. type: object properties: @@ -143921,9 +142813,9 @@ x-webhooks: type: string required: - from - comment: *875 - enterprise: *844 - installation: *845 + comment: *866 + enterprise: *835 + installation: *836 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -144716,8 +143608,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145066,8 +143958,8 @@ x-webhooks: - state - locked - assignee - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -145157,9 +144049,9 @@ x-webhooks: type: number blocking_issue: *227 blocking_issue_repo: *74 - installation: *845 - organization: *846 - repository: *847 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -145253,9 +144145,9 @@ x-webhooks: type: number blocking_issue: *227 blocking_issue_repo: *74 - installation: *845 - organization: *846 - repository: *847 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -145348,9 +144240,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -145444,9 +144336,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -145531,10 +144423,10 @@ x-webhooks: type: string enum: - assigned - assignee: *871 - enterprise: *844 - installation: *845 - issue: &878 + assignee: *862 + enterprise: *835 + installation: *836 + issue: &869 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -146323,11 +145215,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146444,8 +145336,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -146525,8 +145417,8 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -147320,11 +146212,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147576,8 +146468,8 @@ x-webhooks: required: - state - closed_at - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -147656,8 +146548,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -148442,11 +147334,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148562,8 +147454,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -148642,8 +147534,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -149450,11 +148342,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149549,7 +148441,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &876 + milestone: &867 title: Milestone description: A collection of related issues and pull requests. type: object @@ -149687,8 +148579,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -149787,8 +148679,8 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -150577,11 +149469,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150698,9 +149590,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *865 - organization: *846 - repository: *847 + label: *856 + organization: *837 + repository: *838 sender: *4 required: - action @@ -150780,8 +149672,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -151569,11 +150461,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151690,9 +150582,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *865 - organization: *846 - repository: *847 + label: *856 + organization: *837 + repository: *838 sender: *4 required: - action @@ -151772,8 +150664,8 @@ x-webhooks: type: string enum: - locked - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -152585,11 +151477,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152683,8 +151575,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -152763,8 +151655,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -153570,11 +152462,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153668,9 +152560,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *876 - organization: *846 - repository: *847 + milestone: *867 + organization: *837 + repository: *838 sender: *4 required: - action @@ -154538,11 +153430,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155104,8 +153996,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -155894,11 +154786,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156014,8 +154906,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -156095,9 +154987,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *844 - installation: *845 - issue: &877 + enterprise: *835 + installation: *836 + issue: &868 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -156880,11 +155772,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157000,8 +155892,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -157080,8 +155972,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -157891,11 +156783,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157990,8 +156882,8 @@ x-webhooks: user_view_type: type: string type: *360 - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -158857,11 +157749,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159445,11 +158337,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *844 - installation: *845 - issue: *877 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + issue: *868 + organization: *837 + repository: *838 sender: *4 required: - action @@ -159529,12 +158421,12 @@ x-webhooks: type: string enum: - typed - enterprise: *844 - installation: *845 - issue: *878 + enterprise: *835 + installation: *836 + issue: *869 type: *360 - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -159615,7 +158507,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &907 + assignee: &898 title: User type: object nullable: true @@ -159685,11 +158577,11 @@ x-webhooks: required: - login - id - enterprise: *844 - installation: *845 - issue: *878 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + issue: *869 + organization: *837 + repository: *838 sender: *4 required: - action @@ -159768,12 +158660,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *844 - installation: *845 - issue: *878 - label: *865 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + issue: *869 + label: *856 + organization: *837 + repository: *838 sender: *4 required: - action @@ -159853,8 +158745,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -160664,11 +159556,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *781 + issue_dependencies_summary: *782 issue_field_values: type: array - items: *790 + items: *783 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160762,8 +159654,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -160843,11 +159735,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *844 - installation: *845 - issue: *877 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + issue: *868 + organization: *837 + repository: *838 sender: *4 required: - action @@ -160926,12 +159818,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *844 - installation: *845 - issue: *878 + enterprise: *835 + installation: *836 + issue: *869 type: *360 - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -161011,11 +159903,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + label: *856 + organization: *837 + repository: *838 sender: *4 required: - action @@ -161093,11 +159985,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + label: *856 + organization: *837 + repository: *838 sender: *4 required: - action @@ -161207,11 +160099,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + label: *856 + organization: *837 + repository: *838 sender: *4 required: - action @@ -161293,9 +160185,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: &879 + enterprise: *835 + installation: *836 + marketplace_purchase: &870 title: Marketplace Purchase type: object required: @@ -161378,8 +160270,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *846 - previous_marketplace_purchase: &880 + organization: *837 + previous_marketplace_purchase: &871 title: Marketplace Purchase type: object properties: @@ -161459,7 +160351,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *847 + repository: *838 sender: *4 required: - action @@ -161539,10 +160431,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: *879 - organization: *846 + enterprise: *835 + installation: *836 + marketplace_purchase: *870 + organization: *837 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -161625,7 +160517,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *847 + repository: *838 sender: *4 required: - action @@ -161707,10 +160599,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: *879 - organization: *846 + enterprise: *835 + installation: *836 + marketplace_purchase: *870 + organization: *837 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -161792,7 +160684,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *847 + repository: *838 sender: *4 required: - action @@ -161873,8 +160765,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 marketplace_purchase: title: Marketplace Purchase type: object @@ -161956,9 +160848,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *846 - previous_marketplace_purchase: *880 - repository: *847 + organization: *837 + previous_marketplace_purchase: *871 + repository: *838 sender: *4 required: - action @@ -162038,12 +160930,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: *879 - organization: *846 - previous_marketplace_purchase: *880 - repository: *847 + enterprise: *835 + installation: *836 + marketplace_purchase: *870 + organization: *837 + previous_marketplace_purchase: *871 + repository: *838 sender: *4 required: - action @@ -162145,11 +161037,11 @@ x-webhooks: type: string required: - to - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + member: *862 + organization: *837 + repository: *838 sender: *4 required: - action @@ -162249,11 +161141,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + member: *862 + organization: *837 + repository: *838 sender: *4 required: - action @@ -162332,11 +161224,11 @@ x-webhooks: type: string enum: - removed - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + member: *862 + organization: *837 + repository: *838 sender: *4 required: - action @@ -162414,11 +161306,11 @@ x-webhooks: type: string enum: - added - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + member: *862 + organization: *837 + repository: *838 scope: description: The scope of the membership. Currently, can only be `team`. @@ -162494,7 +161386,7 @@ x-webhooks: required: - login - id - team: &881 + team: &872 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -162717,11 +161609,11 @@ x-webhooks: type: string enum: - removed - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + member: *862 + organization: *837 + repository: *838 scope: description: The scope of the membership. Currently, can only be `team`. @@ -162798,7 +161690,7 @@ x-webhooks: required: - login - id - team: *881 + team: *872 required: - action - scope @@ -162880,8 +161772,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *845 - merge_group: &883 + installation: *836 + merge_group: &874 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -162900,15 +161792,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *882 + head_commit: *873 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -162994,10 +161886,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *845 - merge_group: *883 - organization: *846 - repository: *847 + installation: *836 + merge_group: *874 + organization: *837 + repository: *838 sender: *4 required: - action @@ -163070,7 +161962,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 + enterprise: *835 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -163179,16 +162071,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *845 - organization: *846 + installation: *836 + organization: *837 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *875 + required: *876 nullable: true sender: *4 required: @@ -163269,11 +162161,11 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 - milestone: *876 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + milestone: *867 + organization: *837 + repository: *838 sender: *4 required: - action @@ -163352,9 +162244,9 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - milestone: &886 + enterprise: *835 + installation: *836 + milestone: &877 title: Milestone description: A collection of related issues and pull requests. type: object @@ -163491,8 +162383,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -163571,11 +162463,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - milestone: *876 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + milestone: *867 + organization: *837 + repository: *838 sender: *4 required: - action @@ -163685,11 +162577,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - milestone: *876 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + milestone: *867 + organization: *837 + repository: *838 sender: *4 required: - action @@ -163769,11 +162661,11 @@ x-webhooks: type: string enum: - opened - enterprise: *844 - installation: *845 - milestone: *886 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + milestone: *877 + organization: *837 + repository: *838 sender: *4 required: - action @@ -163852,11 +162744,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *871 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + blocked_user: *862 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -163935,11 +162827,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *871 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + blocked_user: *862 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -164015,7 +162907,7 @@ x-webhooks: enum: - created definition: *146 - enterprise: *844 + enterprise: *835 sender: *4 required: - action @@ -164095,8 +162987,8 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 sender: *4 required: - action @@ -164169,8 +163061,8 @@ x-webhooks: enum: - updated definition: *146 - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 sender: *4 required: - action @@ -164242,9 +163134,9 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 sender: *4 new_property_values: type: array @@ -164332,9 +163224,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - membership: &887 + enterprise: *835 + installation: *836 + membership: &878 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -164441,8 +163333,8 @@ x-webhooks: - role - organization_url - user - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 required: - action @@ -164520,11 +163412,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *844 - installation: *845 - membership: *887 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + membership: *878 + organization: *837 + repository: *838 sender: *4 required: - action @@ -164603,8 +163495,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -164720,10 +163612,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 - user: *871 + user: *862 required: - action - invitation @@ -164801,11 +163693,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *844 - installation: *845 - membership: *887 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + membership: *878 + organization: *837 + repository: *838 sender: *4 required: - action @@ -164892,11 +163784,11 @@ x-webhooks: properties: from: type: string - enterprise: *844 - installation: *845 - membership: *887 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + membership: *878 + organization: *837 + repository: *838 sender: *4 required: - action @@ -164972,9 +163864,9 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 package: description: Information about the package. type: object @@ -165473,7 +164365,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &888 + items: &879 title: Ruby Gems metadata type: object properties: @@ -165568,7 +164460,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *838 sender: *4 required: - action @@ -165644,9 +164536,9 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 package: description: Information about the package. type: object @@ -165999,7 +164891,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *888 + items: *879 source_url: type: string format: uri @@ -166069,7 +164961,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *838 sender: *4 required: - action @@ -166246,12 +165138,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *844 + enterprise: *835 id: type: integer - installation: *845 - organization: *846 - repository: *847 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - id @@ -166328,7 +165220,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &889 + personal_access_token_request: &880 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -166474,10 +165366,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *844 - organization: *846 + enterprise: *835 + organization: *837 sender: *4 - installation: *845 + installation: *836 required: - action - personal_access_token_request @@ -166554,11 +165446,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *889 - enterprise: *844 - organization: *846 + personal_access_token_request: *880 + enterprise: *835 + organization: *837 sender: *4 - installation: *845 + installation: *836 required: - action - personal_access_token_request @@ -166634,11 +165526,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *889 - enterprise: *844 - organization: *846 + personal_access_token_request: *880 + enterprise: *835 + organization: *837 sender: *4 - installation: *845 + installation: *836 required: - action - personal_access_token_request @@ -166713,11 +165605,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *889 - organization: *846 - enterprise: *844 + personal_access_token_request: *880 + organization: *837 + enterprise: *835 sender: *4 - installation: *845 + installation: *836 required: - action - personal_access_token_request @@ -166822,7 +165714,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *890 + last_response: *881 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -166854,8 +165746,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 zen: description: Random string of GitHub zen. @@ -167100,10 +165992,10 @@ x-webhooks: - from required: - note - enterprise: *844 - installation: *845 - organization: *846 - project_card: &891 + enterprise: *835 + installation: *836 + organization: *837 + project_card: &882 title: Project Card type: object properties: @@ -167222,7 +166114,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *847 + repository: *838 sender: *4 required: - action @@ -167303,11 +166195,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - project_card: *891 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + project_card: *882 + repository: *838 sender: *4 required: - action @@ -167387,9 +166279,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 project_card: title: Project Card type: object @@ -167517,8 +166409,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *875 + required: *876 nullable: true sender: *4 required: @@ -167612,11 +166504,11 @@ x-webhooks: - from required: - note - enterprise: *844 - installation: *845 - organization: *846 - project_card: *891 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + project_card: *882 + repository: *838 sender: *4 required: - action @@ -167710,9 +166602,9 @@ x-webhooks: - from required: - column_id - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 project_card: allOf: - title: Project Card @@ -167902,7 +166794,7 @@ x-webhooks: type: string required: - after_id - repository: *847 + repository: *838 sender: *4 required: - action @@ -167982,10 +166874,10 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 - organization: *846 - project: &893 + enterprise: *835 + installation: *836 + organization: *837 + project: &884 title: Project type: object properties: @@ -168109,7 +167001,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *847 + repository: *838 sender: *4 required: - action @@ -168189,10 +167081,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - project_column: &892 + enterprise: *835 + installation: *836 + organization: *837 + project_column: &883 title: Project Column type: object properties: @@ -168231,7 +167123,7 @@ x-webhooks: - name - created_at - updated_at - repository: *847 + repository: *838 sender: *4 required: - action @@ -168310,18 +167202,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - project_column: *892 + enterprise: *835 + installation: *836 + organization: *837 + project_column: *883 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *875 + required: *876 nullable: true sender: *4 required: @@ -168411,11 +167303,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - project_column: *892 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + project_column: *883 + repository: *838 sender: *4 required: - action @@ -168495,11 +167387,11 @@ x-webhooks: type: string enum: - moved - enterprise: *844 - installation: *845 - organization: *846 - project_column: *892 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + project_column: *883 + repository: *838 sender: *4 required: - action @@ -168579,11 +167471,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - project: *893 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + project: *884 + repository: *838 sender: *4 required: - action @@ -168663,18 +167555,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - project: *893 + enterprise: *835 + installation: *836 + organization: *837 + project: *884 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *875 + required: *876 nullable: true sender: *4 required: @@ -168776,11 +167668,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - project: *893 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + project: *884 + repository: *838 sender: *4 required: - action @@ -168859,11 +167751,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *844 - installation: *845 - organization: *846 - project: *893 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + project: *884 + repository: *838 sender: *4 required: - action @@ -168944,8 +167836,8 @@ x-webhooks: type: string enum: - closed - installation: *845 - organization: *846 + installation: *836 + organization: *837 projects_v2: *392 sender: *4 required: @@ -169027,8 +167919,8 @@ x-webhooks: type: string enum: - created - installation: *845 - organization: *846 + installation: *836 + organization: *837 projects_v2: *392 sender: *4 required: @@ -169110,8 +168002,8 @@ x-webhooks: type: string enum: - deleted - installation: *845 - organization: *846 + installation: *836 + organization: *837 projects_v2: *392 sender: *4 required: @@ -169229,8 +168121,8 @@ x-webhooks: type: string to: type: string - installation: *845 - organization: *846 + installation: *836 + organization: *837 projects_v2: *392 sender: *4 required: @@ -169314,7 +168206,7 @@ x-webhooks: type: string enum: - archived - changes: &897 + changes: &888 type: object properties: archived_at: @@ -169328,9 +168220,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *845 - organization: *846 - projects_v2_item: &894 + installation: *836 + organization: *837 + projects_v2_item: &885 title: Projects v2 Item description: An item belonging to a project type: object @@ -169465,9 +168357,9 @@ x-webhooks: nullable: true to: type: string - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *836 + organization: *837 + projects_v2_item: *885 sender: *4 required: - action @@ -169549,9 +168441,9 @@ x-webhooks: type: string enum: - created - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *836 + organization: *837 + projects_v2_item: *885 sender: *4 required: - action @@ -169632,9 +168524,9 @@ x-webhooks: type: string enum: - deleted - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *836 + organization: *837 + projects_v2_item: *885 sender: *4 required: - action @@ -169740,7 +168632,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &895 + - &886 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -169762,7 +168654,7 @@ x-webhooks: required: - id - name - - &896 + - &887 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -169796,8 +168688,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *895 - - *896 + - *886 + - *887 required: - field_value - type: object @@ -169813,9 +168705,9 @@ x-webhooks: nullable: true required: - body - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *836 + organization: *837 + projects_v2_item: *885 sender: *4 required: - action @@ -169910,9 +168802,9 @@ x-webhooks: to: type: string nullable: true - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *836 + organization: *837 + projects_v2_item: *885 sender: *4 required: - action @@ -169995,10 +168887,10 @@ x-webhooks: type: string enum: - restored - changes: *897 - installation: *845 - organization: *846 - projects_v2_item: *894 + changes: *888 + installation: *836 + organization: *837 + projects_v2_item: *885 sender: *4 required: - action @@ -170080,8 +168972,8 @@ x-webhooks: type: string enum: - reopened - installation: *845 - organization: *846 + installation: *836 + organization: *837 projects_v2: *392 sender: *4 required: @@ -170163,14 +169055,14 @@ x-webhooks: type: string enum: - created - installation: *845 - organization: *846 - projects_v2_status_update: &900 + installation: *836 + organization: *837 + projects_v2_status_update: &891 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *898 - required: *899 + properties: *889 + required: *890 sender: *4 required: - action @@ -170251,9 +169143,9 @@ x-webhooks: type: string enum: - deleted - installation: *845 - organization: *846 - projects_v2_status_update: *900 + installation: *836 + organization: *837 + projects_v2_status_update: *891 sender: *4 required: - action @@ -170389,9 +169281,9 @@ x-webhooks: type: string format: date nullable: true - installation: *845 - organization: *846 - projects_v2_status_update: *900 + installation: *836 + organization: *837 + projects_v2_status_update: *891 sender: *4 required: - action @@ -170462,10 +169354,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - repository @@ -170542,13 +169434,13 @@ x-webhooks: type: string enum: - assigned - assignee: *871 - enterprise: *844 - installation: *845 - number: &901 + assignee: *862 + enterprise: *835 + installation: *836 + number: &892 description: The pull request number. type: integer - organization: *846 + organization: *837 pull_request: title: Pull Request type: object @@ -172831,7 +171723,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 sender: *4 required: - action @@ -172913,11 +171805,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 number: type: integer - organization: *846 + organization: *837 pull_request: title: Pull Request type: object @@ -175195,7 +174087,7 @@ x-webhooks: - draft reason: type: string - repository: *847 + repository: *838 sender: *4 required: - action @@ -175277,11 +174169,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 number: type: integer - organization: *846 + organization: *837 pull_request: title: Pull Request type: object @@ -177559,7 +176451,7 @@ x-webhooks: - draft reason: type: string - repository: *847 + repository: *838 sender: *4 required: - action @@ -177641,13 +176533,13 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: &902 + enterprise: *835 + installation: *836 + number: *892 + organization: *837 + pull_request: &893 allOf: - - *695 + - *688 - type: object properties: allow_auto_merge: @@ -177709,7 +176601,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *847 + repository: *838 sender: *4 required: - action @@ -177790,12 +176682,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *835 + installation: *836 + number: *892 + organization: *837 + pull_request: *893 + repository: *838 sender: *4 required: - action @@ -177875,11 +176767,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *844 - milestone: *677 - number: *901 - organization: *846 - pull_request: &903 + enterprise: *835 + milestone: *670 + number: *892 + organization: *837 + pull_request: &894 title: Pull Request type: object properties: @@ -180142,7 +179034,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 sender: *4 required: - action @@ -180221,11 +179113,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 number: type: integer - organization: *846 + organization: *837 pull_request: title: Pull Request type: object @@ -182507,7 +181399,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *847 + repository: *838 sender: *4 required: - action @@ -182631,12 +181523,12 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *835 + installation: *836 + number: *892 + organization: *837 + pull_request: *893 + repository: *838 sender: *4 required: - action @@ -182716,11 +181608,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 number: type: integer - organization: *846 + organization: *837 pull_request: title: Pull Request type: object @@ -184987,7 +183879,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 sender: *4 required: - action @@ -185067,11 +183959,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *844 - installation: *845 - label: *865 - number: *901 - organization: *846 + enterprise: *835 + installation: *836 + label: *856 + number: *892 + organization: *837 pull_request: title: Pull Request type: object @@ -187353,7 +186245,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 sender: *4 required: - action @@ -187434,10 +186326,10 @@ x-webhooks: type: string enum: - locked - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + enterprise: *835 + installation: *836 + number: *892 + organization: *837 pull_request: title: Pull Request type: object @@ -189717,7 +188609,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 sender: *4 required: - action @@ -189797,12 +188689,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *844 - milestone: *677 - number: *901 - organization: *846 - pull_request: *903 - repository: *847 + enterprise: *835 + milestone: *670 + number: *892 + organization: *837 + pull_request: *894 + repository: *838 sender: *4 required: - action @@ -189881,12 +188773,12 @@ x-webhooks: type: string enum: - opened - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *835 + installation: *836 + number: *892 + organization: *837 + pull_request: *893 + repository: *838 sender: *4 required: - action @@ -189967,12 +188859,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *835 + installation: *836 + number: *892 + organization: *837 + pull_request: *893 + repository: *838 sender: *4 required: - action @@ -190052,12 +188944,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *835 + installation: *836 + number: *892 + organization: *837 + pull_request: *893 + repository: *838 sender: *4 required: - action @@ -190423,9 +189315,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 pull_request: type: object properties: @@ -192595,7 +191487,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *847 + repository: *838 sender: *4 required: - action @@ -192675,7 +191567,7 @@ x-webhooks: type: string enum: - deleted - comment: &905 + comment: &896 title: Pull Request Review Comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -192960,9 +191852,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 pull_request: type: object properties: @@ -195120,7 +194012,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *847 + repository: *838 sender: *4 required: - action @@ -195200,11 +194092,11 @@ x-webhooks: type: string enum: - edited - changes: *904 - comment: *905 - enterprise: *844 - installation: *845 - organization: *846 + changes: *895 + comment: *896 + enterprise: *835 + installation: *836 + organization: *837 pull_request: type: object properties: @@ -197365,7 +196257,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *847 + repository: *838 sender: *4 required: - action @@ -197446,9 +196338,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 pull_request: title: Simple Pull Request type: object @@ -199621,7 +198513,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 + repository: *838 review: description: The review that was affected. type: object @@ -199868,9 +198760,9 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 pull_request: title: Simple Pull Request type: object @@ -201924,8 +200816,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 - review: &906 + repository: *838 + review: &897 description: The review that was affected. type: object properties: @@ -202158,12 +201050,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 number: description: The pull request number. type: integer - organization: *846 + organization: *837 pull_request: title: Pull Request type: object @@ -204446,7 +203338,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 requested_reviewer: title: User type: object @@ -204530,12 +203422,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 number: description: The pull request number. type: integer - organization: *846 + organization: *837 pull_request: title: Pull Request type: object @@ -206825,7 +205717,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 requested_team: title: Team description: Groups of organization members that gives permissions @@ -207017,12 +205909,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 number: description: The pull request number. type: integer - organization: *846 + organization: *837 pull_request: title: Pull Request type: object @@ -209307,7 +208199,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 requested_reviewer: title: User type: object @@ -209392,12 +208284,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *844 - installation: *845 + enterprise: *835 + installation: *836 number: description: The pull request number. type: integer - organization: *846 + organization: *837 pull_request: title: Pull Request type: object @@ -211673,7 +210565,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 requested_team: title: Team description: Groups of organization members that gives permissions @@ -211854,9 +210746,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 pull_request: title: Simple Pull Request type: object @@ -214031,8 +212923,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 - review: *906 + repository: *838 + review: *897 sender: *4 required: - action @@ -214112,9 +213004,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 pull_request: title: Simple Pull Request type: object @@ -216184,7 +215076,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 + repository: *838 sender: *4 thread: type: object @@ -216571,9 +215463,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 pull_request: title: Simple Pull Request type: object @@ -218629,7 +217521,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 + repository: *838 sender: *4 thread: type: object @@ -219019,10 +217911,10 @@ x-webhooks: type: string before: type: string - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + enterprise: *835 + installation: *836 + number: *892 + organization: *837 pull_request: title: Pull Request type: object @@ -221293,7 +220185,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 sender: *4 required: - action @@ -221375,11 +220267,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *907 - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + assignee: *898 + enterprise: *835 + installation: *836 + number: *892 + organization: *837 pull_request: title: Pull Request type: object @@ -223662,7 +222554,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 sender: *4 required: - action @@ -223741,11 +222633,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *844 - installation: *845 - label: *865 - number: *901 - organization: *846 + enterprise: *835 + installation: *836 + label: *856 + number: *892 + organization: *837 pull_request: title: Pull Request type: object @@ -226018,7 +224910,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 sender: *4 required: - action @@ -226099,10 +224991,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + enterprise: *835 + installation: *836 + number: *892 + organization: *837 pull_request: title: Pull Request type: object @@ -228367,7 +227259,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *838 sender: *4 required: - action @@ -228567,7 +227459,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *844 + enterprise: *835 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -228659,8 +227551,8 @@ x-webhooks: - url - author - committer - installation: *845 - organization: *846 + installation: *836 + organization: *837 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -229235,9 +228127,9 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 registry_package: type: object properties: @@ -229683,7 +228575,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *888 + items: *879 summary: type: string tag_name: @@ -229737,7 +228629,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *838 sender: *4 required: - action @@ -229815,9 +228707,9 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 registry_package: type: object properties: @@ -230125,7 +229017,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *888 + items: *879 summary: type: string tag_name: @@ -230174,7 +229066,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *838 sender: *4 required: - action @@ -230251,10 +229143,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - release: &908 + enterprise: *835 + installation: *836 + organization: *837 + release: &899 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -230572,7 +229464,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *847 + repository: *838 sender: *4 required: - action @@ -230649,11 +229541,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - release: *908 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + release: *899 + repository: *838 sender: *4 required: - action @@ -230770,11 +229662,11 @@ x-webhooks: type: boolean required: - to - enterprise: *844 - installation: *845 - organization: *846 - release: *908 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + release: *899 + repository: *838 sender: *4 required: - action @@ -230852,9 +229744,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -231176,7 +230068,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *847 + repository: *838 sender: *4 required: - action @@ -231252,10 +230144,10 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 - release: &909 + enterprise: *835 + installation: *836 + organization: *837 + release: &900 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -231574,7 +230466,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *847 + repository: *838 sender: *4 required: - action @@ -231650,11 +230542,11 @@ x-webhooks: type: string enum: - released - enterprise: *844 - installation: *845 - organization: *846 - release: *908 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + release: *899 + repository: *838 sender: *4 required: - action @@ -231730,11 +230622,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *844 - installation: *845 - organization: *846 - release: *909 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + release: *900 + repository: *838 sender: *4 required: - action @@ -231810,11 +230702,11 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - repository_advisory: *748 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + repository_advisory: *741 sender: *4 required: - action @@ -231890,11 +230782,11 @@ x-webhooks: type: string enum: - reported - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - repository_advisory: *748 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + repository_advisory: *741 sender: *4 required: - action @@ -231970,10 +230862,10 @@ x-webhooks: type: string enum: - archived - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -232050,10 +230942,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -232131,10 +231023,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -232218,10 +231110,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -232333,10 +231225,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -232408,10 +231300,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 status: type: string @@ -232492,10 +231384,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -232572,10 +231464,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -232669,10 +231561,10 @@ x-webhooks: - name required: - repository - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -232752,10 +231644,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 repository_ruleset: *185 sender: *4 required: @@ -232834,10 +231726,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 repository_ruleset: *185 sender: *4 required: @@ -232916,10 +231808,10 @@ x-webhooks: type: string enum: - edited - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 repository_ruleset: *185 changes: type: object @@ -232981,16 +231873,16 @@ x-webhooks: properties: added: type: array - items: *716 + items: *709 deleted: type: array - items: *716 + items: *709 updated: type: array items: type: object properties: - rule: *716 + rule: *709 changes: type: object properties: @@ -233224,10 +232116,10 @@ x-webhooks: - from required: - owner - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -233305,10 +232197,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -233386,7 +232278,7 @@ x-webhooks: type: string enum: - create - alert: &910 + alert: &901 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -233507,10 +232399,10 @@ x-webhooks: type: string enum: - open - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -233716,10 +232608,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -233797,11 +232689,11 @@ x-webhooks: type: string enum: - reopen - alert: *910 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *901 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -234000,10 +232892,10 @@ x-webhooks: enum: - fixed - open - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -234021,7 +232913,7 @@ x-webhooks: supported-webhook-types: - repository - organization - secret-scanning-alert-created: + secret-scanning-alert-assigned: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. @@ -234029,8 +232921,8 @@ x-webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was created. - operationId: secret-scanning-alert/created + description: A secret scanning alert was assigned. + operationId: secret-scanning-alert/assigned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -234074,14 +232966,14 @@ x-webhooks: content: application/json: schema: - title: secret_scanning_alert created event + title: secret_scanning_alert assigned event type: object properties: action: type: string enum: - - created - alert: &911 + - assigned + alert: &902 type: object properties: number: *123 @@ -234199,10 +233091,93 @@ x-webhooks: properties: *20 required: *21 nullable: true - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + assignee: *4 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-created: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was created. + operationId: secret-scanning-alert/created + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: secret_scanning_alert created event + type: object + properties: + action: + type: string + enum: + - created + alert: *902 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -234283,11 +233258,11 @@ x-webhooks: type: string enum: - created - alert: *911 - installation: *845 - location: *912 - organization: *846 - repository: *847 + alert: *902 + installation: *836 + location: *903 + organization: *837 + repository: *838 sender: *4 required: - location @@ -234525,11 +233500,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *902 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -234607,11 +233582,11 @@ x-webhooks: type: string enum: - reopened - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *902 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -234689,11 +233664,94 @@ x-webhooks: type: string enum: - resolved - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *902 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-unassigned: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was unassigned. + operationId: secret-scanning-alert/unassigned + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: secret_scanning_alert unassigned event + type: object + properties: + action: + type: string + enum: + - unassigned + alert: *902 + assignee: *4 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -234771,11 +233829,11 @@ x-webhooks: type: string enum: - validated - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *902 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -234901,10 +233959,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *847 - enterprise: *844 - installation: *845 - organization: *846 + repository: *838 + enterprise: *835 + installation: *836 + organization: *837 sender: *4 required: - action @@ -234982,11 +234040,11 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - security_advisory: &913 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + security_advisory: &904 description: The details of the security advisory, including summary, description, and severity. type: object @@ -235169,11 +234227,11 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - security_advisory: *913 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 + security_advisory: *904 sender: *4 required: - action @@ -235246,10 +234304,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -235434,10 +234492,10 @@ x-webhooks: type: object properties: security_and_analysis: *408 - enterprise: *844 - installation: *845 - organization: *846 - repository: *467 + enterprise: *835 + installation: *836 + organization: *837 + repository: *460 sender: *4 required: - changes @@ -235515,12 +234573,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - sponsorship: &914 + sponsorship: &905 type: object properties: created_at: @@ -235821,12 +234879,12 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - sponsorship: *914 + sponsorship: *905 required: - action - sponsorship @@ -235914,12 +234972,12 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - sponsorship: *914 + sponsorship: *905 required: - action - changes @@ -235996,17 +235054,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &915 + effective_date: &906 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - sponsorship: *914 + sponsorship: *905 required: - action - sponsorship @@ -236080,7 +235138,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &916 + changes: &907 type: object properties: tier: @@ -236124,13 +235182,13 @@ x-webhooks: - from required: - tier - effective_date: *915 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + effective_date: *906 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - sponsorship: *914 + sponsorship: *905 required: - action - changes @@ -236207,13 +235265,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *916 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + changes: *907 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - sponsorship: *914 + sponsorship: *905 required: - action - changes @@ -236287,10 +235345,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -236373,10 +235431,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -236796,15 +235854,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *844 + enterprise: *835 id: description: The unique identifier of the status. type: integer - installation: *845 + installation: *836 name: type: string - organization: *846 - repository: *847 + organization: *837 + repository: *838 sender: *4 sha: description: The Commit SHA. @@ -236919,9 +235977,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -237011,9 +236069,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -237103,9 +236161,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -237195,9 +236253,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -237274,12 +236332,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - team: &917 + team: &908 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -237502,9 +236560,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 repository: title: Repository description: A git repository @@ -237962,7 +237020,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *908 required: - action - team @@ -238038,9 +237096,9 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 repository: title: Repository description: A git repository @@ -238498,7 +237556,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *908 required: - action - team @@ -238575,9 +237633,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 repository: title: Repository description: A git repository @@ -239035,7 +238093,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *908 required: - action - team @@ -239179,9 +238237,9 @@ x-webhooks: - from required: - permissions - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 repository: title: Repository description: A git repository @@ -239639,7 +238697,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *908 required: - action - changes @@ -239717,9 +238775,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *835 + installation: *836 + organization: *837 repository: title: Repository description: A git repository @@ -240177,7 +239235,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *908 required: - action - team @@ -240253,10 +239311,10 @@ x-webhooks: type: string enum: - started - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 required: - action @@ -240329,16 +239387,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *844 + enterprise: *835 inputs: type: object nullable: true additionalProperties: true - installation: *845 - organization: *846 + installation: *836 + organization: *837 ref: type: string - repository: *847 + repository: *838 sender: *4 workflow: type: string @@ -240420,10 +239478,10 @@ x-webhooks: type: string enum: - completed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 workflow_job: allOf: @@ -240660,7 +239718,7 @@ x-webhooks: type: string required: - conclusion - deployment: *599 + deployment: *592 required: - action - repository @@ -240739,10 +239797,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 workflow_job: allOf: @@ -241002,7 +240060,7 @@ x-webhooks: required: - status - steps - deployment: *599 + deployment: *592 required: - action - repository @@ -241081,10 +240139,10 @@ x-webhooks: type: string enum: - queued - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 workflow_job: type: object @@ -241219,7 +240277,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *599 + deployment: *592 required: - action - repository @@ -241298,10 +240356,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 workflow_job: type: object @@ -241437,7 +240495,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *599 + deployment: *592 required: - action - repository @@ -241517,12 +240575,12 @@ x-webhooks: type: string enum: - completed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - workflow: *861 + workflow: *852 workflow_run: title: Workflow Run type: object @@ -242521,12 +241579,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *835 + installation: *836 + organization: *837 + repository: *838 sender: *4 - workflow: *861 + workflow: *852 workflow_run: title: Workflow Run type: object @@ -243510,12 +242568,12 @@ x-webhooks: type: string enum: - requested - enterprise: *844 - installatio{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}