@octokit/openapi 6.3.1 → 6.6.0

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

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.3.1",
+    "version": "6.6.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" },
@@ -4802,6 +4802,58 @@
         }
       }
     },
+    "/rate_limit": {
+      "get": {
+        "summary": "Get rate limit status for the authenticated user",
+        "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.",
+        "tags": ["rate-limit"],
+        "operationId": "rate-limit/get",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/rate-limit#get-rate-limit-status-for-the-authenticated-user"
+        },
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/rate-limit-overview"
+                },
+                "examples": {
+                  "default": {
+                    "$ref": "#/components/examples/rate-limit-overview"
+                  }
+                }
+              }
+            },
+            "headers": {
+              "X-RateLimit-Limit": {
+                "$ref": "#/components/headers/x-rate-limit-limit"
+              },
+              "X-RateLimit-Remaining": {
+                "$ref": "#/components/headers/x-rate-limit-remaining"
+              },
+              "X-RateLimit-Reset": {
+                "$ref": "#/components/headers/x-rate-limit-reset"
+              }
+            }
+          },
+          "304": { "$ref": "#/components/responses/not_modified" },
+          "404": { "$ref": "#/components/responses/not_found" }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "rate-limit",
+          "subcategory": null
+        },
+        "x-octokit": {
+          "diff": { "api.github.com.json": { "type": "changed" } }
+        }
+      }
+    },
     "/repos/{owner}/{repo}": {
       "get": {
         "summary": "Get a repository",
@@ -5963,83 +6015,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",
@@ -11351,13 +11326,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",
@@ -14716,6 +14684,35 @@
           "updated_at"
         ]
       },
+      "rate-limit-overview": {
+        "title": "Rate Limit Overview",
+        "description": "Rate Limit Overview",
+        "type": "object",
+        "properties": {
+          "resources": {
+            "type": "object",
+            "properties": {
+              "core": { "$ref": "#/components/schemas/rate-limit" },
+              "graphql": { "$ref": "#/components/schemas/rate-limit" },
+              "search": { "$ref": "#/components/schemas/rate-limit" },
+              "source_import": { "$ref": "#/components/schemas/rate-limit" },
+              "integration_manifest": {
+                "$ref": "#/components/schemas/rate-limit"
+              },
+              "code_scanning_upload": {
+                "$ref": "#/components/schemas/rate-limit"
+              },
+              "actions_runner_registration": {
+                "$ref": "#/components/schemas/rate-limit"
+              },
+              "scim": { "$ref": "#/components/schemas/rate-limit" }
+            },
+            "required": ["core", "search"]
+          },
+          "rate": { "$ref": "#/components/schemas/rate-limit" }
+        },
+        "required": ["rate", "resources"]
+      },
       "full-repository": {
         "title": "Full Repository",
         "description": "Full Repository",
@@ -15422,55 +15419,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": {
@@ -18374,6 +18322,17 @@
         ],
         "nullable": true
       },
+      "rate-limit": {
+        "title": "Rate Limit",
+        "type": "object",
+        "properties": {
+          "limit": { "type": "integer" },
+          "remaining": { "type": "integer" },
+          "reset": { "type": "integer" },
+          "used": { "type": "integer" }
+        },
+        "required": ["limit", "remaining", "reset", "used"]
+      },
       "code-of-conduct-simple": {
         "title": "Code Of Conduct Simple",
         "description": "Code of Conduct Simple",
@@ -18538,36 +18497,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",
@@ -22599,6 +22528,48 @@
           "watchers": 1
         }
       },
+      "rate-limit-overview": {
+        "value": {
+          "resources": {
+            "core": {
+              "limit": 5000,
+              "remaining": 4999,
+              "reset": 1372700873,
+              "used": 1
+            },
+            "search": {
+              "limit": 30,
+              "remaining": 18,
+              "reset": 1372697452,
+              "used": 12
+            },
+            "graphql": {
+              "limit": 5000,
+              "remaining": 4993,
+              "reset": 1372700389,
+              "used": 7
+            },
+            "integration_manifest": {
+              "limit": 5000,
+              "remaining": 4999,
+              "reset": 1551806725,
+              "used": 1
+            },
+            "code_scanning_upload": {
+              "limit": 500,
+              "remaining": 499,
+              "reset": 1551806725,
+              "used": 1
+            }
+          },
+          "rate": {
+            "limit": 5000,
+            "remaining": 4999,
+            "reset": 1372700873,
+            "used": 1
+          }
+        }
+      },
       "full-repository-default-response": {
         "summary": "Default response",
         "value": {
@@ -24496,105 +24467,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,
@@ -29691,6 +29563,18 @@
       "link": {
         "example": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; rel=\"last\"",
         "schema": { "type": "string" }
+      },
+      "x-rate-limit-limit": {
+        "example": 5000,
+        "schema": { "type": "integer" }
+      },
+      "x-rate-limit-remaining": {
+        "example": 4999,
+        "schema": { "type": "integer" }
+      },
+      "x-rate-limit-reset": {
+        "example": 1590701888,
+        "schema": { "type": "integer", "format": "timestamp" }
       }
     },
     "responses": {