Skip to content

Update OpenAPI 3.0 Descriptions #5353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Update OpenAPI 3.0 Descriptions #5353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
304 changes: 304 additions & 0 deletions descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16861,6 +16861,310 @@
}
}
},
"/enterprises/{enterprise}/access-restrictions/disable": {
"post": {
"summary": "Disable access restrictions for an enterprise",
"description": "Disable access restriction by proxy header using the network proxy owned by the enterprise.",
"operationId": "enterprise-admin/disable-access-restrictions",
"tags": [
"enterprise-admin"
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprises#disable-access-restrictions-for-an-enterprise"
},
"parameters": [
{
"name": "enterprise",
"description": "The slug version of the enterprise name.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Enterprise Access Restrictions",
"description": "Information about the enterprise access restrictions proxy header.",
"properties": {
"message": {
"type": "string",
"description": "The message returned for the request."
},
"header_name": {
"type": "string",
"description": "The name of the proxy header.",
"example": "sec-GitHub-allowed-enterprise"
},
"header_value": {
"type": "string",
"description": "The value of the proxy header."
}
},
"required": [
"message",
"header_name",
"header_value"
]
},
"examples": {
"default": {
"value": {
"message": "Enterprise access restrictions successfully disabled.",
"header_name": "sec-GitHub-allowed-enterprise",
"header_value": "12345"
}
}
}
}
}
},
"400": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"title": "Basic Error",
"description": "Basic Error",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
},
"url": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"title": "Basic Error",
"description": "Basic Error",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
},
"url": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "Internal Error",
"content": {
"application/json": {
"schema": {
"title": "Basic Error",
"description": "Basic Error",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
},
"url": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
}
}
}
},
"x-github": {
"githubCloudOnly": true,
"enabledForGitHubApps": false,
"category": "enterprise-admin",
"subcategory": "enterprises"
}
}
},
"/enterprises/{enterprise}/access-restrictions/enable": {
"post": {
"summary": "Enable access restrictions for an enterprise",
"description": "Enable access restriction by proxy header using the network proxy owned by the enterprise.",
"operationId": "enterprise-admin/enable-access-restrictions",
"tags": [
"enterprise-admin"
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprises#enable-access-restrictions-for-an-enterprise"
},
"parameters": [
{
"name": "enterprise",
"description": "The slug version of the enterprise name.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Enterprise Access Restrictions",
"description": "Information about the enterprise access restrictions proxy header.",
"properties": {
"message": {
"type": "string",
"description": "The message returned for the request."
},
"header_name": {
"type": "string",
"description": "The name of the proxy header.",
"example": "sec-GitHub-allowed-enterprise"
},
"header_value": {
"type": "string",
"description": "The value of the proxy header."
}
},
"required": [
"message",
"header_name",
"header_value"
]
},
"examples": {
"default": {
"value": {
"message": "Enterprise access restrictions successfully enabled.",
"header_name": "sec-GitHub-allowed-enterprise",
"header_value": "12345"
}
}
}
}
}
},
"400": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"title": "Basic Error",
"description": "Basic Error",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
},
"url": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"title": "Basic Error",
"description": "Basic Error",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
},
"url": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "Internal Error",
"content": {
"application/json": {
"schema": {
"title": "Basic Error",
"description": "Basic Error",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
},
"url": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
}
}
}
},
"x-github": {
"githubCloudOnly": true,
"enabledForGitHubApps": false,
"category": "enterprise-admin",
"subcategory": "enterprises"
}
}
},
"/enterprises/{enterprise}/actions/cache/usage": {
"get": {
"summary": "Get GitHub Actions cache usage for an enterprise",
Expand Down
Loading