@octokit/openapi 6.2.1 → 6.4.0

package/generated/ghes-3.5-diff-to-api.github.com.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.2.1",
+    "version": "6.4.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" },
@@ -5617,6 +5617,160 @@
         }
       }
     },
+    "/repos/{owner}/{repo}/autolinks": {
+      "get": {
+        "summary": "List all autolinks of a repository",
+        "description": "This returns a list of autolinks configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.",
+        "tags": ["repos"],
+        "operationId": "repos/list-autolinks",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/enterprise-server@3.5/v3/repos#list-autolinks"
+        },
+        "parameters": [
+          { "$ref": "#/components/parameters/owner" },
+          { "$ref": "#/components/parameters/repo" },
+          { "$ref": "#/components/parameters/page" }
+        ],
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": { "$ref": "#/components/schemas/autolink" }
+                },
+                "examples": {
+                  "default": { "$ref": "#/components/examples/autolink-items" }
+                }
+              }
+            }
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "repos",
+          "subcategory": "autolinks"
+        },
+        "x-octokit": {
+          "diff": { "api.github.com.json": { "type": "changed" } }
+        }
+      },
+      "post": {
+        "summary": "Create an autolink reference for a repository",
+        "description": "Users with admin access to the repository can create an autolink.",
+        "tags": ["repos"],
+        "operationId": "repos/create-autolink",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/enterprise-server@3.5/v3/repos#create-an-autolink"
+        },
+        "parameters": [
+          { "$ref": "#/components/parameters/owner" },
+          { "$ref": "#/components/parameters/repo" }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "key_prefix": {
+                    "type": "string",
+                    "description": "The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit."
+                  },
+                  "url_template": {
+                    "type": "string",
+                    "description": "The URL must contain `<num>` for the reference number."
+                  }
+                },
+                "required": ["key_prefix", "url_template"]
+              },
+              "examples": {
+                "default": {
+                  "value": {
+                    "key_prefix": "TICKET-",
+                    "url_template": "https://example.com/TICKET?query=<num>"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "response",
+            "content": {
+              "application/json": {
+                "schema": { "$ref": "#/components/schemas/autolink" },
+                "examples": {
+                  "default": { "$ref": "#/components/examples/autolink" }
+                }
+              }
+            },
+            "headers": {
+              "Location": {
+                "example": "https://api.github.com/repos/octocat/Hello-World/autolinks/1",
+                "schema": { "type": "string" }
+              }
+            }
+          },
+          "422": { "$ref": "#/components/responses/validation_failed" }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "repos",
+          "subcategory": "autolinks"
+        },
+        "x-octokit": {
+          "diff": { "api.github.com.json": { "type": "changed" } }
+        }
+      }
+    },
+    "/repos/{owner}/{repo}/autolinks/{autolink_id}": {
+      "get": {
+        "summary": "Get an autolink reference of a repository",
+        "description": "This returns a single autolink reference by ID that was configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.",
+        "tags": ["repos"],
+        "operationId": "repos/get-autolink",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/enterprise-server@3.5/v3/repos#get-autolink"
+        },
+        "parameters": [
+          { "$ref": "#/components/parameters/owner" },
+          { "$ref": "#/components/parameters/repo" },
+          { "$ref": "#/components/parameters/autolink-id" }
+        ],
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": { "$ref": "#/components/schemas/autolink" },
+                "examples": {
+                  "default": { "$ref": "#/components/examples/autolink" }
+                }
+              }
+            }
+          },
+          "404": { "$ref": "#/components/responses/not_found" }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "repos",
+          "subcategory": "autolinks"
+        },
+        "x-octokit": {
+          "diff": { "api.github.com.json": { "type": "changed" } }
+        }
+      }
+    },
     "/repos/{owner}/{repo}/check-suites": {
       "post": {
         "summary": "Create a check suite",
@@ -5809,83 +5963,6 @@
         }
       }
     },
