Skip to content

Commit 1b11ba7

Browse files
dinonuggies1dinonuggies1
authored
Merge pull request #1673 from github/openapi-update-f24860d57df608b5132ab6e8755872df2c0d2d4c6fc92268dcc49ea9a8d14409
Update OpenAPI 3.1 Descriptions
2 parents cb149a3 + 17cd702 commit 1b11ba7

32 files changed

Lines changed: 5907 additions & 3320 deletions

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

Lines changed: 122 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19379,6 +19379,15 @@
1937919379
},
1938019380
{
1938119381
"$ref": "#/components/parameters/page"
19382+
},
19383+
{
19384+
"name": "name",
19385+
"description": "Filters artifacts by exact match on their name field.",
19386+
"in": "query",
19387+
"required": false,
19388+
"schema": {
19389+
"type": "string"
19390+
}
1938219391
}
1938319392
],
1938419393
"responses": {
@@ -58447,6 +58456,14 @@
5844758456
"write"
5844858457
]
5844958458
},
58459+
"repository_announcement_banners": {
58460+
"type": "string",
58461+
"description": "The level of permission to grant the access token to view and manage announcement banners for a repository.",
58462+
"enum": [
58463+
"read",
58464+
"write"
58465+
]
58466+
},
5845058467
"repository_hooks": {
5845158468
"type": "string",
5845258469
"description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.",
@@ -58543,6 +58560,14 @@
5854358560
"write"
5854458561
]
5854558562
},
58563+
"organization_announcement_banners": {
58564+
"type": "string",
58565+
"description": "The level of permission to grant the access token to view and manage announcement banners for an organization.",
58566+
"enum": [
58567+
"read",
58568+
"write"
58569+
]
58570+
},
5854658571
"organization_hooks": {
5854758572
"type": "string",
5854858573
"description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.",
@@ -86930,22 +86955,116 @@
8693086955
"$ref": "#/components/schemas/simple-installation"
8693186956
},
8693286957
"merge_group": {
86958+
"title": "MergeGroup",
8693386959
"type": "object",
8693486960
"properties": {
86935-
"base_ref": {
86961+
"head_sha": {
86962+
"description": "The SHA of the merge group.",
8693686963
"type": "string"
8693786964
},
8693886965
"head_ref": {
86966+
"description": "The full ref of the merge group.",
8693986967
"type": "string"
8694086968
},
86941-
"head_sha": {
86969+
"base_sha": {
86970+
"description": "The SHA of the merge group's parent commit.",
8694286971
"type": "string"
86972+
},
86973+
"base_ref": {
86974+
"description": "The full ref of the branch the merge group will be merged into.",
86975+
"type": "string"
86976+
},
86977+
"head_commit": {
86978+
"title": "SimpleCommit",
86979+
"type": "object",
86980+
"properties": {
86981+
"author": {
86982+
"title": "Committer",
86983+
"description": "Metaproperties for Git author/committer information.",
86984+
"type": "object",
86985+
"properties": {
86986+
"date": {
86987+
"type": "string",
86988+
"format": "date-time"
86989+
},
86990+
"email": {
86991+
"type": [
86992+
"string",
86993+
"null"
86994+
],
86995+
"format": "email"
86996+
},
86997+
"name": {
86998+
"description": "The git author's name.",
86999+
"type": "string"
87000+
},
87001+
"username": {
87002+
"type": "string"
87003+
}
87004+
},
87005+
"required": [
87006+
"email",
87007+
"name"
87008+
]
87009+
},
87010+
"committer": {
87011+
"title": "Committer",
87012+
"description": "Metaproperties for Git author/committer information.",
87013+
"type": "object",
87014+
"properties": {
87015+
"date": {
87016+
"type": "string",
87017+
"format": "date-time"
87018+
},
87019+
"email": {
87020+
"type": [
87021+
"string",
87022+
"null"
87023+
],
87024+
"format": "email"
87025+
},
87026+
"name": {
87027+
"description": "The git author's name.",
87028+
"type": "string"
87029+
},
87030+
"username": {
87031+
"type": "string"
87032+
}
87033+
},
87034+
"required": [
87035+
"email",
87036+
"name"
87037+
]
87038+
},
87039+
"id": {
87040+
"type": "string"
87041+
},
87042+
"message": {
87043+
"type": "string"
87044+
},
87045+
"timestamp": {
87046+
"type": "string"
87047+
},
87048+
"tree_id": {
87049+
"type": "string"
87050+
}
87051+
},
87052+
"required": [
87053+
"id",
87054+
"tree_id",
87055+
"message",
87056+
"timestamp",
87057+
"author",
87058+
"committer"
87059+
]
8694387060
}
8694487061
},
8694587062
"required": [
8694687063
"head_sha",
8694787064
"head_ref",
86948-
"base_ref"
87065+
"base_sha",
87066+
"base_ref",
87067+
"head_commit"
8694987068
]
8695087069
},
8695187070
"organization": {

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

Lines changed: 93 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13989,6 +13989,12 @@ paths:
1398913989
- "$ref": "#/components/parameters/repo"
1399013990
- "$ref": "#/components/parameters/per-page"
1399113991
- "$ref": "#/components/parameters/page"
13992+
- name: name
13993+
description: Filters artifacts by exact match on their name field.
13994+
in: query
13995+
required: false
13996+
schema:
13997+
type: string
1399213998
responses:
1399313999
'200':
1399414000
description: Response
@@ -42065,6 +42071,13 @@ components:
4206542071
enum:
4206642072
- read
4206742073
- write
42074+
repository_announcement_banners:
42075+
type: string
42076+
description: The level of permission to grant the access token to view and
42077+
manage announcement banners for a repository.
42078+
enum:
42079+
- read
42080+
- write
4206842081
repository_hooks:
4206942082
type: string
4207042083
description: The level of permission to grant the access token to manage
@@ -42149,6 +42162,13 @@ components:
4214942162
enum:
4215042163
- read
4215142164
- write
42165+
organization_announcement_banners:
42166+
type: string
42167+
description: The level of permission to grant the access token to view and
42168+
manage announcement banners for an organization.
42169+
enum:
42170+
- read
42171+
- write
4215242172
organization_hooks:
4215342173
type: string
4215442174
description: The level of permission to grant the access token to manage
@@ -62577,18 +62597,89 @@ components:
6257762597
installation:
6257862598
"$ref": "#/components/schemas/simple-installation"
6257962599
merge_group:
62600+
title: MergeGroup
6258062601
type: object
6258162602
properties:
62582-
base_ref:
62603+
head_sha:
62604+
description: The SHA of the merge group.
6258362605
type: string
6258462606
head_ref:
62607+
description: The full ref of the merge group.
6258562608
type: string
62586-
head_sha:
62609+
base_sha:
62610+
description: The SHA of the merge group's parent commit.
62611+
type: string
62612+
base_ref:
62613+
description: The full ref of the branch the merge group will be merged
62614+
into.
6258762615
type: string
62616+
head_commit:
62617+
title: SimpleCommit
62618+
type: object
62619+
properties:
62620+
author:
62621+
title: Committer
62622+
description: Metaproperties for Git author/committer information.
62623+
type: object
62624+
properties:
62625+
date:
62626+
type: string
62627+
format: date-time
62628+
email:
62629+
type:
62630+
- string
62631+
- 'null'
62632+
format: email
62633+
name:
62634+
description: The git author's name.
62635+
type: string
62636+
username:
62637+
type: string
62638+
required:
62639+
- email
62640+
- name
62641+
committer:
62642+
title: Committer
62643+
description: Metaproperties for Git author/committer information.
62644+
type: object
62645+
properties:
62646+
date:
62647+
type: string
62648+
format: date-time
62649+
email:
62650+
type:
62651+
- string
62652+
- 'null'
62653+
format: email
62654+
name:
62655+
description: The git author's name.
62656+
type: string
62657+
username:
62658+
type: string
62659+
required:
62660+
- email
62661+
- name
62662+
id:
62663+
type: string
62664+
message:
62665+
type: string
62666+
timestamp:
62667+
type: string
62668+
tree_id:
62669+
type: string
62670+
required:
62671+
- id
62672+
- tree_id
62673+
- message
62674+
- timestamp
62675+
- author
62676+
- committer
6258862677
required:
6258962678
- head_sha
6259062679
- head_ref
62680+
- base_sha
6259162681
- base_ref
62682+
- head_commit
6259262683
organization:
6259362684
"$ref": "#/components/schemas/organization-simple"
6259462685
repository:

0 commit comments

Comments
 (0)