summaryrefslogtreecommitdiffstats
path: root/descriptions/api.github.com/api.github.com.2022-11-28.yaml
diff options
context:
space:
mode:
authorgithub-openapi-bot <security+github-openapi-bot@github.com>2025-01-29 12:17:41 -0800
committergithub-openapi-bot <security+github-openapi-bot@github.com>2025-01-29 12:17:41 -0800
commit3b3051be70d94dfb5929e24a570e44698f03fca0 (patch)
tree90b7cb04dc5e0d9803683ff8ebc996bcef310980 /descriptions/api.github.com/api.github.com.2022-11-28.yaml
parent795897c437bded214ee22f511306cce3f387ca05 (diff)
downloadrest-api-description-3b3051be70d94dfb5929e24a570e44698f03fca0.tar.gz
rest-api-description-3b3051be70d94dfb5929e24a570e44698f03fca0.zip
Update OpenAPI 3.0 Descriptions
Diffstat (limited to 'descriptions/api.github.com/api.github.com.2022-11-28.yaml')
-rw-r--r--descriptions/api.github.com/api.github.com.2022-11-28.yaml239
1 files changed, 184 insertions, 55 deletions
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 777e9a775..e23afb2f5 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
@@ -6864,6 +6864,8 @@ paths:
items:
type: integer
required:
+ - encrypted_value
+ - key_id
- visibility
examples:
default:
@@ -13984,10 +13986,10 @@ paths:
"/orgs/{org}/projects":
get:
summary: List organization projects
- description: Lists the projects in an organization. Returns a `404 Not Found`
- status if projects are disabled in the organization. If you do not have sufficient
- privileges to perform this action, a `401 Unauthorized` or `410 Gone` status
- is returned.
+ 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
operationId: projects/list-for-org
@@ -14031,12 +14033,15 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: projects
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
post:
summary: Create an organization project
- description: Creates an organization project board. Returns a `410 Gone` status
- if projects are disabled in the organization or if the organization does not
- have existing classic projects. If you do not have sufficient privileges to
- perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
+ 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
operationId: projects/create-for-org
@@ -14090,6 +14095,9 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: projects
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
"/orgs/{org}/properties/schema":
get:
summary: Get all custom properties for an organization
@@ -17623,7 +17631,10 @@ paths:
"/projects/columns/cards/{card_id}":
get:
summary: Get a project card
- description: Gets information about 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
operationId: projects/get-card
@@ -17655,9 +17666,15 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: cards
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
patch:
summary: Update an existing project card
- description: ''
+ 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
operationId: projects/update-card
@@ -17712,9 +17729,15 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: cards
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
delete:
summary: Delete a project card
- description: Deletes 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
operationId: projects/delete-card
@@ -17752,10 +17775,16 @@ paths:
enabledForGitHubApps: true
category: projects
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: ''
+ 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
operationId: projects/move-card
@@ -17860,10 +17889,16 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: cards
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
"/projects/columns/{column_id}":
get:
summary: Get a project column
- description: Gets information about 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
operationId: projects/get-column
@@ -17895,9 +17930,15 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: columns
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
patch:
summary: Update an existing project column
- description: ''
+ 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
operationId: projects/update-column
@@ -17945,9 +17986,15 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: columns
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
delete:
summary: Delete a project column
- description: Deletes 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
operationId: projects/delete-column
@@ -17970,10 +18017,16 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: columns
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
"/projects/columns/{column_id}/cards":
get:
summary: List project cards
- description: Lists the project cards in 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:
- projects
operationId: projects/list-cards
@@ -18021,9 +18074,15 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: cards
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
post:
summary: Create a project card
- description: ''
+ 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
operationId: projects/create-card
@@ -18117,10 +18176,16 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: cards
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
"/projects/columns/{column_id}/moves":
post:
summary: Move a project column
- description: ''
+ 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
operationId: projects/move-column
@@ -18175,12 +18240,16 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: columns
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
"/projects/{project_id}":
get:
summary: Get a project
- description: Gets a project by its `id`. Returns a `404 Not Found` status if
- projects are disabled. If you do not have sufficient privileges to perform
- this action, a `401 Unauthorized` or `410 Gone` status is returned.
+ 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
operationId: projects/get
@@ -18210,11 +18279,15 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: projects
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
patch:
summary: Update a project
- description: Updates a project board's information. Returns a `404 Not Found`
- status if projects are disabled. If you do not have sufficient privileges
- to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
+ 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.
operationId: projects/update
tags:
- projects
@@ -18304,10 +18377,15 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: projects
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
delete:
summary: Delete a project
- description: Deletes a project board. Returns a `404 Not Found` status if projects
- are disabled.
+ 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.
operationId: projects/delete
tags:
- projects
@@ -18347,15 +18425,16 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: projects
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
"/projects/{project_id}/collaborators":
get:
summary: List project collaborators
- description: Lists the collaborators for an organization project. For a project,
- the list of collaborators includes outside collaborators, organization members
- that are direct collaborators, organization members with access through team
- memberships, organization members with access through default organization
- permissions, and organization owners. You must be an organization owner or
- a project `admin` to list 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
operationId: projects/list-collaborators
@@ -18411,11 +18490,16 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: collaborators
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
"/projects/{project_id}/collaborators/{username}":
put:
summary: Add project collaborator
- description: Adds a collaborator to an organization project and sets their permission
- level. You must be an organization owner or a project `admin` to add 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
operationId: projects/add-collaborator
@@ -18465,10 +18549,15 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: collaborators
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
delete:
summary: Remove user as a collaborator
- description: Removes a collaborator from an organization project. You must be
- an organization owner or a project `admin` to remove 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
operationId: projects/remove-collaborator
@@ -18496,13 +18585,16 @@ paths:
enabledForGitHubApps: true
category: projects
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: 'Returns the collaborator''s permission level for an organization
- project. Possible values for the `permission` key: `admin`, `write`, `read`,
- `none`. You must be an organization owner or a project `admin` to review a
- user''s permission level.'
+ 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
operationId: projects/get-permission-for-user
@@ -18537,10 +18629,16 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: collaborators
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
"/projects/{project_id}/columns":
get:
summary: List project columns
- description: Lists the project columns in 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:
- projects
operationId: projects/list-columns
@@ -18577,9 +18675,15 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: columns
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
post:
summary: Create a project column
- description: Creates a new 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
operationId: projects/create-column
@@ -18636,6 +18740,9 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: columns
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
"/rate_limit":
get:
summary: Get rate limit status for the authenticated user
@@ -21387,6 +21494,9 @@ paths:
key_id:
type: string
description: ID of the key you used to encrypt the secret.
+ required:
+ - encrypted_value
+ - key_id
examples:
default:
value:
@@ -37055,10 +37165,10 @@ paths:
"/repos/{owner}/{repo}/projects":
get:
summary: List repository projects
- description: Lists the projects in a repository. Returns a `404 Not Found` status
- if projects are disabled in the repository. If you do not have sufficient
- privileges to perform this action, a `401 Unauthorized` or `410 Gone` status
- is returned.
+ 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
operationId: projects/list-for-repo
@@ -37111,12 +37221,15 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: projects
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
post:
summary: Create a repository project
- description: Creates a repository project board. Returns a `410 Gone` status
- if projects are disabled in the repository or if the repository does not have
- existing classic projects. If you do not have sufficient privileges to perform
- this action, a `401 Unauthorized` or `410 Gone` status is returned.
+ 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
operationId: projects/create-for-repo
@@ -37171,6 +37284,9 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: projects
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
"/repos/{owner}/{repo}/properties/values":
get:
summary: Get all custom property values for a repository
@@ -48081,10 +48197,10 @@ paths:
"/user/projects":
post:
summary: Create a user project
- description: Creates a user project board. Returns a `410 Gone` status if the
- user does not have existing classic projects. If you do not have sufficient
- privileges to perform this action, a `401 Unauthorized` or `410 Gone` status
- is returned.
+ 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
operationId: projects/create-for-authenticated-user
@@ -48140,6 +48256,9 @@ paths:
enabledForGitHubApps: true
category: projects
subcategory: projects
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
"/user/public_emails":
get:
summary: List public email addresses for the authenticated user
@@ -50128,7 +50247,10 @@ paths:
"/users/{username}/projects":
get:
summary: List user projects
- description: Lists projects 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
operationId: projects/list-for-user
@@ -50172,6 +50294,9 @@ paths:
enabledForGitHubApps: false
category: projects
subcategory: projects
+ deprecationDate: '2024-05-23'
+ removalDate: '2025-04-01'
+ deprecated: true
"/users/{username}/received_events":
get:
summary: List events received by the authenticated user
@@ -82718,6 +82843,7 @@ components:
- reason
- payload
- signature
+ - verified_at
diff-entry:
title: Diff Entry
description: Diff Entry
@@ -87019,6 +87145,7 @@ components:
- reason
- signature
- payload
+ - verified_at
html_url:
type: string
format: uri
@@ -88749,6 +88876,7 @@ components:
- reason
- signature
- payload
+ - verified_at
html_url:
type: string
format: uri
@@ -191811,6 +191939,7 @@ components:
- reason
- signature
- payload
+ - verified_at
required:
- author
- committer