-    "/repos/{owner}/{repo}/code-scanning/alerts": {
-      "get": {
-        "summary": "List code scanning alerts for a repository",
-        "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint with private repos, the `public_repo` scope also grants permission to read\nsecurity events on public repos only. GitHub Apps must have the `security_events` read\npermission to use this endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used `ref` in the request).",
-        "tags": ["code-scanning"],
-        "operationId": "code-scanning/list-alerts-for-repo",
-        "externalDocs": {
-          "description": "API method documentation",
-          "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository"
-        },
-        "parameters": [
-          { "$ref": "#/components/parameters/owner" },
-          { "$ref": "#/components/parameters/repo" },
-          { "$ref": "#/components/parameters/tool-name" },
-          { "$ref": "#/components/parameters/tool-guid" },
-          { "$ref": "#/components/parameters/page" },
-          { "$ref": "#/components/parameters/per-page" },
-          { "$ref": "#/components/parameters/git-ref" },
-          { "$ref": "#/components/parameters/direction" },
-          {
-            "name": "sort",
-            "description": "The property by which to sort the results.",
-            "in": "query",
-            "required": false,
-            "schema": {
-              "type": "string",
-              "enum": ["created", "updated", "number"],
-              "default": "number"
-            }
-          },
-          {
-            "name": "state",
-            "description": "Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state.",
-            "in": "query",
-            "required": false,
-            "schema": {
-              "$ref": "#/components/schemas/code-scanning-alert-state"
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "Response",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "array",
-                  "items": {
-                    "$ref": "#/components/schemas/code-scanning-alert-items"
-                  }
-                },
-                "examples": {
-                  "default": {
-                    "$ref": "#/components/examples/code-scanning-alert-items"
-                  }
-                }
-              }
-            }
-          },
-          "304": { "$ref": "#/components/responses/not_modified" },
-          "403": {
-            "$ref": "#/components/responses/code_scanning_forbidden_read"
-          },
-          "404": { "$ref": "#/components/responses/not_found" },
-          "503": { "$ref": "#/components/responses/service_unavailable" }
-        },
-        "x-github": {
-          "githubCloudOnly": false,
-          "enabledForGitHubApps": true,
-          "category": "code-scanning",
-          "subcategory": null
-        },
-        "x-octokit": {
-          "diff": { "api.github.com.json": { "type": "changed" } }
-        }
-      }
-    },
     "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": {
       "get": {
         "summary": "Get a code scanning alert",
@@ -11183,6 +11260,13 @@
         "required": true,
         "schema": { "oneOf": [{ "type": "integer" }, { "type": "string" }] }
       },
+      "autolink-id": {
+        "name": "autolink_id",
+        "description": "The unique identifier of the autolink.",
+        "in": "path",
+        "required": true,
+        "schema": { "type": "integer" }
+      },
       "check-suite-id": {
         "name": "check_suite_id",
         "description": "The unique identifier of the check suite.",
@@ -11190,13 +11274,6 @@
         "required": true,
         "schema": { "type": "integer" }
       },
-      "git-ref": {
-        "name": "ref",
-        "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/<branch name>` or simply `<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.",
-        "in": "query",
-        "required": false,
-        "schema": { "$ref": "#/components/schemas/code-scanning-ref" }
-      },
       "alert-number": {
         "name": "alert_number",
         "in": "path",
@@ -13124,7 +13201,7 @@
             "$ref": "#/components/schemas/nullable-integration"
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "reactions": { "$ref": "#/components/schemas/reaction-rollup" }
         },
@@ -15122,6 +15199,25 @@
           "pull_requests"
         ]
       },
+      "autolink": {
+        "title": "Autolink reference",
+        "description": "An autolink reference.",
+        "type": "object",
+        "properties": {
+          "id": { "type": "integer", "example": 3 },
+          "key_prefix": {
+            "description": "The prefix of a key that is linkified.",
+            "example": "TICKET-",
+            "type": "string"
+          },
+          "url_template": {
+            "description": "A template for the target URL that is generated if a key was found.",
+            "example": "https://example.com/TICKET?query=<num>",
+            "type": "string"
+          }
+        },
+        "required": ["id", "key_prefix", "url_template"]
+      },
       "check-suite": {
         "title": "CheckSuite",
         "description": "A suite of checks performed on the code of a given code change",
@@ -15242,55 +15338,6 @@
           "repository": { "$ref": "#/components/schemas/minimal-repository" }
         }
       },
