Skip to content

Commit 8c9b396

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.0 Descriptions
1 parent b27d92b commit 8c9b396

File tree

8 files changed

+13332
-12098
lines changed

8 files changed

+13332
-12098
lines changed

‎descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json‎

Lines changed: 304 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16861,6 +16861,310 @@
1686116861
}
1686216862
}
1686316863
},
16864+
"/enterprises/{enterprise}/access-restrictions/disable": {
16865+
"post": {
16866+
"summary": "Disable access restrictions for an enterprise",
16867+
"description": "Disable access restriction by proxy header using the network proxy owned by the enterprise.",
16868+
"operationId": "enterprise-admin/disable-access-restrictions",
16869+
"tags": [
16870+
"enterprise-admin"
16871+
],
16872+
"externalDocs": {
16873+
"description": "API method documentation",
16874+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprises#disable-access-restrictions-for-an-enterprise"
16875+
},
16876+
"parameters": [
16877+
{
16878+
"name": "enterprise",
16879+
"description": "The slug version of the enterprise name.",
16880+
"in": "path",
16881+
"required": true,
16882+
"schema": {
16883+
"type": "string"
16884+
}
16885+
}
16886+
],
16887+
"responses": {
16888+
"200": {
16889+
"description": "Response",
16890+
"content": {
16891+
"application/json": {
16892+
"schema": {
16893+
"type": "object",
16894+
"title": "Enterprise Access Restrictions",
16895+
"description": "Information about the enterprise access restrictions proxy header.",
16896+
"properties": {
16897+
"message": {
16898+
"type": "string",
16899+
"description": "The message returned for the request."
16900+
},
16901+
"header_name": {
16902+
"type": "string",
16903+
"description": "The name of the proxy header.",
16904+
"example": "sec-GitHub-allowed-enterprise"
16905+
},
16906+
"header_value": {
16907+
"type": "string",
16908+
"description": "The value of the proxy header."
16909+
}
16910+
},
16911+
"required": [
16912+
"message",
16913+
"header_name",
16914+
"header_value"
16915+
]
16916+
},
16917+
"examples": {
16918+
"default": {
16919+
"value": {
16920+
"message": "Enterprise access restrictions successfully disabled.",
16921+
"header_name": "sec-GitHub-allowed-enterprise",
16922+
"header_value": "12345"
16923+
}
16924+
}
16925+
}
16926+
}
16927+
}
16928+
},
16929+
"400": {
16930+
"description": "Forbidden",
16931+
"content": {
16932+
"application/json": {
16933+
"schema": {
16934+
"title": "Basic Error",
16935+
"description": "Basic Error",
16936+
"type": "object",
16937+
"properties": {
16938+
"message": {
16939+
"type": "string"
16940+
},
16941+
"documentation_url": {
16942+
"type": "string"
16943+
},
16944+
"url": {
16945+
"type": "string"
16946+
},
16947+
"status": {
16948+
"type": "string"
16949+
}
16950+
}
16951+
}
16952+
}
16953+
}
16954+
},
16955+
"404": {
16956+
"description": "Resource not found",
16957+
"content": {
16958+
"application/json": {
16959+
"schema": {
16960+
"title": "Basic Error",
16961+
"description": "Basic Error",
16962+
"type": "object",
16963+
"properties": {
16964+
"message": {
16965+
"type": "string"
16966+
},
16967+
"documentation_url": {
16968+
"type": "string"
16969+
},
16970+
"url": {
16971+
"type": "string"
16972+
},
16973+
"status": {
16974+
"type": "string"
16975+
}
16976+
}
16977+
}
16978+
}
16979+
}
16980+
},
16981+
"500": {
16982+
"description": "Internal Error",
16983+
"content": {
16984+
"application/json": {
16985+
"schema": {
16986+
"title": "Basic Error",
16987+
"description": "Basic Error",
16988+
"type": "object",
16989+
"properties": {
16990+
"message": {
16991+
"type": "string"
16992+
},
16993+
"documentation_url": {
16994+
"type": "string"
16995+
},
16996+
"url": {
16997+
"type": "string"
16998+
},
16999+
"status": {
17000+
"type": "string"
17001+
}
17002+
}
17003+
}
17004+
}
17005+
}
17006+
}
17007+
},
17008+
"x-github": {
17009+
"githubCloudOnly": true,
17010+
"enabledForGitHubApps": false,
17011+
"category": "enterprise-admin",
17012+
"subcategory": "enterprises"
17013+
}
17014+
}
17015+
},
17016+
"/enterprises/{enterprise}/access-restrictions/enable": {
17017+
"post": {
17018+
"summary": "Enable access restrictions for an enterprise",
17019+
"description": "Enable access restriction by proxy header using the network proxy owned by the enterprise.",
17020+
"operationId": "enterprise-admin/enable-access-restrictions",
17021+
"tags": [
17022+
"enterprise-admin"
17023+
],
17024+
"externalDocs": {
17025+
"description": "API method documentation",
17026+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprises#enable-access-restrictions-for-an-enterprise"
17027+
},
17028+
"parameters": [
17029+
{
17030+
"name": "enterprise",
17031+
"description": "The slug version of the enterprise name.",
17032+
"in": "path",
17033+
"required": true,
17034+
"schema": {
17035+
"type": "string"
17036+
}
17037+
}
17038+
],
17039+
"responses": {
17040+
"200": {
17041+
"description": "Response",
17042+
"content": {
17043+
"application/json": {
17044+
"schema": {
17045+
"type": "object",
17046+
"title": "Enterprise Access Restrictions",
17047+
"description": "Information about the enterprise access restrictions proxy header.",
17048+
"properties": {
17049+
"message": {
17050+
"type": "string",
17051+
"description": "The message returned for the request."
17052+
},
17053+
"header_name": {
17054+
"type": "string",
17055+
"description": "The name of the proxy header.",
17056+
"example": "sec-GitHub-allowed-enterprise"
17057+
},
17058+
"header_value": {
17059+
"type": "string",
17060+
"description": "The value of the proxy header."
17061+
}
17062+
},
17063+
"required": [
17064+
"message",
17065+
"header_name",
17066+
"header_value"
17067+
]
17068+
},
17069+
"examples": {
17070+
"default": {
17071+
"value": {
17072+
"message": "Enterprise access restrictions successfully enabled.",
17073+
"header_name": "sec-GitHub-allowed-enterprise",
17074+
"header_value": "12345"
17075+
}
17076+
}
17077+
}
17078+
}
17079+
}
17080+
},
17081+
"400": {
17082+
"description": "Forbidden",
17083+
"content": {
17084+
"application/json": {
17085+
"schema": {
17086+
"title": "Basic Error",
17087+
"description": "Basic Error",
17088+
"type": "object",
17089+
"properties": {
17090+
"message": {
17091+
"type": "string"
17092+
},
17093+
"documentation_url": {
17094+
"type": "string"
17095+
},
17096+
"url": {
17097+
"type": "string"
17098+
},
17099+
"status": {
17100+
"type": "string"
17101+
}
17102+
}
17103+
}
17104+
}
17105+
}
17106+
},
17107+
"404": {
17108+
"description": "Resource not found",
17109+
"content": {
17110+
"application/json": {
17111+
"schema": {
17112+
"title": "Basic Error",
17113+
"description": "Basic Error",
17114+
"type": "object",
17115+
"properties": {
17116+
"message": {
17117+
"type": "string"
17118+
},
17119+
"documentation_url": {
17120+
"type": "string"
17121+
},
17122+
"url": {
17123+
"type": "string"
17124+
},
17125+
"status": {
17126+
"type": "string"
17127+
}
17128+
}
17129+
}
17130+
}
17131+
}
17132+
},
17133+
"500": {
17134+
"description": "Internal Error",
17135+
"content": {
17136+
"application/json": {
17137+
"schema": {
17138+
"title": "Basic Error",
17139+
"description": "Basic Error",
17140+
"type": "object",
17141+
"properties": {
17142+
"message": {
17143+
"type": "string"
17144+
},
17145+
"documentation_url": {
17146+
"type": "string"
17147+
},
17148+
"url": {
17149+
"type": "string"
17150+
},
17151+
"status": {
17152+
"type": "string"
17153+
}
17154+
}
17155+
}
17156+
}
17157+
}
17158+
}
17159+
},
17160+
"x-github": {
17161+
"githubCloudOnly": true,
17162+
"enabledForGitHubApps": false,
17163+
"category": "enterprise-admin",
17164+
"subcategory": "enterprises"
17165+
}
17166+
}
17167+
},
1686417168
"/enterprises/{enterprise}/actions/cache/usage": {
1686517169
"get": {
1686617170
"summary": "Get GitHub Actions cache usage for an enterprise",

0 commit comments

Comments
 (0)