Skip to content

Commit 3a172de

Browse files
docs-botsubatoi
docs-bot
and
subatoi
authored
Update OpenAPI Description (#61952)
Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
1 parent e7bda70 commit 3a172de

33 files changed

Lines changed: 295176 additions & 202613 deletions

File tree

‎src/github-apps/lib/config.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@
6060
"2022-11-28"
6161
]
6262
},
63-
"sha": "ef4e98d7fcad5ec4476fd73b4d536557524f3c57"
63+
"sha": "3c63b49e41d98449d7b0f7ed12ea40dc9839edd4"
6464
}

‎src/rest/data/fpt-2022-11-28/code-scanning.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4215,8 +4215,8 @@
42154215
"description": "<p>Resource not found</p>"
42164216
},
42174217
{
4218-
"httpStatusCode": "503",
4219-
"description": "<p>Service unavailable</p>"
4218+
"httpStatusCode": "500",
4219+
"description": "<p>Internal Error</p>"
42204220
}
42214221
],
42224222
"previews": [],
@@ -4405,8 +4405,8 @@
44054405
"description": "<p>Unprocessable Entity</p>"
44064406
},
44074407
{
4408-
"httpStatusCode": "503",
4409-
"description": "<p>Service unavailable</p>"
4408+
"httpStatusCode": "500",
4409+
"description": "<p>Internal Error</p>"
44104410
}
44114411
],
44124412
"previews": [],

