Skip to content

Commit cb149a3

Browse files
dinonuggies1dinonuggies1
authored
Merge pull request #1672 from github/openapi-update-8eab15ece2e4176645b0bafd7457ee53bb690bfce8b274c88bc3b5fb833db3cb
Update OpenAPI 3.0 Descriptions
2 parents ea6d0e9 + 1d17ce1 commit cb149a3

32 files changed

Lines changed: 5806 additions & 3405 deletions

‎descriptions/api.github.com/api.github.com.json‎

Lines changed: 118 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19267,6 +19267,15 @@
1926719267
},
1926819268
{
1926919269
"$ref": "#/components/parameters/page"
19270+
},
19271+
{
19272+
"name": "name",
19273+
"description": "Filters artifacts by exact match on their name field.",
19274+
"in": "query",
19275+
"required": false,
19276+
"schema": {
19277+
"type": "string"
19278+
}
1927019279
}
1927119280
],
1927219281
"responses": {
@@ -58047,6 +58056,14 @@
5804758056
"write"
5804858057
]
5804958058
},
58059+
"repository_announcement_banners": {
58060+
"type": "string",
58061+
"description": "The level of permission to grant the access token to view and manage announcement banners for a repository.",
58062+
"enum": [
58063+
"read",
58064+
"write"
58065+
]
58066+
},
5805058067
"repository_hooks": {
5805158068
"type": "string",
5805258069
"description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.",
@@ -58143,6 +58160,14 @@
5814358160
"write"
5814458161
]
5814558162
},
58163+
"organization_announcement_banners": {
58164+
"type": "string",
58165+
"description": "The level of permission to grant the access token to view and manage announcement banners for an organization.",
58166+
"enum": [
58167+
"read",
58168+
"write"
58169+
]
58170+
},
5814658171
"organization_hooks": {
5814758172
"type": "string",
5814858173
"description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.",
@@ -84151,22 +84176,112 @@
8415184176
"$ref": "#/components/schemas/simple-installation"
8415284177
},
8415384178
"merge_group": {
84179+
"title": "MergeGroup",
8415484180
"type": "object",
8415584181
"properties": {
84156-
"base_ref": {
84182+
"head_sha": {
84183+
"description": "The SHA of the merge group.",
8415784184
"type": "string"
8415884185
},
8415984186
"head_ref": {
84187+
"description": "The full ref of the merge group.",
8416084188
"type": "string"
8416184189
},
84162-
"head_sha": {
84190+
"base_sha": {
84191+
"description": "The SHA of the merge group's parent commit.",
84192+
"type": "string"
84193+
},
84194+
"base_ref": {
84195+
"description": "The full ref of the branch the merge group will be merged into.",
8416384196
"type": "string"
84197+
},
84198+
"head_commit": {
84199+
"title": "SimpleCommit",
84200+
"type": "object",
84201+
"properties": {
84202+
"author": {
84203+
"title": "Committer",
84204+
"description": "Metaproperties for Git author/committer information.",
84205+
"type": "object",
84206+
"properties": {
84207+
"date": {
84208+
"type": "string",
84209+
"format": "date-time"
84210+
},
84211+
"email": {
84212+
"type": "string",
84213+
"nullable": true,
84214+
"format": "email"
84215+
},
84216+
"name": {
84217+
"description": "The git author's name.",
84218+
"type": "string"
84219+
},
84220+
"username": {
84221+
"type": "string"
84222+
}
84223+
},
84224+
"required": [
84225+
"email",
84226+
"name"
84227+
]
84228+
},
84229+
"committer": {
84230+
"title": "Committer",
84231+
"description": "Metaproperties for Git author/committer information.",
84232+
"type": "object",
84233+
"properties": {
84234+
"date": {
84235+
"type": "string",
84236+
"format": "date-time"
84237+
},
84238+
"email": {
84239+
"type": "string",
84240+
"nullable": true,
84241+
"format": "email"
84242+
},
84243+
"name": {
84244+
"description": "The git author's name.",
84245+
"type": "string"
84246+
},
84247+
"username": {
84248+
"type": "string"
84249+
}
84250+
},
84251+
"required": [
84252+
"email",
84253+
"name"
84254+
]
84255+
},
84256+
"id": {
84257+
"type": "string"
84258+
},
84259+
"message": {
84260+
"type": "string"
84261+
},
84262+
"timestamp": {
84263+
"type": "string"
84264+
},
84265+
"tree_id": {
84266+
"type": "string"
84267+
}
84268+
},
84269+
"required": [
84270+
"id",
84271+
"tree_id",
84272+
"message",
84273+
"timestamp",
84274+
"author",
84275+
"committer"
84276+
]
8416484277
}
8416584278
},
8416684279
"required": [
8416784280
"head_sha",
8416884281
"head_ref",
84169-
"base_ref"
84282+
"base_sha",
84283+
"base_ref",
84284+
"head_commit"
8417084285
]
8417184286
},
8417284287
"organization": {

‎descriptions/api.github.com/api.github.com.yaml‎

Lines changed: 91 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13936,6 +13936,12 @@ paths:
1393613936
- "$ref": "#/components/parameters/repo"
1393713937
- "$ref": "#/components/parameters/per-page"
1393813938
- "$ref": "#/components/parameters/page"
13939+
- name: name
13940+
description: Filters artifacts by exact match on their name field.
13941+
in: query
13942+
required: false
13943+
schema:
13944+
type: string
1393913945
responses:
1394013946
'200':
1394113947
description: Response
@@ -41903,6 +41909,13 @@ components:
4190341909
enum:
4190441910
- read
4190541911
- write
41912+
repository_announcement_banners:
41913+
type: string
41914+
description: The level of permission to grant the access token to view and
41915+
manage announcement banners for a repository.
41916+
enum:
41917+
- read
41918+
- write
4190641919
repository_hooks:
4190741920
type: string
4190841921
description: The level of permission to grant the access token to manage
@@ -41987,6 +42000,13 @@ components:
4198742000
enum:
4198842001
- read
4198942002
- write
42003+
organization_announcement_banners:
42004+
type: string
42005+
description: The level of permission to grant the access token to view and
42006+
manage announcement banners for an organization.
42007+
enum:
42008+
- read
42009+
- write
4199042010
organization_hooks:
4199142011
type: string
4199242012
description: The level of permission to grant the access token to manage
@@ -62052,18 +62072,87 @@ components:
6205262072
installation:
6205362073
"$ref": "#/components/schemas/simple-installation"
6205462074
merge_group:
62075+
title: MergeGroup
6205562076
type: object
6205662077
properties:
62057-
base_ref:
62078+
head_sha:
62079+
description: The SHA of the merge group.
6205862080
type: string
6205962081
head_ref:
62082+
description: The full ref of the merge group.
6206062083
type: string
62061-
head_sha:
62084+
base_sha:
62085+
description: The SHA of the merge group's parent commit.
62086+
type: string
62087+
base_ref:
62088+
description: The full ref of the branch the merge group will be merged
62089+
into.
6206262090
type: string
62091+
head_commit:
62092+
title: SimpleCommit
62093+
type: object
62094+
properties:
62095+
author:
62096+
title: Committer
62097+
description: Metaproperties for Git author/committer information.
62098+
type: object
62099+
properties:
62100+
date:
62101+
type: string
62102+
format: date-time
62103+
email:
62104+
type: string
62105+
nullable: true
62106+
format: email
62107+
name:
62108+
description: The git author's name.
62109+
type: string
62110+
username:
62111+
type: string
62112+
required:
62113+
- email
62114+
- name
62115+
committer:
62116+
title: Committer
62117+
description: Metaproperties for Git author/committer information.
62118+
type: object
62119+
properties:
62120+
date:
62121+
type: string
62122+
format: date-time
62123+
email:
62124+
type: string
62125+
nullable: true
62126+
format: email
62127+
name:
62128+
description: The git author's name.
62129+
type: string
62130+
username:
62131+
type: string
62132+
required:
62133+
- email
62134+
- name
62135+
id:
62136+
type: string
62137+
message:
62138+
type: string
62139+
timestamp:
62140+
type: string
62141+
tree_id:
62142+
type: string
62143+
required:
62144+
- id
62145+
- tree_id
62146+
- message
62147+
- timestamp
62148+
- author
62149+
- committer
6206362150
required:
6206462151
- head_sha
6206562152
- head_ref
62153+
- base_sha
6206662154
- base_ref
62155+
- head_commit
6206762156
organization:
6206862157
"$ref": "#/components/schemas/organization-simple"
6206962158
repository:

0 commit comments

Comments
 (0)