Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
779 changes: 706 additions & 73 deletions cache/api.github.com.json

Large diffs are not rendered by default.

48 changes: 30 additions & 18 deletions cache/ghes-2.22.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "2.23.1",
"version": "2.24.0",
"title": "GitHub's official OpenAPI spec + Octokit extension",
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
"license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
Expand Down Expand Up @@ -29148,7 +29148,7 @@
},
"post": {
"summary": "Enable or disable maintenance mode",
"description": "The possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic).",
"description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).",
"operationId": "enterprise-admin/enable-or-disable-maintenance-mode",
"tags": ["enterprise-admin"],
"externalDocs": {
Expand All @@ -29172,16 +29172,19 @@
},
"requestBody": {
"content": {
"application/json": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"maintenance": {
"type": "string",
"description": "A JSON string with the attributes `enabled` and `when`."
"description": "A JSON string with the attributes `enabled` and `when`.\n\nThe possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic)."
}
},
"required": ["maintenance"]
},
"example": {
"maintenance": "{\"enabled\":true, \"when\":\"now\"}"
}
}
}
Expand Down Expand Up @@ -29234,7 +29237,7 @@
},
"put": {
"summary": "Set settings",
"description": "For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#get-settings).",
"description": "For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#get-settings).\n\n**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).",
"operationId": "enterprise-admin/set-settings",
"tags": ["enterprise-admin"],
"externalDocs": {
Expand All @@ -29244,16 +29247,19 @@
"responses": { "204": { "description": "Response" } },
"requestBody": {
"content": {
"application/json": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"settings": {
"type": "string",
"description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify."
"description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#get-settings)."
}
},
"required": ["settings"]
},
"example": {
"settings": "{ \"enterprise\": { \"public_pages\": true }}"
}
}
}
Expand Down Expand Up @@ -29305,7 +29311,7 @@
},
"post": {
"summary": "Add an authorized SSH key",
"description": "",
"description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).",
"operationId": "enterprise-admin/add-authorized-ssh-key",
"tags": ["enterprise-admin"],
"externalDocs": {
Expand All @@ -29330,16 +29336,19 @@
},
"requestBody": {
"content": {
"application/json": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"authorized_key": {
"type": "string",
"description": "The path to the public SSH key."
"description": "The public SSH key."
}
},
"required": ["authorized_key"]
},
"example": {
"authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw=="
}
}
}
Expand All @@ -29355,7 +29364,7 @@
},
"delete": {
"summary": "Remove an authorized SSH key",
"description": "",
"description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).",
"operationId": "enterprise-admin/remove-authorized-ssh-key",
"tags": ["enterprise-admin"],
"externalDocs": {
Expand All @@ -29380,16 +29389,19 @@
},
"requestBody": {
"content": {
"application/json": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"authorized_key": {
"type": "string",
"description": "The path to the public SSH key."
"description": "The public SSH key."
}
},
"required": ["authorized_key"]
},
"example": {
"authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw=="
}
}
}
Expand All @@ -29407,7 +29419,7 @@
"/setup/api/start": {
"post": {
"summary": "Create a GitHub license",
"description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license:\n\nNote that you need to POST to [`/setup/api/configure`](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\nFor a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#get-settings).",
"description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).",
"operationId": "enterprise-admin/create-enterprise-server-license",
"tags": ["enterprise-admin"],
"externalDocs": {
Expand All @@ -29417,7 +29429,7 @@
"responses": { "202": { "description": "Response" } },
"requestBody": {
"content": {
"application/json": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
Expand All @@ -29431,7 +29443,7 @@
},
"settings": {
"type": "string",
"description": "An optional JSON string containing the installation settings."
"description": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#get-settings)."
}
},
"required": ["license"]
Expand All @@ -29452,7 +29464,7 @@
"/setup/api/upgrade": {
"post": {
"summary": "Upgrade a license",
"description": "This API upgrades your license and also triggers the configuration process:",
"description": "This API upgrades your license and also triggers the configuration process.\n\n**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).",
"operationId": "enterprise-admin/upgrade-license",
"tags": ["enterprise-admin"],
"externalDocs": {
Expand All @@ -29462,7 +29474,7 @@
"responses": { "202": { "description": "Response" } },
"requestBody": {
"content": {
"application/json": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
Expand Down
Loading