Skip to content

Commit 2bc8e22

Browse files
authored
Merge pull request #1490 from github/openapi-update-a9352d50add6a21558eb6e72201a4b6f7c51f1bc2f84d90d7323d09e6e983997
Update OpenAPI 3.0 Descriptions
2 parents 9b129de + fff1cbc commit 2bc8e22

28 files changed

+28
-280
lines changed

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

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12236,17 +12236,6 @@
1223612236
}
1223712237
}
1223812238
},
12239-
"302": {
12240-
"description": "Response if requester is not an organization member",
12241-
"headers": {
12242-
"Location": {
12243-
"example": "https://api.github.com/orgs/github/public_members",
12244-
"schema": {
12245-
"type": "string"
12246-
}
12247-
}
12248-
}
12249-
},
1225012239
"422": {
1225112240
"$ref": "#/components/responses/validation_failed"
1225212241
}
@@ -45881,7 +45870,7 @@
4588145870
"/repos/{template_owner}/{template_repo}/generate": {
4588245871
"post": {
4588345872
"summary": "Create a repository using a template",
45884-
"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",
45873+
"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",
4588545874
"tags": [
4588645875
"repos"
4588745876
],

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

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8788,13 +8788,6 @@ paths:
87888788
headers:
87898789
Link:
87908790
"$ref": "#/components/headers/link"
8791-
'302':
8792-
description: Response if requester is not an organization member
8793-
headers:
8794-
Location:
8795-
example: https://api.github.com/orgs/github/public_members
8796-
schema:
8797-
type: string
87988791
'422':
87998792
"$ref": "#/components/responses/validation_failed"
88008793
x-github:
@@ -32808,7 +32801,7 @@ paths:
3280832801
post:
3280932802
summary: Create a repository using a template
3281032803
description: |-
32811-
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`.
32804+
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`.
3281232805

3281332806
**OAuth scope requirements**
3281432807

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

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -84683,17 +84683,6 @@
8468384683
}
8468484684
}
8468584685
},
84686-
"302": {
84687-
"description": "Response if requester is not an organization member",
84688-
"headers": {
84689-
"Location": {
84690-
"example": "https://api.github.com/orgs/github/public_members",
84691-
"schema": {
84692-
"type": "string"
84693-
}
84694-
}
84695-
}
84696-
},
8469784686
"422": {
8469884687
"description": "Validation failed",
8469984688
"content": {
@@ -386998,7 +386987,7 @@
386998386987
"/repos/{template_owner}/{template_repo}/generate": {
386999386988
"post": {
387000386989
"summary": "Create a repository using a template",
387001-
"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",
386990+
"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",
387002386991
"tags": [
387003386992
"repos"
387004386993
],

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

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20964,13 +20964,6 @@ paths:
2096420964
default: *157
2096520965
headers:
2096620966
Link: *28
20967-
'302':
20968-
description: Response if requester is not an organization member
20969-
headers:
20970-
Location:
20971-
example: https://api.github.com/orgs/github/public_members
20972-
schema:
20973-
type: string
2097420967
'422': *10
2097520968
x-github:
2097620969
githubCloudOnly: false
@@ -68066,7 +68059,7 @@ paths:
6806668059
post:
6806768060
summary: Create a repository using a template
6806868061
description: |-
68069-
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`.
68062+
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`.
6807068063

6807168064
**OAuth scope requirements**
6807268065

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

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -80268,17 +80268,6 @@
8026880268
}
8026980269
}
8027080270
},
80271-
"302": {
80272-
"description": "Response if requester is not an organization member",
80273-
"headers": {
80274-
"Location": {
80275-
"example": "https://api.github.com/orgs/github/public_members",
80276-
"schema": {
80277-
"type": "string"
80278-
}
80279-
}
80280-
}
80281-
},
8028280271
"422": {
8028380272
"description": "Validation failed",
8028480273
"content": {
@@ -326819,7 +326808,7 @@
326819326808
"/repos/{template_owner}/{template_repo}/generate": {
326820326809
"post": {
326821326810
"summary": "Create a repository using a template",
326822-
"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",
326811+
"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",
326823326812
"tags": [
326824326813
"repos"
326825326814
],

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

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18263,13 +18263,6 @@ paths:
1826318263
site_admin: false
1826418264
headers:
1826518265
Link: *7
18266-
'302':
18267-
description: Response if requester is not an organization member
18268-
headers:
18269-
Location:
18270-
example: https://api.github.com/orgs/github/public_members
18271-
schema:
18272-
type: string
1827318266
'422': *33
1827418267
x-github:
1827518268
githubCloudOnly: false
@@ -58723,7 +58716,7 @@ paths:
5872358716
post:
5872458717
summary: Create a repository using a template
5872558718
description: |-
58726-
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`.
58719+
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`.
5872758720

5872858721
**OAuth scope requirements**
5872958722

descriptions/ghes-3.2/ghes-3.2.json

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12291,17 +12291,6 @@
1229112291
}
1229212292
}
1229312293
},
12294-
"302": {
12295-
"description": "Response if requester is not an organization member",
12296-
"headers": {
12297-
"Location": {
12298-
"example": "https://api.github.com/orgs/github/public_members",
12299-
"schema": {
12300-
"type": "string"
12301-
}
12302-
}
12303-
}
12304-
},
1230512294
"422": {
1230612295
"$ref": "#/components/responses/validation_failed"
1230712296
}
@@ -40645,7 +40634,7 @@
4064540634
"/repos/{template_owner}/{template_repo}/generate": {
4064640635
"post": {
4064740636
"summary": "Create a repository using a template",
40648-
"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",
40637+
"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",
4064940638
"tags": [
4065040639
"repos"
4065140640
],

descriptions/ghes-3.2/ghes-3.2.yaml

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8794,13 +8794,6 @@ paths:
87948794
headers:
87958795
Link:
87968796
"$ref": "#/components/headers/link"
8797-
'302':
8798-
description: Response if requester is not an organization member
8799-
headers:
8800-
Location:
8801-
example: https://api.github.com/orgs/github/public_members
8802-
schema:
8803-
type: string
88048797
'422':
88058798
"$ref": "#/components/responses/validation_failed"
88068799
x-github:
@@ -29518,7 +29511,7 @@ paths:
2951829511
post:
2951929512
summary: Create a repository using a template
2952029513
description: |-
29521-
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`.
29514+
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`.
2952229515

2952329516
**OAuth scope requirements**
2952429517

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

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -81024,17 +81024,6 @@
8102481024
}
8102581025
}
8102681026
},
81027-
"302": {
81028-
"description": "Response if requester is not an organization member",
81029-
"headers": {
81030-
"Location": {
81031-
"example": "https://api.github.com/orgs/github/public_members",
81032-
"schema": {
81033-
"type": "string"
81034-
}
81035-
}
81036-
}
81037-
},
8103881027
"422": {
8103981028
"description": "Validation failed",
8104081029
"content": {
@@ -329108,7 +329097,7 @@
329108329097
"/repos/{template_owner}/{template_repo}/generate": {
329109329098
"post": {
329110329099
"summary": "Create a repository using a template",
329111-
"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",
329100+
"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",
329112329101
"tags": [
329113329102
"repos"
329114329103
],

0 commit comments

Comments
 (0)