feat: add support for new "List CodeQL databases for a repository" (`…

…GET /repos/{owner}/{repo}/code-scanning/codeql/databases`) and "Get a CodeQL database for a repository" (`GET /repos/{owner}/{repo}/code-scanning/codeql/databases/{language}`) APIs, plus description tweaks (#246)

WIP

cache/ghes-3.2.json

@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "7.12.0",
+ "version": "7.13.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": {
@@ -8270,7 +8270,7 @@
  },
  {
  "name": "state",
- "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
+ "description": "Indicates the state of the issues to return.",
  "in": "query",
  "required": false,
  "schema": {
@@ -8288,7 +8288,7 @@
  },
  {
  "name": "sort",
- "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
+ "description": "What to sort results by.",
  "in": "query",
  "required": false,
  "schema": {
@@ -8547,7 +8547,7 @@
  "type": "string"
  },
  "mode": {
- "description": "The rendering mode. Can be either `markdown` or `gfm`.",
+ "description": "The rendering mode.",
  "enum": [
  "markdown",
  "gfm"
@@ -12408,7 +12408,7 @@
  },
  {
  "name": "state",
- "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
+ "description": "Indicates the state of the issues to return.",
  "in": "query",
  "required": false,
  "schema": {
@@ -12426,7 +12426,7 @@
  },
  {
  "name": "sort",
- "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
+ "description": "What to sort results by.",
  "in": "query",
  "required": false,
  "schema": {
@@ -13339,7 +13339,7 @@
  },
  {
  "name": "state",
- "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.",
+ "description": "Indicates the state of the projects to return.",
  "in": "query",
  "required": false,
  "schema": {
@@ -27447,7 +27447,7 @@
  },
  "put": {
  "summary": "Create or update file contents",
- "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
+ "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-server@3.2/rest/reference/repos/#delete-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.",
  "tags": [
  "repos"
  ],
@@ -27626,7 +27626,7 @@
  },
  "delete": {
  "summary": "Delete a file",
- "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.",
+ "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-server@3.2/rest/reference/repos/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.",
  "tags": [
  "repos"
  ],
@@ -29243,7 +29243,7 @@
  },
  {
  "name": "sort",
- "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.",
+ "description": "The sort order. `stargazers` will sort by star count.",
  "in": "query",
  "required": false,
  "schema": {
@@ -31576,7 +31576,7 @@
  },
  {
  "name": "state",
- "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
+ "description": "Indicates the state of the issues to return.",
  "in": "query",
  "required": false,
  "schema": {
@@ -31621,7 +31621,7 @@
  },
  {
  "name": "sort",
- "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
+ "description": "What to sort results by.",
  "in": "query",
  "required": false,
  "schema": {
@@ -36268,7 +36268,7 @@
  },
  {
  "name": "state",
- "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.",
+ "description": "Indicates the state of the projects to return.",
  "in": "query",
  "required": false,
  "schema": {
@@ -36493,7 +36493,7 @@
  },
  {
  "name": "sort",
- "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).",
+ "description": "What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.",
  "in": "query",
  "required": false,
  "schema": {
@@ -36509,7 +36509,7 @@
  },
  {
  "name": "direction",
- "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.",
+ "description": "The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.",
  "in": "query",
  "required": false,
  "schema": {
@@ -36721,7 +36721,7 @@
  },
  {
  "name": "direction",
- "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.",
+ "description": "The direction to sort results. Ignored without `sort` parameter.",
  "in": "query",
  "required": false,
  "schema": {
@@ -37401,7 +37401,7 @@
  },
  {
  "name": "direction",
- "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.",
+ "description": "The direction to sort results. Ignored without `sort` parameter.",
  "in": "query",
  "required": false,
  "schema": {
@@ -46946,7 +46946,7 @@
  },
  {
  "name": "state",
- "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
+ "description": "Indicates the state of the issues to return.",
  "in": "query",
  "required": false,
  "schema": {
@@ -46964,7 +46964,7 @@
  },
  {
  "name": "sort",
- "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
+ "description": "What to sort results by.",
  "in": "query",
  "required": false,
  "schema": {
@@ -47341,7 +47341,7 @@
  "parameters": [
  {
  "name": "state",
- "description": "Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships.",
+ "description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.",
  "in": "query",
  "required": false,
  "schema": {
@@ -49480,7 +49480,7 @@
  },
  {
  "name": "state",
- "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.",
+ "description": "Indicates the state of the projects to return.",
  "in": "query",
  "required": false,
  "schema": {
@@ -60611,7 +60611,16 @@
  "description": "The outcome of the job.",
  "example": "success",
  "type": "string",
- "nullable": true
+ "nullable": true,
+ "enum": [
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "skipped",
+ "timed_out",
+ "action_required"
+ ]
  },
  "started_at": {
  "description": "The time that the job started, in ISO 8601 format.",
@@ -71305,7 +71314,7 @@
  "readOnly": true
  },
  "secret-scanning-alert-state": {
- "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.",
+ "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
  "type": "string",
  "enum": [
  "open",
@@ -96045,7 +96054,7 @@
  }
  },
  "code_scanning_forbidden_write": {
- "description": "Response if the repository is archived or if github advanced security is not enabled for this repository",
+ "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository",
  "content": {
  "application/json": {
  "schema": {