Skip to content

Commit 12b1ef6

Browse files
Update OpenAPI 3.1 Descriptions
1 parent b27d92b commit 12b1ef6

File tree

8 files changed

+13124
-11874
lines changed

8 files changed

+13124
-11874
lines changed

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

Lines changed: 308 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18771,6 +18771,314 @@
1877118771
}
1877218772
}
1877318773
},
18774+
"/enterprises/{enterprise}/access-restrictions/disable": {
18775+
"post": {
18776+
"summary": "Disable access restrictions for an enterprise",
18777+
"description": "Disable access restriction by proxy header using the network proxy owned by the enterprise.",
18778+
"operationId": "enterprise-admin/disable-access-restrictions",
18779+
"tags": [
18780+
"enterprise-admin"
18781+
],
18782+
"externalDocs": {
18783+
"description": "API method documentation",
18784+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprises#disable-access-restrictions-for-an-enterprise"
18785+
},
18786+
"parameters": [
18787+
{
18788+
"name": "enterprise",
18789+
"description": "The slug version of the enterprise name.",
18790+
"in": "path",
18791+
"required": true,
18792+
"schema": {
18793+
"type": "string"
18794+
}
18795+
}
18796+
],
18797+
"responses": {
18798+
"200": {
18799+
"description": "Response",
18800+
"content": {
18801+
"application/json": {
18802+
"schema": {
18803+
"type": "object",
18804+
"title": "Enterprise Access Restrictions",
18805+
"description": "Information about the enterprise access restrictions proxy header.",
18806+
"properties": {
18807+
"message": {
18808+
"type": "string",
18809+
"description": "The message returned for the request."
18810+
},
18811+
"header_name": {
18812+
"type": "string",
18813+
"description": "The name of the proxy header.",
18814+
"examples": [
18815+
"sec-GitHub-allowed-enterprise"
18816+
]
18817+
},
18818+
"header_value": {
18819+
"type": "string",
18820+
"description": "The value of the proxy header."
18821+
}
18822+
},
18823+
"required": [
18824+
"message",
18825+
"header_name",
18826+
"header_value"
18827+
]
18828+
},
18829+
"examples": {
18830+
"default": {
18831+
"value": {
18832+
"message": "Enterprise access restrictions successfully disabled.",
18833+
"header_name": "sec-GitHub-allowed-enterprise",
18834+
"header_value": "12345"
18835+
}
18836+
}
18837+
}
18838+
}
18839+
}
18840+
},
18841+
"400": {
18842+
"description": "Forbidden",
18843+
"content": {
18844+
"application/json": {
18845+
"schema": {
18846+
"title": "Basic Error",
18847+
"description": "Basic Error",
18848+
"type": "object",
18849+
"properties": {
18850+
"message": {
18851+
"type": "string"
18852+
},
18853+
"documentation_url": {
18854+
"type": "string"
18855+
},
18856+
"url": {
18857+
"type": "string"
18858+
},
18859+
"status": {
18860+
"type": "string"
18861+
}
18862+
}
18863+
}
18864+
}
18865+
}
18866+
},
18867+
"404": {
18868+
"description": "Resource not found",
18869+
"content": {
18870+
"application/json": {
18871+
"schema": {
18872+
"title": "Basic Error",
18873+
"description": "Basic Error",
18874+
"type": "object",
18875+
"properties": {
18876+
"message": {
18877+
"type": "string"
18878+
},
18879+
"documentation_url": {
18880+
"type": "string"
18881+
},
18882+
"url": {
18883+
"type": "string"
18884+
},
18885+
"status": {
18886+
"type": "string"
18887+
}
18888+
}
18889+
}
18890+
}
18891+
}
18892+
},
18893+
"500": {
18894+
"description": "Internal Error",
18895+
"content": {
18896+
"application/json": {
18897+
"schema": {
18898+
"title": "Basic Error",
18899+
"description": "Basic Error",
18900+
"type": "object",
18901+
"properties": {
18902+
"message": {
18903+
"type": "string"
18904+
},
18905+
"documentation_url": {
18906+
"type": "string"
18907+
},
18908+
"url": {
18909+
"type": "string"
18910+
},
18911+
"status": {
18912+
"type": "string"
18913+
}
18914+
}
18915+
}
18916+
}
18917+
}
18918+
}
18919+
},
18920+
"x-github": {
18921+
"githubCloudOnly": true,
18922+
"enabledForGitHubApps": false,
18923+
"category": "enterprise-admin",
18924+
"subcategory": "enterprises"
18925+
}
18926+
}
18927+
},
18928+
"/enterprises/{enterprise}/access-restrictions/enable": {
18929+
"post": {
18930+
"summary": "Enable access restrictions for an enterprise",
18931+
"description": "Enable access restriction by proxy header using the network proxy owned by the enterprise.",
18932+
"operationId": "enterprise-admin/enable-access-restrictions",
18933+
"tags": [
18934+
"enterprise-admin"
18935+
],
18936+
"externalDocs": {
18937+
"description": "API method documentation",
18938+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprises#enable-access-restrictions-for-an-enterprise"
18939+
},
18940+
"parameters": [
18941+
{
18942+
"name": "enterprise",
18943+
"description": "The slug version of the enterprise name.",
18944+
"in": "path",
18945+
"required": true,
18946+
"schema": {
18947+
"type": "string"
18948+
}
18949+
}
18950+
],
18951+
"responses": {
18952+
"200": {
18953+
"description": "Response",
18954+
"content": {
18955+
"application/json": {
18956+
"schema": {
18957+
"type": "object",
18958+
"title": "Enterprise Access Restrictions",
18959+
"description": "Information about the enterprise access restrictions proxy header.",
18960+
"properties": {
18961+
"message": {
18962+
"type": "string",
18963+
"description": "The message returned for the request."
18964+
},
18965+
"header_name": {
18966+
"type": "string",
18967+
"description": "The name of the proxy header.",
18968+
"examples": [
18969+
"sec-GitHub-allowed-enterprise"
18970+
]
18971+
},
18972+
"header_value": {
18973+
"type": "string",
18974+
"description": "The value of the proxy header."
18975+
}
18976+
},
18977+
"required": [
18978+
"message",
18979+
"header_name",
18980+
"header_value"
18981+
]
18982+
},
18983+
"examples": {
18984+
"default": {
18985+
"value": {
18986+
"message": "Enterprise access restrictions successfully enabled.",
18987+
"header_name": "sec-GitHub-allowed-enterprise",
18988+
"header_value": "12345"
18989+
}
18990+
}
18991+
}
18992+
}
18993+
}
18994+
},
18995+
"400": {
18996+
"description": "Forbidden",
18997+
"content": {
18998+
"application/json": {
18999+
"schema": {
19000+
"title": "Basic Error",
19001+
"description": "Basic Error",
19002+
"type": "object",
19003+
"properties": {
19004+
"message": {
19005+
"type": "string"
19006+
},
19007+
"documentation_url": {
19008+
"type": "string"
19009+
},
19010+
"url": {
19011+
"type": "string"
19012+
},
19013+
"status": {
19014+
"type": "string"
19015+
}
19016+
}
19017+
}
19018+
}
19019+
}
19020+
},
19021+
"404": {
19022+
"description": "Resource not found",
19023+
"content": {
19024+
"application/json": {
19025+
"schema": {
19026+
"title": "Basic Error",
19027+
"description": "Basic Error",
19028+
"type": "object",
19029+
"properties": {
19030+
"message": {
19031+
"type": "string"
19032+
},
19033+
"documentation_url": {
19034+
"type": "string"
19035+
},
19036+
"url": {
19037+
"type": "string"
19038+
},
19039+
"status": {
19040+
"type": "string"
19041+
}
19042+
}
19043+
}
19044+
}
19045+
}
19046+
},
19047+
"500": {
19048+
"description": "Internal Error",
19049+
"content": {
19050+
"application/json": {
19051+
"schema": {
19052+
"title": "Basic Error",
19053+
"description": "Basic Error",
19054+
"type": "object",
19055+
"properties": {
19056+
"message": {
19057+
"type": "string"
19058+
},
19059+
"documentation_url": {
19060+
"type": "string"
19061+
},
19062+
"url": {
19063+
"type": "string"
19064+
},
19065+
"status": {
19066+
"type": "string"
19067+
}
19068+
}
19069+
}
19070+
}
19071+
}
19072+
}
19073+
},
19074+
"x-github": {
19075+
"githubCloudOnly": true,
19076+
"enabledForGitHubApps": false,
19077+
"category": "enterprise-admin",
19078+
"subcategory": "enterprises"
19079+
}
19080+
}
19081+
},
1877419082
"/enterprises/{enterprise}/actions/cache/usage": {
1877519083
"get": {
1877619084
"summary": "Get GitHub Actions cache usage for an enterprise",

0 commit comments

Comments
 (0)