‎src/rest/data/fpt-2022-11-28/interactions.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -602,7 +602,7 @@
602602
}
603603
],
604604
"bodyParameters": [],
605-
"descriptionHTML": "<p>Lists the users that are on the pull request creation cap bypass list for a\nrepository. Users on this list can create pull requests regardless of any\nconfigured pull request creation cap.</p>\n<p>Only repository admins can view the bypass list.</p>",
605+
"descriptionHTML": "<p>Lists the users that are on the pull request creation cap bypass list for a\nrepository. Users on this list can create pull requests regardless of any\nconfigured pull request creation cap.</p>\n<p>Only users with maintainer permissions can view the bypass list.</p>",
606606
"codeExamples": [
607607
{
608608
"request": {

‎src/rest/data/fpt-2022-11-28/issues.json‎

Lines changed: 31327 additions & 22367 deletions
Large diffs are not rendered by default.

‎src/rest/data/fpt-2022-11-28/orgs.json‎

Lines changed: 314 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14047,7 +14047,7 @@
1404714047
{
1404814048
"request": {
1404914049
"contentType": "application/json",
14050-
"description": "Example",
14050+
"description": "Example 1: Status Code 200",
1405114051
"acceptHeader": "application/vnd.github.v3+json",
1405214052
"bodyParameters": {
1405314053
"state": "active"
@@ -14059,7 +14059,314 @@
1405914059
"response": {
1406014060
"statusCode": "200",
1406114061
"contentType": "application/json",
14062-
"description": "<p>Response</p>",
14062+
"description": "<p>The user's organization invitation was accepted synchronously.</p>",
14063+
"example": {
14064+
"url": "https://api.github.com/orgs/octocat/memberships/defunkt",
14065+
"state": "active",
14066+
"role": "admin",
14067+
"organization_url": "https://api.github.com/orgs/octocat",
14068+
"direct_membership": true,
14069+
"enterprise_teams_providing_indirect_membership": [
14070+
"ent:justice-league",
14071+
"ent:security-managers"
14072+
],
14073+
"organization": {
14074+
"login": "github",
14075+
"id": 1,
14076+
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
14077+
"url": "https://api.github.com/orgs/github",
14078+
"repos_url": "https://api.github.com/orgs/github/repos",
14079+
"events_url": "https://api.github.com/orgs/github/events",
14080+
"hooks_url": "https://api.github.com/orgs/github/hooks",
14081+
"issues_url": "https://api.github.com/orgs/github/issues",
14082+
"members_url": "https://api.github.com/orgs/github/members{/member}",
14083+
"public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
14084+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
14085+
"description": "A great organization"
14086+
},
14087+
"user": {
14088+
"login": "octocat",
14089+
"id": 1,
14090+
"node_id": "MDQ6VXNlcjE=",
14091+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
14092+
"gravatar_id": "",
14093+
"url": "https://api.github.com/users/octocat",
14094+
"html_url": "https://github.com/octocat",
14095+
"followers_url": "https://api.github.com/users/octocat/followers",
14096+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
14097+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
14098+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
14099+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
14100+
"organizations_url": "https://api.github.com/users/octocat/orgs",
14101+
"repos_url": "https://api.github.com/users/octocat/repos",
14102+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
14103+
"received_events_url": "https://api.github.com/users/octocat/received_events",
14104+
"type": "User",
14105+
"site_admin": false
14106+
}
14107+
},
14108+
"schema": {
14109+
"title": "Org Membership",
14110+
"description": "Org Membership",
14111+
"type": "object",
14112+
"properties": {
14113+
"url": {
14114+
"type": "string",
14115+
"format": "uri"
14116+
},
14117+
"state": {
14118+
"type": "string",
14119+
"description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.",
14120+
"enum": [
14121+
"active",
14122+
"pending"
14123+
]
14124+
},
14125+
"role": {
14126+
"type": "string",
14127+
"description": "The user's membership type in the organization.",
14128+
"enum": [
14129+
"admin",
14130+
"member",
14131+
"billing_manager"
14132+
]
14133+
},
14134+
"direct_membership": {
14135+
"type": "boolean",
14136+
"description": "Whether the user has direct membership in the organization."
14137+
},
14138+
"enterprise_teams_providing_indirect_membership": {
14139+
"type": "array",
14140+
"description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.",
14141+
"maxItems": 100,
14142+
"items": {
14143+
"type": "string"
14144+
}
14145+
},
14146+
"organization_url": {
14147+
"type": "string",
14148+
"format": "uri"
14149+
},
14150+
"organization": {
14151+
"title": "Organization Simple",
14152+
"description": "A GitHub organization.",
14153+
"type": "object",
14154+
"properties": {
14155+
"login": {
14156+
"type": "string"
14157+
},
14158+
"id": {
14159+
"type": "integer"
14160+
},
14161+
"node_id": {
14162+
"type": "string"
14163+
},
14164+
"url": {
14165+
"type": "string",
14166+
"format": "uri"
14167+
},
14168+
"repos_url": {
14169+
"type": "string",
14170+
"format": "uri"
14171+
},
14172+
"events_url": {
14173+
"type": "string",
14174+
"format": "uri"
14175+
},
14176+
"hooks_url": {
14177+
"type": "string"
14178+
},
14179+
"issues_url": {
14180+
"type": "string"
14181+
},
14182+
"members_url": {
14183+
"type": "string"
14184+
},
14185+
"public_members_url": {
14186+
"type": "string"
14187+
},
14188+
"avatar_url": {
14189+
"type": "string"
14190+
},
14191+
"description": {
14192+
"type": [
14193+
"string",
14194+
"null"
14195+
]
14196+
}
14197+
},
14198+
"required": [
14199+
"login",
14200+
"url",
14201+
"id",
14202+
"node_id",
14203+
"repos_url",
14204+
"events_url",
14205+
"hooks_url",
14206+
"issues_url",
14207+
"members_url",
14208+
"public_members_url",
14209+
"avatar_url",
14210+
"description"
14211+
]
14212+
},
14213+
"user": {
14214+
"anyOf": [
14215+
{
14216+
"type": "null"
14217+
},
14218+
{
14219+
"title": "Simple User",
14220+
"description": "A GitHub user.",
14221+
"type": "object",
14222+
"properties": {
14223+
"name": {
14224+
"type": [
14225+
"string",
14226+
"null"
14227+
]
14228+
},
14229+
"email": {
14230+
"type": [
14231+
"string",
14232+
"null"
14233+
]
14234+
},
14235+
"login": {
14236+
"type": "string"
14237+
},
14238+
"id": {
14239+
"type": "integer",
14240+
"format": "int64"
14241+
},
14242+
"node_id": {
14243+
"type": "string"
14244+
},
14245+
"avatar_url": {
14246+
"type": "string",
14247+
"format": "uri"
14248+
},
14249+
"gravatar_id": {
14250+
"type": [
14251+
"string",
14252+
"null"
14253+
]
14254+
},
14255+
"url": {
14256+
"type": "string",
14257+
"format": "uri"
14258+
},
14259+
"html_url": {
14260+
"type": "string",
14261+
"format": "uri"
14262+
},
14263+
"followers_url": {
14264+
"type": "string",
14265+
"format": "uri"
14266+
},
14267+
"following_url": {
14268+
"type": "string"
14269+
},
14270+
"gists_url": {
14271+
"type": "string"
14272+
},
14273+
"starred_url": {
14274+
"type": "string"
14275+
},
14276+
"subscriptions_url": {
14277+
"type": "string",
14278+
"format": "uri"
14279+
},
14280+
"organizations_url": {
14281+
"type": "string",
14282+
"format": "uri"
14283+
},
14284+
"repos_url": {
14285+
"type": "string",
14286+
"format": "uri"
14287+
},
14288+
"events_url": {
14289+
"type": "string"
14290+
},
14291+
"received_events_url": {
14292+
"type": "string",
14293+
"format": "uri"
14294+
},
14295+
"type": {
14296+
"type": "string"
14297+
},
14298+
"site_admin": {
14299+
"type": "boolean"
14300+
},
14301+
"starred_at": {
14302+
"type": "string"
14303+
},
14304+
"user_view_type": {
14305+
"type": "string"
14306+
}
14307+
},
14308+
"required": [
14309+
"avatar_url",
14310+
"events_url",
14311+
"followers_url",
14312+
"following_url",
14313+
"gists_url",
14314+
"gravatar_id",
14315+
"html_url",
14316+
"id",
14317+
"node_id",
14318+
"login",
14319+
"organizations_url",
14320+
"received_events_url",
14321+
"repos_url",
14322+
"site_admin",
14323+
"starred_url",
14324+
"subscriptions_url",
14325+
"type",
14326+
"url"
14327+
]
14328+
}
14329+
]
14330+
},
14331+
"permissions": {
14332+
"type": "object",
14333+
"properties": {
14334+
"can_create_repository": {
14335+
"type": "boolean"
14336+
}
14337+
},
14338+
"required": [
14339+
"can_create_repository"
14340+
]
14341+
}
14342+
},
14343+
"required": [
14344+
"state",
14345+
"role",
14346+
"organization_url",
14347+
"url",
14348+
"organization",
14349+
"user"
14350+
]
14351+
}
14352+
}
14353+
},
14354+
{
14355+
"request": {
14356+
"contentType": "application/json",
14357+
"description": "Example 2: Status Code 202",
14358+
"acceptHeader": "application/vnd.github.v3+json",
14359+
"bodyParameters": {
14360+
"state": "active"
14361+
},
14362+
"parameters": {
14363+
"org": "ORG"
14364+
}
14365+
},
14366+
"response": {
14367+
"statusCode": "202",
14368+
"contentType": "application/json",
14369+
"description": "<p>The acceptance of the user's organization invitation is being processed asynchronously.</p>",
1406314370
"example": {
1406414371
"url": "https://api.github.com/orgs/octocat/memberships/defunkt",
1406514372
"state": "active",
@@ -14355,7 +14662,11 @@
1435514662
"statusCodes": [
1435614663
{
1435714664
"httpStatusCode": "200",
14358-
"description": "<p>OK</p>"
14665+
"description": "<p>The user's organization invitation was accepted synchronously.</p>"
14666+
},
14667+
{
14668+
"httpStatusCode": "202",
14669+
"description": "<p>The acceptance of the user's organization invitation is being processed asynchronously.</p>"
1435914670
},
1436014671
{
1436114672
"httpStatusCode": "403",

‎src/rest/data/fpt-2026-03-10/code-scanning.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4215,8 +4215,8 @@
42154215
"description": "<p>Resource not found</p>"
42164216
},
42174217
{
4218-
"httpStatusCode": "503",
4219-
"description": "<p>Service unavailable</p>"
4218+
"httpStatusCode": "500",
4219+
"description": "<p>Internal Error</p>"
42204220
}
42214221
],
42224222
"previews": [],
@@ -4405,8 +4405,8 @@
44054405
"description": "<p>Unprocessable Entity</p>"
44064406
},
44074407
{
4408-
"httpStatusCode": "503",
4409-
"description": "<p>Service unavailable</p>"
4408+
"httpStatusCode": "500",
4409+
"description": "<p>Internal Error</p>"
44104410
}
44114411
],
44124412
"previews": [],

0 commit comments

Comments
 (0)