Skip to content

Update OpenAPI 3.0 Descriptions #5525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dinonuggies1 merged 1 commit into from
Oct 30, 2025
Merged

Update OpenAPI 3.0 Descriptions #5525

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
188 changes: 0 additions & 188 deletions descriptions/api.github.com/api.github.com.2022-11-28.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7711,9 +7711,6 @@
},
{
"$ref": "#/components/parameters/billing-usage-report-day"
},
{
"$ref": "#/components/parameters/billing-usage-report-hour"
}
],
"responses": {
Expand Down Expand Up @@ -30363,165 +30360,6 @@
"deprecated": true
}
},
"/projects/{project_id}/columns": {
"get": {
"summary": "List project columns",
"description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"projects-classic"
],
"operationId": "projects-classic/list-columns",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/projects-classic/columns#list-project-columns"
},
"parameters": [
{
"$ref": "#/components/parameters/project-id"
},
{
"$ref": "#/components/parameters/per-page"
},
{
"$ref": "#/components/parameters/page"
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/project-column"
}
},
"examples": {
"default": {
"$ref": "#/components/examples/project-column-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-classic",
"subcategory": "columns",
"deprecationDate": "2024-05-23",
"removalDate": "2025-04-01"
},
"deprecated": true
},
"post": {
"summary": "Create a project column",
"description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"projects-classic"
],
"operationId": "projects-classic/create-column",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/projects-classic/columns#create-a-project-column"
},
"parameters": [
{
"$ref": "#/components/parameters/project-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": {
"value": {
"name": "Remaining tasks"
}
}
}
}
}
},
"responses": {
"201": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/project-column"
},
"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": {
"$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
}
},
"/rate_limit": {
"get": {
"summary": "Get rate limit status for the authenticated user",
Expand Down Expand Up @@ -76494,9 +76332,6 @@
},
{
"$ref": "#/components/parameters/billing-usage-report-day"
},
{
"$ref": "#/components/parameters/billing-usage-report-hour"
}
],
"responses": {
Expand Down Expand Up @@ -289202,20 +289037,6 @@
}
}
},
"project-column-items": {
"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"
}
]
},
"rate-limit-overview": {
"value": {
"resources": {
Expand Down Expand Up @@ -309267,15 +309088,6 @@
"type": "integer"
}
},
"billing-usage-report-hour": {
"name": "hour",
"description": "If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or `day` is specified, the default `year`, `month`, and `day` are used.",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
"actions-custom-image-definition-id": {
"name": "image_definition_id",
"description": "Image definition ID of custom image",
Expand Down
132 changes: 0 additions & 132 deletions descriptions/api.github.com/api.github.com.2022-11-28.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5436,7 +5436,6 @@ paths:
- "$ref": "#/components/parameters/billing-usage-report-year"
- "$ref": "#/components/parameters/billing-usage-report-month"
- "$ref": "#/components/parameters/billing-usage-report-day"
- "$ref": "#/components/parameters/billing-usage-report-hour"
responses:
'200':
"$ref": "#/components/responses/billing_usage_report_org"
Expand Down Expand Up @@ -21939,117 +21938,6 @@ paths:
deprecationDate: '2024-05-23'
removalDate: '2025-04-01'
deprecated: true
"/projects/{project_id}/columns":
get:
summary: List project columns
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-columns
externalDocs:
description: API method documentation
url: https://docs.github.com/rest/projects-classic/columns#list-project-columns
parameters:
- "$ref": "#/components/parameters/project-id"
- "$ref": "#/components/parameters/per-page"
- "$ref": "#/components/parameters/page"
responses:
'200':
description: Response
content:
application/json:
schema:
type: array
items:
"$ref": "#/components/schemas/project-column"
examples:
default:
"$ref": "#/components/examples/project-column-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-classic
subcategory: columns
deprecationDate: '2024-05-23'
removalDate: '2025-04-01'
deprecated: true
post:
summary: Create 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/create-column
externalDocs:
description: API method documentation
url: https://docs.github.com/rest/projects-classic/columns#create-a-project-column
parameters:
- "$ref": "#/components/parameters/project-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:
value:
name: Remaining tasks
responses:
'201':
description: Response
content:
application/json:
schema:
"$ref": "#/components/schemas/project-column"
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':
"$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
"/rate_limit":
get:
summary: Get rate limit status for the authenticated user
Expand Down Expand Up @@ -55369,7 +55257,6 @@ paths:
- "$ref": "#/components/parameters/billing-usage-report-year"
- "$ref": "#/components/parameters/billing-usage-report-month"
- "$ref": "#/components/parameters/billing-usage-report-day"
- "$ref": "#/components/parameters/billing-usage-report-hour"
responses:
'200':
"$ref": "#/components/responses/billing_usage_report_user"
Expand Down Expand Up @@ -217409,16 +217296,6 @@ components:
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
project-column-items:
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'
rate-limit-overview:
value:
resources:
Expand Down Expand Up @@ -234759,15 +234636,6 @@ components:
required: false
schema:
type: integer
billing-usage-report-hour:
name: hour
description: If specified, only return results for a single hour. The value
of `hour` is an integer between `0` and `23`. If no `year`, `month`, or `day`
is specified, the default `year`, `month`, and `day` are used.
in: query
required: false
schema:
type: integer
actions-custom-image-definition-id:
name: image_definition_id
description: Image definition ID of custom image
Expand Down
Loading