Skip to content

Commit 8ddf529

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.1 Descriptions
1 parent fb63e80 commit 8ddf529

16 files changed

+2484
-608
lines changed

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

Lines changed: 170 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -25374,42 +25374,97 @@
2537425374
],
2537525375
"requestBody": {
2537625376
"required": true,
25377-
"description": "Details of the item to add to the project.",
25377+
"description": "Details of the item to add to the project. You can specify either the database ID or the repository owner, name, and issue/PR number.",
2537825378
"content": {
2537925379
"application/json": {
2538025380
"schema": {
25381-
"type": "object",
25382-
"properties": {
25383-
"type": {
25384-
"type": "string",
25385-
"enum": [
25386-
"Issue",
25387-
"PullRequest"
25388-
],
25389-
"description": "The type of item to add to the project. Must be either Issue or PullRequest."
25381+
"oneOf": [
25382+
{
25383+
"type": "object",
25384+
"properties": {
25385+
"type": {
25386+
"type": "string",
25387+
"enum": [
25388+
"Issue",
25389+
"PullRequest"
25390+
],
25391+
"description": "The type of item to add to the project. Must be either Issue or PullRequest."
25392+
},
25393+
"id": {
25394+
"type": "integer",
25395+
"description": "The unique ID of the issue or pull request to add to the project."
25396+
}
25397+
},
25398+
"required": [
25399+
"type",
25400+
"id"
25401+
]
2539025402
},
25391-
"id": {
25392-
"type": "integer",
25393-
"description": "The numeric ID of the issue or pull request to add to the project."
25403+
{
25404+
"type": "object",
25405+
"properties": {
25406+
"type": {
25407+
"type": "string",
25408+
"enum": [
25409+
"Issue",
25410+
"PullRequest"
25411+
],
25412+
"description": "The type of item to add to the project. Must be either Issue or PullRequest."
25413+
},
25414+
"owner": {
25415+
"type": "string",
25416+
"description": "The repository owner login."
25417+
},
25418+
"repo": {
25419+
"type": "string",
25420+
"description": "The repository name."
25421+
},
25422+
"number": {
25423+
"type": "integer",
25424+
"description": "The issue or pull request number."
25425+
}
25426+
},
25427+
"required": [
25428+
"type",
25429+
"owner",
25430+
"repo",
25431+
"number"
25432+
]
2539425433
}
25395-
},
25396-
"required": [
25397-
"type",
25398-
"id"
2539925434
]
2540025435
},
2540125436
"examples": {
25402-
"issue": {
25437+
"issue-with-id": {
25438+
"summary": "Add issue by database ID",
2540325439
"value": {
2540425440
"type": "Issue",
2540525441
"id": 3
2540625442
}
2540725443
},
25408-
"pull_request": {
25444+
"pull_request-with-id": {
25445+
"summary": "Add pull request by database ID",
2540925446
"value": {
2541025447
"type": "PullRequest",
2541125448
"id": 3
2541225449
}
25450+
},
25451+
"issue-with-nwo": {
25452+
"summary": "Add issue by repository and number",
25453+
"value": {
25454+
"type": "Issue",
25455+
"owner": "octocat",
25456+
"repo": "hello-world",
25457+
"number": 42
25458+
}
25459+
},
25460+
"pull_request-with-nwo": {
25461+
"summary": "Add pull request by repository and number",
25462+
"value": {
25463+
"type": "PullRequest",
25464+
"owner": "octocat",
25465+
"repo": "hello-world",
25466+
"number": 123
25467+
}
2541325468
}
2541425469
}
2541525470
}
@@ -76126,42 +76181,97 @@
7612676181
],
7612776182
"requestBody": {
7612876183
"required": true,
76129-
"description": "Details of the item to add to the project.",
76184+
"description": "Details of the item to add to the project. You can specify either the database ID or the repository owner, name, and issue/PR number.",
7613076185
"content": {
7613176186
"application/json": {
7613276187
"schema": {
76133-
"type": "object",
76134-
"properties": {
76135-
"type": {
76136-
"type": "string",
76137-
"enum": [
76138-
"Issue",
76139-
"PullRequest"
76140-
],
76141-
"description": "The type of item to add to the project. Must be either Issue or PullRequest."
76188+
"oneOf": [
76189+
{
76190+
"type": "object",
76191+
"properties": {
76192+
"type": {
76193+
"type": "string",
76194+
"enum": [
76195+
"Issue",
76196+
"PullRequest"
76197+
],
76198+
"description": "The type of item to add to the project. Must be either Issue or PullRequest."
76199+
},
76200+
"id": {
76201+
"type": "integer",
76202+
"description": "The unique ID of the issue or pull request to add to the project."
76203+
}
76204+
},
76205+
"required": [
76206+
"type",
76207+
"id"
76208+
]
7614276209
},
76143-
"id": {
76144-
"type": "integer",
76145-
"description": "The numeric ID of the issue or pull request to add to the project."
76210+
{
76211+
"type": "object",
76212+
"properties": {
76213+
"type": {
76214+
"type": "string",
76215+
"enum": [
76216+
"Issue",
76217+
"PullRequest"
76218+
],
76219+
"description": "The type of item to add to the project. Must be either Issue or PullRequest."
76220+
},
76221+
"owner": {
76222+
"type": "string",
76223+
"description": "The repository owner login."
76224+
},
76225+
"repo": {
76226+
"type": "string",
76227+
"description": "The repository name."
76228+
},
76229+
"number": {
76230+
"type": "integer",
76231+
"description": "The issue or pull request number."
76232+
}
76233+
},
76234+
"required": [
76235+
"type",
76236+
"owner",
76237+
"repo",
76238+
"number"
76239+
]
7614676240
}
76147-
},
76148-
"required": [
76149-
"type",
76150-
"id"
7615176241
]
7615276242
},
7615376243
"examples": {
76154-
"issue": {
76244+
"issue-with-id": {
76245+
"summary": "Add issue by database ID",
7615576246
"value": {
7615676247
"type": "Issue",
7615776248
"id": 3
7615876249
}
7615976250
},
76160-
"pull_request": {
76251+
"pull_request-with-id": {
76252+
"summary": "Add pull request by database ID",
7616176253
"value": {
7616276254
"type": "PullRequest",
7616376255
"id": 3
7616476256
}
76257+
},
76258+
"issue-with-nwo": {
76259+
"summary": "Add issue by repository and number",
76260+
"value": {
76261+
"type": "Issue",
76262+
"owner": "octocat",
76263+
"repo": "hello-world",
76264+
"number": 42
76265+
}
76266+
},
76267+
"pull_request-with-nwo": {
76268+
"summary": "Add pull request by repository and number",
76269+
"value": {
76270+
"type": "PullRequest",
76271+
"owner": "octocat",
76272+
"repo": "hello-world",
76273+
"number": 123
76274+
}
7616576275
}
7616676276
}
7616776277
}
@@ -296146,6 +296256,11 @@
296146296256
"state": "active",
296147296257
"role": "admin",
296148296258
"organization_url": "https://api.github.com/orgs/octocat",
296259+
"direct_membership": true,
296260+
"enterprise_teams_providing_indirect_membership": [
296261+
"ent:justice-league",
296262+
"ent:security-managers"
296263+
],
296149296264
"organization": {
296150296265
"login": "github",
296151296266
"id": 1,
@@ -316780,6 +316895,8 @@
316780316895
"state": "active",
316781316896
"role": "admin",
316782316897
"organization_url": "https://api.github.com/orgs/octocat",
316898+
"direct_membership": true,
316899+
"enterprise_teams_providing_indirect_membership": [],
316783316900
"organization": {
316784316901
"login": "github",
316785316902
"id": 1,
@@ -316820,6 +316937,11 @@
316820316937
"state": "pending",
316821316938
"role": "admin",
316822316939
"organization_url": "https://api.github.com/orgs/invitocat",
316940+
"direct_membership": false,
316941+
"enterprise_teams_providing_indirect_membership": [
316942+
"ent:justice-league",
316943+
"ent:security-managers"
316944+
],
316823316945
"organization": {
316824316946
"login": "github",
316825316947
"id": 1,
@@ -316863,6 +316985,11 @@
316863316985
"state": "pending",
316864316986
"role": "admin",
316865316987
"organization_url": "https://api.github.com/orgs/invitocat",
316988+
"direct_membership": true,
316989+
"enterprise_teams_providing_indirect_membership": [
316990+
"ent:justice-league",
316991+
"ent:security-managers"
316992+
],
316866316993
"organization": {
316867316994
"login": "github",
316868316995
"id": 1,
@@ -316905,6 +317032,11 @@
316905317032
"state": "active",
316906317033
"role": "admin",
316907317034
"organization_url": "https://api.github.com/orgs/octocat",
317035+
"direct_membership": true,
317036+
"enterprise_teams_providing_indirect_membership": [
317037+
"ent:justice-league",
317038+
"ent:security-managers"
317039+
],
316908317040
"organization": {
316909317041
"login": "github",
316910317042
"id": 1,

0 commit comments

Comments
 (0)