-      "code-scanning-alert-items": {
-        "type": "object",
-        "properties": {
-          "number": { "$ref": "#/components/schemas/alert-number" },
-          "created_at": { "$ref": "#/components/schemas/alert-created-at" },
-          "updated_at": { "$ref": "#/components/schemas/alert-updated-at" },
-          "url": { "$ref": "#/components/schemas/alert-url" },
-          "html_url": { "$ref": "#/components/schemas/alert-html-url" },
-          "instances_url": {
-            "$ref": "#/components/schemas/alert-instances-url"
-          },
-          "state": { "$ref": "#/components/schemas/code-scanning-alert-state" },
-          "fixed_at": {
-            "$ref": "#/components/schemas/code-scanning-alert-fixed-at"
-          },
-          "dismissed_by": {
-            "$ref": "#/components/schemas/nullable-simple-user"
-          },
-          "dismissed_at": {
-            "$ref": "#/components/schemas/code-scanning-alert-dismissed-at"
-          },
-          "dismissed_reason": {
-            "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason"
-          },
-          "rule": {
-            "$ref": "#/components/schemas/code-scanning-alert-rule-summary"
-          },
-          "tool": {
-            "$ref": "#/components/schemas/code-scanning-analysis-tool"
-          },
-          "most_recent_instance": {
-            "$ref": "#/components/schemas/code-scanning-alert-instance"
-          }
-        },
-        "required": [
-          "number",
-          "created_at",
-          "url",
-          "html_url",
-          "instances_url",
-          "state",
-          "dismissed_by",
-          "dismissed_at",
-          "dismissed_reason",
-          "rule",
-          "tool",
-          "most_recent_instance"
-        ]
-      },
       "code-scanning-alert": {
         "type": "object",
         "properties": {
@@ -15706,9 +15753,9 @@
             ]
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
-          "auto_merge": { "$ref": "#/components/schemas/auto_merge" },
+          "auto_merge": { "$ref": "#/components/schemas/auto-merge" },
           "draft": {
             "description": "Indicates whether or not the pull request is a draft.",
             "example": false,
@@ -15824,7 +15871,7 @@
           },
           "rename": { "$ref": "#/components/schemas/issue-event-rename" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "lock_reason": { "type": "string", "nullable": true },
           "performed_via_github_app": {
@@ -16180,7 +16227,7 @@
           "body": { "type": "string" },
           "score": { "type": "number" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "draft": { "type": "boolean" },
           "repository": { "$ref": "#/components/schemas/repository" },
@@ -17088,7 +17135,7 @@
           },
           "issue_url": { "type": "string", "format": "uri" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "performed_via_github_app": {
             "$ref": "#/components/schemas/nullable-integration"
@@ -17107,7 +17154,7 @@
           "updated_at"
         ]
       },
-      "author_association": {
+      "author-association": {
         "title": "author_association",
         "type": "string",
         "example": "OWNER",
@@ -18358,36 +18405,6 @@
           "committer"
         ]
       },
-      "code-scanning-alert-rule-summary": {
-        "type": "object",
-        "properties": {
-          "id": {
-            "nullable": true,
-            "type": "string",
-            "description": "A unique identifier for the rule used to detect the alert."
-          },
-          "name": {
-            "type": "string",
-            "description": "The name of the rule used to detect the alert."
-          },
-          "tags": {
-            "nullable": true,
-            "type": "array",
-            "description": "A set of tags applicable for the rule.",
-            "items": { "type": "string" }
-          },
-          "severity": {
-            "nullable": true,
-            "type": "string",
-            "description": "The severity of the alert.",
-            "enum": ["none", "note", "warning", "error"]
-          },
-          "description": {
-            "type": "string",
-            "description": "A short description of the rule used to detect the alert."
-          }
-        }
-      },
       "nullable-collaborator": {
         "title": "Collaborator",
         "description": "Collaborator",
@@ -18550,7 +18567,7 @@
         "properties": { "href": { "type": "string" } },
         "required": ["href"]
       },
-      "auto_merge": {
+      "auto-merge": {
         "title": "Auto merge",
         "description": "The status of auto merging a pull request.",
         "type": "object",
@@ -18742,7 +18759,7 @@
             "$ref": "#/components/schemas/nullable-integration"
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "reactions": { "$ref": "#/components/schemas/reaction-rollup" }
         },
@@ -23805,6 +23822,22 @@
           }
         }
       },
+      "autolink-items": {
+        "value": [
+          {
+            "id": 1,
+            "key_prefix": "TICKET-",
+            "url_template": "https://example.com/TICKET?query=<num>"
+          }
+        ]
+      },
+      "autolink": {
+        "value": {
+          "id": 1,
+          "key_prefix": "TICKET-",
+          "url_template": "https://example.com/TICKET?query=<num>"
+        }
+      },
       "check-suite": {
         "value": {
           "id": 5,
@@ -24300,105 +24333,6 @@
           }
         }
       },
