Skip to content

Commit fed9760

Browse files
dinonuggies1dinonuggies1
authored
Merge pull request #5772 from github/openapi-update-7450246fd70f1e40a8758f61d186affc32f4e8b5b4b811efb5fe5f0ed831b2d6
Update OpenAPI 3.0 Descriptions
2 parents fb63e80 + 0b54ebf commit fed9760

16 files changed

+2484
-608
lines changed

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

Lines changed: 170 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -25232,42 +25232,97 @@
2523225232
],
2523325233
"requestBody": {
2523425234
"required": true,
25235-
"description": "Details of the item to add to the project.",
25235+
"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.",
2523625236
"content": {
2523725237
"application/json": {
2523825238
"schema": {
25239-
"type": "object",
25240-
"properties": {
25241-
"type": {
25242-
"type": "string",
25243-
"enum": [
25244-
"Issue",
25245-
"PullRequest"
25246-
],
25247-
"description": "The type of item to add to the project. Must be either Issue or PullRequest."
25239+
"oneOf": [
25240+
{
25241+
"type": "object",
25242+
"properties": {
25243+
"type": {
25244+
"type": "string",
25245+
"enum": [
25246+
"Issue",
25247+
"PullRequest"
25248+
],
25249+
"description": "The type of item to add to the project. Must be either Issue or PullRequest."
25250+
},
25251+
"id": {
25252+
"type": "integer",
25253+
"description": "The unique ID of the issue or pull request to add to the project."
25254+
}
25255+
},
25256+
"required": [
25257+
"type",
25258+
"id"
25259+
]
2524825260
},
25249-
"id": {
25250-
"type": "integer",
25251-
"description": "The numeric ID of the issue or pull request to add to the project."
25261+
{
25262+
"type": "object",
25263+
"properties": {
25264+
"type": {
25265+
"type": "string",
25266+
"enum": [
25267+
"Issue",
25268+
"PullRequest"
25269+
],
25270+
"description": "The type of item to add to the project. Must be either Issue or PullRequest."
25271+
},
25272+
"owner": {
25273+
"type": "string",
25274+
"description": "The repository owner login."
25275+
},
25276+
"repo": {
25277+
"type": "string",
25278+
"description": "The repository name."
25279+
},
25280+
"number": {
25281+
"type": "integer",
25282+
"description": "The issue or pull request number."
25283+
}
25284+
},
25285+
"required": [
25286+
"type",
25287+
"owner",
25288+
"repo",
25289+
"number"
25290+
]
2525225291
}
25253-
},
25254-
"required": [
25255-
"type",
25256-
"id"
2525725292
]
2525825293
},
2525925294
"examples": {
25260-
"issue": {
25295+
"issue-with-id": {
25296+
"summary": "Add issue by database ID",
2526125297
"value": {
2526225298
"type": "Issue",
2526325299
"id": 3
2526425300
}
2526525301
},
25266-
"pull_request": {
25302+
"pull_request-with-id": {
25303+
"summary": "Add pull request by database ID",
2526725304
"value": {
2526825305
"type": "PullRequest",
2526925306
"id": 3
2527025307
}
25308+
},
25309+
"issue-with-nwo": {
25310+
"summary": "Add issue by repository and number",
25311+
"value": {
25312+
"type": "Issue",
25313+
"owner": "octocat",
25314+
"repo": "hello-world",
25315+
"number": 42
25316+
}
25317+
},
25318+
"pull_request-with-nwo": {
25319+
"summary": "Add pull request by repository and number",
25320+
"value": {
25321+
"type": "PullRequest",
25322+
"owner": "octocat",
25323+
"repo": "hello-world",
25324+
"number": 123
25325+
}
2527125326
}
2527225327
}
2527325328
}
@@ -75743,42 +75798,97 @@
7574375798
],
7574475799
"requestBody": {
7574575800
"required": true,
75746-
"description": "Details of the item to add to the project.",
75801+
"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.",
7574775802
"content": {
7574875803
"application/json": {
7574975804
"schema": {
75750-
"type": "object",
75751-
"properties": {
75752-
"type": {
75753-
"type": "string",
75754-
"enum": [
75755-
"Issue",
75756-
"PullRequest"
75757-
],
75758-
"description": "The type of item to add to the project. Must be either Issue or PullRequest."
75805+
"oneOf": [
75806+
{
75807+
"type": "object",
75808+
"properties": {
75809+
"type": {
75810+
"type": "string",
75811+
"enum": [
75812+
"Issue",
75813+
"PullRequest"
75814+
],
75815+
"description": "The type of item to add to the project. Must be either Issue or PullRequest."
75816+
},
75817+
"id": {
75818+
"type": "integer",
75819+
"description": "The unique ID of the issue or pull request to add to the project."
75820+
}
75821+
},
75822+
"required": [
75823+
"type",
75824+
"id"
75825+
]
7575975826
},
75760-
"id": {
75761-
"type": "integer",
75762-
"description": "The numeric ID of the issue or pull request to add to the project."
75827+
{
75828+
"type": "object",
75829+
"properties": {
75830+
"type": {
75831+
"type": "string",
75832+
"enum": [
75833+
"Issue",
75834+
"PullRequest"
75835+
],
75836+
"description": "The type of item to add to the project. Must be either Issue or PullRequest."
75837+
},
75838+
"owner": {
75839+
"type": "string",
75840+
"description": "The repository owner login."
75841+
},
75842+
"repo": {
75843+
"type": "string",
75844+
"description": "The repository name."
75845+
},
75846+
"number": {
75847+
"type": "integer",
75848+
"description": "The issue or pull request number."
75849+
}
75850+
},
75851+
"required": [
75852+
"type",
75853+
"owner",
75854+
"repo",
75855+
"number"
75856+
]
7576375857
}
75764-
},
75765-
"required": [
75766-
"type",
75767-
"id"
7576875858
]
7576975859
},
7577075860
"examples": {
75771-
"issue": {
75861+
"issue-with-id": {
75862+
"summary": "Add issue by database ID",
7577275863
"value": {
7577375864
"type": "Issue",
7577475865
"id": 3
7577575866
}
7577675867
},
75777-
"pull_request": {
75868+
"pull_request-with-id": {
75869+
"summary": "Add pull request by database ID",
7577875870
"value": {
7577975871
"type": "PullRequest",
7578075872
"id": 3
7578175873
}
75874+
},
75875+
"issue-with-nwo": {
75876+
"summary": "Add issue by repository and number",
75877+
"value": {
75878+
"type": "Issue",
75879+
"owner": "octocat",
75880+
"repo": "hello-world",
75881+
"number": 42
75882+
}
75883+
},
75884+
"pull_request-with-nwo": {
75885+
"summary": "Add pull request by repository and number",
75886+
"value": {
75887+
"type": "PullRequest",
75888+
"owner": "octocat",
75889+
"repo": "hello-world",
75890+
"number": 123
75891+
}
7578275892
}
7578375893
}
7578475894
}
@@ -287189,6 +287299,11 @@
287189287299
"state": "active",
287190287300
"role": "admin",
287191287301
"organization_url": "https://api.github.com/orgs/octocat",
287302+
"direct_membership": true,
287303+
"enterprise_teams_providing_indirect_membership": [
287304+
"ent:justice-league",
287305+
"ent:security-managers"
287306+
],
287192287307
"organization": {
287193287308
"login": "github",
287194287309
"id": 1,
@@ -307823,6 +307938,8 @@
307823307938
"state": "active",
307824307939
"role": "admin",
307825307940
"organization_url": "https://api.github.com/orgs/octocat",
307941+
"direct_membership": true,
307942+
"enterprise_teams_providing_indirect_membership": [],
307826307943
"organization": {
307827307944
"login": "github",
307828307945
"id": 1,
@@ -307863,6 +307980,11 @@
307863307980
"state": "pending",
307864307981
"role": "admin",
307865307982
"organization_url": "https://api.github.com/orgs/invitocat",
307983+
"direct_membership": false,
307984+
"enterprise_teams_providing_indirect_membership": [
307985+
"ent:justice-league",
307986+
"ent:security-managers"
307987+
],
307866307988
"organization": {
307867307989
"login": "github",
307868307990
"id": 1,
@@ -307906,6 +308028,11 @@
307906308028
"state": "pending",
307907308029
"role": "admin",
307908308030
"organization_url": "https://api.github.com/orgs/invitocat",
308031+
"direct_membership": true,
308032+
"enterprise_teams_providing_indirect_membership": [
308033+
"ent:justice-league",
308034+
"ent:security-managers"
308035+
],
307909308036
"organization": {
307910308037
"login": "github",
307911308038
"id": 1,
@@ -307948,6 +308075,11 @@
307948308075
"state": "active",
307949308076
"role": "admin",
307950308077
"organization_url": "https://api.github.com/orgs/octocat",
308078+
"direct_membership": true,
308079+
"enterprise_teams_providing_indirect_membership": [
308080+
"ent:justice-league",
308081+
"ent:security-managers"
308082+
],
307951308083
"organization": {
307952308084
"login": "github",
307953308085
"id": 1,

0 commit comments

Comments
 (0)