Skip to content

Commit eda17ba

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.0 Descriptions
1 parent b8a14b7 commit eda17ba

40 files changed

Lines changed: 10918 additions & 17690 deletions

‎descriptions/api.github.com/api.github.com.2022-11-28.json‎

Lines changed: 0 additions & 188 deletions
Original file line numberDiff line numberDiff line change
@@ -7711,9 +7711,6 @@
77117711
},
77127712
{
77137713
"$ref": "#/components/parameters/billing-usage-report-day"
7714-
},
7715-
{
7716-
"$ref": "#/components/parameters/billing-usage-report-hour"
77177714
}
77187715
],
77197716
"responses": {
@@ -30363,165 +30360,6 @@
3036330360
"deprecated": true
3036430361
}
3036530362
},
30366-
"/projects/{project_id}/columns": {
30367-
"get": {
30368-
"summary": "List project columns",
30369-
"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.",
30370-
"tags": [
30371-
"projects-classic"
30372-
],
30373-
"operationId": "projects-classic/list-columns",
30374-
"externalDocs": {
30375-
"description": "API method documentation",
30376-
"url": "https://docs.github.com/rest/projects-classic/columns#list-project-columns"
30377-
},
30378-
"parameters": [
30379-
{
30380-
"$ref": "#/components/parameters/project-id"
30381-
},
30382-
{
30383-
"$ref": "#/components/parameters/per-page"
30384-
},
30385-
{
30386-
"$ref": "#/components/parameters/page"
30387-
}
30388-
],
30389-
"responses": {
30390-
"200": {
30391-
"description": "Response",
30392-
"content": {
30393-
"application/json": {
30394-
"schema": {
30395-
"type": "array",
30396-
"items": {
30397-
"$ref": "#/components/schemas/project-column"
30398-
}
30399-
},
30400-
"examples": {
30401-
"default": {
30402-
"$ref": "#/components/examples/project-column-items"
30403-
}
30404-
}
30405-
}
30406-
},
30407-
"headers": {
30408-
"Link": {
30409-
"$ref": "#/components/headers/link"
30410-
}
30411-
}
30412-
},
30413-
"304": {
30414-
"$ref": "#/components/responses/not_modified"
30415-
},
30416-
"403": {
30417-
"$ref": "#/components/responses/forbidden"
30418-
},
30419-
"401": {
30420-
"$ref": "#/components/responses/requires_authentication"
30421-
}
30422-
},
30423-
"x-github": {
30424-
"githubCloudOnly": false,
30425-
"enabledForGitHubApps": true,
30426-
"category": "projects-classic",
30427-
"subcategory": "columns",
30428-
"deprecationDate": "2024-05-23",
30429-
"removalDate": "2025-04-01"
30430-
},
30431-
"deprecated": true
30432-
},
30433-
"post": {
30434-
"summary": "Create a project column",
30435-
"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.",
30436-
"tags": [
30437-
"projects-classic"
30438-
],
30439-
"operationId": "projects-classic/create-column",
30440-
"externalDocs": {
30441-
"description": "API method documentation",
30442-
"url": "https://docs.github.com/rest/projects-classic/columns#create-a-project-column"
30443-
},
30444-
"parameters": [
30445-
{
30446-
"$ref": "#/components/parameters/project-id"
30447-
}
30448-
],
30449-
"requestBody": {
30450-
"required": true,
30451-
"content": {
30452-
"application/json": {
30453-
"schema": {
30454-
"properties": {
30455-
"name": {
30456-
"description": "Name of the project column",
30457-
"example": "Remaining tasks",
30458-
"type": "string"
30459-
}
30460-
},
30461-
"required": [
30462-
"name"
30463-
],
30464-
"type": "object"
30465-
},
30466-
"examples": {
30467-
"default": {
30468-
"value": {
30469-
"name": "Remaining tasks"
30470-
}
30471-
}
30472-
}
30473-
}
30474-
}
30475-
},
30476-
"responses": {
30477-
"201": {
30478-
"description": "Response",
30479-
"content": {
30480-
"application/json": {
30481-
"schema": {
30482-
"$ref": "#/components/schemas/project-column"
30483-
},
30484-
"examples": {
30485-
"default": {
30486-
"value": {
30487-
"url": "https://api.github.com/projects/columns/367",
30488-
"project_url": "https://api.github.com/projects/120",
30489-
"cards_url": "https://api.github.com/projects/columns/367/cards",
30490-
"id": 367,
30491-
"node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=",
30492-
"name": "To Do",
30493-
"created_at": "2016-09-05T14:18:44Z",
30494-
"updated_at": "2016-09-05T14:22:28Z"
30495-
}
30496-
}
30497-
}
30498-
}
30499-
}
30500-
},
30501-
"304": {
30502-
"$ref": "#/components/responses/not_modified"
30503-
},
30504-
"403": {
30505-
"$ref": "#/components/responses/forbidden"
30506-
},
30507-
"422": {
30508-
"$ref": "#/components/responses/validation_failed_simple"
30509-
},
30510-
"401": {
30511-
"$ref": "#/components/responses/requires_authentication"
30512-
}
30513-
},
30514-
"x-github": {
30515-
"githubCloudOnly": false,
30516-
"enabledForGitHubApps": true,
30517-
"category": "projects-classic",
30518-
"subcategory": "columns",
30519-
"deprecationDate": "2024-05-23",
30520-
"removalDate": "2025-04-01"
30521-
},
30522-
"deprecated": true
30523-
}
30524-
},
3052530363
"/rate_limit": {
3052630364
"get": {
3052730365
"summary": "Get rate limit status for the authenticated user",
@@ -76494,9 +76332,6 @@
7649476332
},
7649576333
{
7649676334
"$ref": "#/components/parameters/billing-usage-report-day"
76497-
},
76498-
{
76499-
"$ref": "#/components/parameters/billing-usage-report-hour"
7650076335
}
7650176336
],
7650276337
"responses": {
@@ -289202,20 +289037,6 @@
289202289037
}
289203289038
}
289204289039
},
289205-
"project-column-items": {
289206-
"value": [
289207-
{
289208-
"url": "https://api.github.com/projects/columns/367",
289209-
"project_url": "https://api.github.com/projects/120",
289210-
"cards_url": "https://api.github.com/projects/columns/367/cards",
289211-
"id": 367,
289212-
"node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=",
289213-
"name": "To Do",
289214-
"created_at": "2016-09-05T14:18:44Z",
289215-
"updated_at": "2016-09-05T14:22:28Z"
289216-
}
289217-
]
289218-
},
289219289040
"rate-limit-overview": {
289220289041
"value": {
289221289042
"resources": {
@@ -309267,15 +309088,6 @@
309267309088
"type": "integer"
309268309089
}
309269309090
},
309270-
"billing-usage-report-hour": {
309271-
"name": "hour",
309272-
"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.",
309273-
"in": "query",
309274-
"required": false,
309275-
"schema": {
309276-
"type": "integer"
309277-
}
309278-
},
309279309091
"actions-custom-image-definition-id": {
309280309092
"name": "image_definition_id",
309281309093
"description": "Image definition ID of custom image",

‎descriptions/api.github.com/api.github.com.2022-11-28.yaml‎

Lines changed: 0 additions & 132 deletions
Original file line numberDiff line numberDiff line change
@@ -5436,7 +5436,6 @@ paths:
54365436
- "$ref": "#/components/parameters/billing-usage-report-year"
54375437
- "$ref": "#/components/parameters/billing-usage-report-month"
54385438
- "$ref": "#/components/parameters/billing-usage-report-day"
5439-
- "$ref": "#/components/parameters/billing-usage-report-hour"
54405439
responses:
54415440
'200':
54425441
"$ref": "#/components/responses/billing_usage_report_org"
@@ -21939,117 +21938,6 @@ paths:
2193921938
deprecationDate: '2024-05-23'
2194021939
removalDate: '2025-04-01'
2194121940
deprecated: true
21942-
"/projects/{project_id}/columns":
21943-
get:
21944-
summary: List project columns
21945-
description: |-
21946-
> [!WARNING]
21947-
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
21948-
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
21949-
tags:
21950-
- projects-classic
21951-
operationId: projects-classic/list-columns
21952-
externalDocs:
21953-
description: API method documentation
21954-
url: https://docs.github.com/rest/projects-classic/columns#list-project-columns
21955-
parameters:
21956-
- "$ref": "#/components/parameters/project-id"
21957-
- "$ref": "#/components/parameters/per-page"
21958-
- "$ref": "#/components/parameters/page"
21959-
responses:
21960-
'200':
21961-
description: Response
21962-
content:
21963-
application/json:
21964-
schema:
21965-
type: array
21966-
items:
21967-
"$ref": "#/components/schemas/project-column"
21968-
examples:
21969-
default:
21970-
"$ref": "#/components/examples/project-column-items"
21971-
headers:
21972-
Link:
21973-
"$ref": "#/components/headers/link"
21974-
'304':
21975-
"$ref": "#/components/responses/not_modified"
21976-
'403':
21977-
"$ref": "#/components/responses/forbidden"
21978-
'401':
21979-
"$ref": "#/components/responses/requires_authentication"
21980-
x-github:
21981-
githubCloudOnly: false
21982-
enabledForGitHubApps: true
21983-
category: projects-classic
21984-
subcategory: columns
21985-
deprecationDate: '2024-05-23'
21986-
removalDate: '2025-04-01'
21987-
deprecated: true
21988-
post:
21989-
summary: Create a project column
21990-
description: |-
21991-
> [!WARNING]
21992-
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
21993-
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
21994-
tags:
21995-
- projects-classic
21996-
operationId: projects-classic/create-column
21997-
externalDocs:
21998-
description: API method documentation
21999-
url: https://docs.github.com/rest/projects-classic/columns#create-a-project-column
22000-
parameters:
22001-
- "$ref": "#/components/parameters/project-id"
22002-
requestBody:
22003-
required: true
22004-
content:
22005-
application/json:
22006-
schema:
22007-
properties:
22008-
name:
22009-
description: Name of the project column
22010-
example: Remaining tasks
22011-
type: string
22012-
required:
22013-
- name
22014-
type: object
22015-
examples:
22016-
default:
22017-
value:
22018-
name: Remaining tasks
22019-
responses:
22020-
'201':
22021-
description: Response
22022-
content:
22023-
application/json:
22024-
schema:
22025-
"$ref": "#/components/schemas/project-column"
22026-
examples:
22027-
default:
22028-
value:
22029-
url: https://api.github.com/projects/columns/367
22030-
project_url: https://api.github.com/projects/120
22031-
cards_url: https://api.github.com/projects/columns/367/cards
22032-
id: 367
22033-
node_id: MDEzOlByb2plY3RDb2x1bW4zNjc=
22034-
name: To Do
22035-
created_at: '2016-09-05T14:18:44Z'
22036-
updated_at: '2016-09-05T14:22:28Z'
22037-
'304':
22038-
"$ref": "#/components/responses/not_modified"
22039-
'403':
22040-
"$ref": "#/components/responses/forbidden"
22041-
'422':
22042-
"$ref": "#/components/responses/validation_failed_simple"
22043-
'401':
22044-
"$ref": "#/components/responses/requires_authentication"
22045-
x-github:
22046-
githubCloudOnly: false
22047-
enabledForGitHubApps: true
22048-
category: projects-classic
22049-
subcategory: columns
22050-
deprecationDate: '2024-05-23'
22051-
removalDate: '2025-04-01'
22052-
deprecated: true
2205321941
"/rate_limit":
2205421942
get:
2205521943
summary: Get rate limit status for the authenticated user
@@ -55369,7 +55257,6 @@ paths:
5536955257
- "$ref": "#/components/parameters/billing-usage-report-year"
5537055258
- "$ref": "#/components/parameters/billing-usage-report-month"
5537155259
- "$ref": "#/components/parameters/billing-usage-report-day"
55372-
- "$ref": "#/components/parameters/billing-usage-report-hour"
5537355260
responses:
5537455261
'200':
5537555262
"$ref": "#/components/responses/billing_usage_report_user"
@@ -217409,16 +217296,6 @@ components:
217409217296
received_events_url: https://api.github.com/users/octocat/received_events
217410217297
type: User
217411217298
site_admin: false
217412-
project-column-items:
217413-
value:
217414-
- url: https://api.github.com/projects/columns/367
217415-
project_url: https://api.github.com/projects/120
217416-
cards_url: https://api.github.com/projects/columns/367/cards
217417-
id: 367
217418-
node_id: MDEzOlByb2plY3RDb2x1bW4zNjc=
217419-
name: To Do
217420-
created_at: '2016-09-05T14:18:44Z'
217421-
updated_at: '2016-09-05T14:22:28Z'
217422217299
rate-limit-overview:
217423217300
value:
217424217301
resources:
@@ -234759,15 +234636,6 @@ components:
234759234636
required: false
234760234637
schema:
234761234638
type: integer
234762-
billing-usage-report-hour:
234763-
name: hour
234764-
description: If specified, only return results for a single hour. The value
234765-
of `hour` is an integer between `0` and `23`. If no `year`, `month`, or `day`
234766-
is specified, the default `year`, `month`, and `day` are used.
234767-
in: query
234768-
required: false
234769-
schema:
234770-
type: integer
234771234639
actions-custom-image-definition-id:
234772234640
name: image_definition_id
234773234641
description: Image definition ID of custom image

0 commit comments

Comments
 (0)