Skip to content

Commit 9b129de

Browse files
authored
Merge pull request #1491 from github/openapi-update-0ac12798506235915a530cbf4d3439ea3a199d747d6bb5c3a6704a81b1eba3d6
Update OpenAPI 3.1 Descriptions
2 parents 0367a14 + 34e185d commit 9b129de

28 files changed

+28
-280
lines changed

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

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12292,17 +12292,6 @@
1229212292
}
1229312293
}
1229412294
},
12295-
"302": {
12296-
"description": "Response if requester is not an organization member",
12297-
"headers": {
12298-
"Location": {
12299-
"example": "https://api.github.com/orgs/github/public_members",
12300-
"schema": {
12301-
"type": "string"
12302-
}
12303-
}
12304-
}
12305-
},
1230612295
"422": {
1230712296
"$ref": "#/components/responses/validation_failed"
1230812297
}
@@ -46133,7 +46122,7 @@
4613346122
"/repos/{template_owner}/{template_repo}/generate": {
4613446123
"post": {
4613546124
"summary": "Create a repository using a template",
46136-
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
46125+
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
4613746126
"tags": [
4613846127
"repos"
4613946128
],

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

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8814,13 +8814,6 @@ paths:
88148814
headers:
88158815
Link:
88168816
"$ref": "#/components/headers/link"
8817-
'302':
8818-
description: Response if requester is not an organization member
8819-
headers:
8820-
Location:
8821-
example: https://api.github.com/orgs/github/public_members
8822-
schema:
8823-
type: string
88248817
'422':
88258818
"$ref": "#/components/responses/validation_failed"
88268819
x-github:
@@ -32934,7 +32927,7 @@ paths:
3293432927
post:
3293532928
summary: Create a repository using a template
3293632929
description: |-
32937-
Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.
32930+
Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.
3293832931

3293932932
**OAuth scope requirements**
3294032933

descriptions-next/api.github.com/dereferenced/api.github.com.deref.json

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -98604,17 +98604,6 @@
9860498604
}
9860598605
}
9860698606
},
98607-
"302": {
98608-
"description": "Response if requester is not an organization member",
98609-
"headers": {
98610-
"Location": {
98611-
"example": "https://api.github.com/orgs/github/public_members",
98612-
"schema": {
98613-
"type": "string"
98614-
}
98615-
}
98616-
}
98617-
},
9861898607
"422": {
9861998608
"description": "Validation failed",
9862098609
"content": {
@@ -460634,7 +460623,7 @@
460634460623
"/repos/{template_owner}/{template_repo}/generate": {
460635460624
"post": {
460636460625
"summary": "Create a repository using a template",
460637-
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
460626+
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
460638460627
"tags": [
460639460628
"repos"
460640460629
],

descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21597,13 +21597,6 @@ paths:
2159721597
default: *151
2159821598
headers:
2159921599
Link: *26
21600-
'302':
21601-
description: Response if requester is not an organization member
21602-
headers:
21603-
Location:
21604-
example: https://api.github.com/orgs/github/public_members
21605-
schema:
21606-
type: string
2160721600
'422': *10
2160821601
x-github:
2160921602
githubCloudOnly: false
@@ -69656,7 +69649,7 @@ paths:
6965669649
post:
6965769650
summary: Create a repository using a template
6965869651
description: |-
69659-
Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.
69652+
Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.
6966069653

6966169654
**OAuth scope requirements**
6966269655

descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.json

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -93619,17 +93619,6 @@
9361993619
}
9362093620
}
9362193621
},
93622-
"302": {
93623-
"description": "Response if requester is not an organization member",
93624-
"headers": {
93625-
"Location": {
93626-
"example": "https://api.github.com/orgs/github/public_members",
93627-
"schema": {
93628-
"type": "string"
93629-
}
93630-
}
93631-
}
93632-
},
9363393622
"422": {
9363493623
"description": "Validation failed",
9363593624
"content": {
@@ -389733,7 +389722,7 @@
389733389722
"/repos/{template_owner}/{template_repo}/generate": {
389734389723
"post": {
389735389724
"summary": "Create a repository using a template",
389736-
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/[email protected]/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/[email protected]/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
389725+
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/[email protected]/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/[email protected]/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
389737389726
"tags": [
389738389727
"repos"
389739389728
],

descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.yaml

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18759,13 +18759,6 @@ paths:
1875918759
site_admin: false
1876018760
headers:
1876118761
Link: *7
18762-
'302':
18763-
description: Response if requester is not an organization member
18764-
headers:
18765-
Location:
18766-
example: https://api.github.com/orgs/github/public_members
18767-
schema:
18768-
type: string
1876918762
'422': *31
1877018763
x-github:
1877118764
githubCloudOnly: false
@@ -60019,7 +60012,7 @@ paths:
6001960012
post:
6002060013
summary: Create a repository using a template
6002160014
description: |-
60022-
Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/[email protected]/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.
60015+
Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/[email protected]/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.
6002360016

6002460017
**OAuth scope requirements**
6002560018

descriptions-next/ghes-3.2/ghes-3.2.json

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12360,17 +12360,6 @@
1236012360
}
1236112361
}
1236212362
},
12363-
"302": {
12364-
"description": "Response if requester is not an organization member",
12365-
"headers": {
12366-
"Location": {
12367-
"example": "https://api.github.com/orgs/github/public_members",
12368-
"schema": {
12369-
"type": "string"
12370-
}
12371-
}
12372-
}
12373-
},
1237412363
"422": {
1237512364
"$ref": "#/components/responses/validation_failed"
1237612365
}
@@ -40876,7 +40865,7 @@
4087640865
"/repos/{template_owner}/{template_repo}/generate": {
4087740866
"post": {
4087840867
"summary": "Create a repository using a template",
40879-
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/[email protected]/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/[email protected]/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
40868+
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/[email protected]/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/[email protected]/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
4088040869
"tags": [
4088140870
"repos"
4088240871
],

descriptions-next/ghes-3.2/ghes-3.2.yaml

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8825,13 +8825,6 @@ paths:
88258825
headers:
88268826
Link:
88278827
"$ref": "#/components/headers/link"
8828-
'302':
8829-
description: Response if requester is not an organization member
8830-
headers:
8831-
Location:
8832-
example: https://api.github.com/orgs/github/public_members
8833-
schema:
8834-
type: string
88358828
'422':
88368829
"$ref": "#/components/responses/validation_failed"
88378830
x-github:
@@ -29632,7 +29625,7 @@ paths:
2963229625
post:
2963329626
summary: Create a repository using a template
2963429627
description: |-
29635-
Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/[email protected]/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.
29628+
Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/[email protected]/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.
2963629629

2963729630
**OAuth scope requirements**
2963829631

descriptions-next/ghes-3.3/dereferenced/ghes-3.3.deref.json

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -94407,17 +94407,6 @@
9440794407
}
9440894408
}
9440994409
},
94410-
"302": {
94411-
"description": "Response if requester is not an organization member",
94412-
"headers": {
94413-
"Location": {
94414-
"example": "https://api.github.com/orgs/github/public_members",
94415-
"schema": {
94416-
"type": "string"
94417-
}
94418-
}
94419-
}
94420-
},
9442194410
"422": {
9442294411
"description": "Validation failed",
9442394412
"content": {
@@ -392420,7 +392409,7 @@
392420392409
"/repos/{template_owner}/{template_repo}/generate": {
392421392410
"post": {
392422392411
"summary": "Create a repository using a template",
392423-
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/[email protected]/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/[email protected]/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
392412+
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/[email protected]/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/[email protected]/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
392424392413
"tags": [
392425392414
"repos"
392426392415
],

0 commit comments

Comments
 (0)