-      "code-scanning-alert-items": {
-        "value": [
-          {
-            "number": 4,
-            "created_at": "2020-02-13T12:29:18Z",
-            "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4",
-            "html_url": "https://github.com/octocat/hello-world/code-scanning/4",
-            "state": "open",
-            "fixed_at": null,
-            "dismissed_by": null,
-            "dismissed_at": null,
-            "dismissed_reason": null,
-            "rule": {
-              "id": "js/zipslip",
-              "severity": "error",
-              "tags": ["security", "external/cwe/cwe-022"],
-              "description": "Arbitrary file write during zip extraction",
-              "name": "js/zipslip"
-            },
-            "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" },
-            "most_recent_instance": {
-              "ref": "refs/heads/main",
-              "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
-              "environment": "{}",
-              "state": "open",
-              "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
-              "message": {
-                "text": "This path depends on a user-provided value."
-              },
-              "location": {
-                "path": "spec-main/api-session-spec.ts",
-                "start_line": 917,
-                "end_line": 917,
-                "start_column": 7,
-                "end_column": 18
-              },
-              "classifications": ["test"]
-            },
-            "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances"
-          },
-          {
-            "number": 3,
-            "created_at": "2020-02-13T12:29:18Z",
-            "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3",
-            "html_url": "https://github.com/octocat/hello-world/code-scanning/3",
-            "state": "dismissed",
-            "fixed_at": null,
-            "dismissed_by": {
-              "login": "octocat",
-              "id": 1,
-              "node_id": "MDQ6VXNlcjE=",
-              "avatar_url": "https://github.com/images/error/octocat_happy.gif",
-              "gravatar_id": "",
-              "url": "https://api.github.com/users/octocat",
-              "html_url": "https://github.com/octocat",
-              "followers_url": "https://api.github.com/users/octocat/followers",
-              "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-              "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-              "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-              "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-              "organizations_url": "https://api.github.com/users/octocat/orgs",
-              "repos_url": "https://api.github.com/users/octocat/repos",
-              "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-              "received_events_url": "https://api.github.com/users/octocat/received_events",
-              "type": "User",
-              "site_admin": false
-            },
-            "dismissed_at": "2020-02-14T12:29:18Z",
-            "dismissed_reason": "false positive",
-            "rule": {
-              "id": "js/zipslip",
-              "severity": "error",
-              "tags": ["security", "external/cwe/cwe-022"],
-              "description": "Arbitrary file write during zip extraction",
-              "name": "js/zipslip"
-            },
-            "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" },
-            "most_recent_instance": {
-              "ref": "refs/heads/main",
-              "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
-              "environment": "{}",
-              "state": "open",
-              "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
-              "message": {
-                "text": "This path depends on a user-provided value."
-              },
-              "location": {
-                "path": "lib/ab12-gen.js",
-                "start_line": 917,
-                "end_line": 917,
-                "start_column": 7,
-                "end_column": 18
-              },
-              "classifications": []
-            },
-            "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances"
-          }
-        ]
-      },
       "code-scanning-alert": {
         "value": {
           "number": 42,