@octokit/openapi 11.0.0 → 11.1.0

package/generated/github.ae.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "11.0.0",
+    "version": "11.1.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": {
@@ -27936,7 +27936,7 @@
     "/repos/{owner}/{repo}/events": {
       "get": {
         "summary": "List repository events",
-        "description": "",
+        "description": "**Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.\n",
         "tags": [
           "activity"
         ],
@@ -40419,7 +40419,7 @@
     "/search/code": {
       "get": {
         "summary": "Search code",
-        "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\n#### Considerations for code search\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n*   Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n*   Only files smaller than 384 KB are searchable.\n*   You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\n**Note:** Starting on April 10, 2023, code search on GitHub.com will have a separate\nrate limit from other search types, of 10 requests per minute, and all code\nsearch requests will require authentication. For more information, see [this blog post](https://github.blog/changelog/2023-03-10-changes-to-the-code-search-api/).",
+        "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\n#### Considerations for code search\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n*   Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n*   Only files smaller than 384 KB are searchable.\n*   You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.",
         "tags": [
           "search"
         ],
@@ -40441,7 +40441,7 @@
           {
             "name": "sort",
             "deprecated": true,
-            "description": "**Note: This field is deprecated, and will be ignored after April 10, 2023 (except on GitHub Enterprise Server).** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub AE search infrastructure. Default: [best match](https://docs.github.com/github-ae@latest/rest/reference/search#ranking-search-results)",
+            "description": "**This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub AE search infrastructure. Default: [best match](https://docs.github.com/github-ae@latest/rest/reference/search#ranking-search-results)",
             "in": "query",
             "required": false,
             "schema": {
@@ -40453,7 +40453,7 @@
           },
           {
             "name": "order",
-            "description": "**Note: This field is deprecated, and will be ignored after April 10, 2023 (except on GitHub Enterprise Server).** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. ",
+            "description": "**This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. ",
             "in": "query",
             "deprecated": true,
             "required": false,
@@ -50071,6 +50071,28 @@
         }
       }
     },
+    "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": {
+      "post": {
+        "summary": "Review custom deployment protection rules for a workflow run",
+        "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
+        "tags": [
+          "actions"
+        ],
+        "operationId": "actions/review-custom-gates-for-run",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run"
+        },
+        "x-octokit": {
+          "api.github.com": "removed"
+        },
+        "responses": {
+          "501": {
+            "description": "Not Implemented"
+          }
+        }
+      }
+    },
     "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": {
       "get": {
         "summary": "Get pending deployments for a workflow run",
@@ -50861,6 +50883,112 @@
         }
       }
     },
+    "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": {
+      "get": {
+        "summary": "Get all deployment protection rules for an environment",
+        "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
+        "tags": [
+          "repos"
+        ],
+        "operationId": "repos/get-all-deployment-protection-rules",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules"
+        },
+        "x-octokit": {
+          "api.github.com": "removed"
+        },
+        "responses": {
+          "501": {
+            "description": "Not Implemented"
+          }
+        }
+      },
+      "post": {
+        "summary": "Create a custom deployment protection rule on an environment",
+        "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
+        "tags": [
+          "repos"
+        ],
+        "operationId": "repos/create-deployment-protection-rule",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/deployments/deployment-protection-rules#create-a-deployment-protection-rule"
+        },
+        "x-octokit": {
+          "api.github.com": "removed"
+        },
+        "responses": {
+          "501": {
+            "description": "Not Implemented"
+          }
+        }
+      }
+    },
+    "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": {
+      "get": {
+        "summary": "List custom deployment rule integrations available for an environment",
+        "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
+        "tags": [
+          "repos"
+        ],
+        "operationId": "repos/list-custom-deployment-rule-integrations",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations"
+        },
+        "x-octokit": {
+          "api.github.com": "removed"
+        },
+        "responses": {
+          "501": {
+            "description": "Not Implemented"
+          }
+        }
+      }
+    },
+    "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": {
+      "get": {
+        "summary": "Get a custom deployment protection rule",
+        "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
+        "tags": [
+          "repos"
+        ],
+        "operationId": "repos/get-custom-deployment-protection-rule",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/deployments/protection-rules#get-a-deployment-protection-rule"
+        },
+        "x-octokit": {
+          "api.github.com": "removed"
+        },
+        "responses": {
+          "501": {
+            "description": "Not Implemented"
+          }
+        }
+      },
+      "delete": {
+        "summary": "Disable a custom protection rule for an environment",
+        "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
+        "tags": [
+          "repos"
+        ],
+        "operationId": "repos/disable-deployment-protection-rule",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/deployments/protection-rules#disable-deployment-protection-rule"
+        },
+        "x-octokit": {
+          "api.github.com": "removed"
+        },
+        "responses": {
+          "501": {
+            "description": "Not Implemented"
+          }
+        }
+      }
+    },
     "/repos/{owner}/{repo}/import": {
       "get": {
         "summary": "Get an import status",
@@ -51349,6 +51477,28 @@
         }
       }
     },
+    "/repos/{owner}/{repo}/security-advisories/reports": {
+      "post": {
+        "summary": "Privately report a security vulnerability",
+        "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
+        "tags": [
+          "security-advisories"
+        ],
+        "operationId": "security-advisories/create-private-vulnerability-report",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability"
+        },
+        "x-octokit": {
+          "api.github.com": "removed"
+        },
+        "responses": {
+          "501": {
+            "description": "Not Implemented"
+          }
+        }
+      }
+    },
     "/repos/{owner}/{repo}/security-advisories/{ghsa_id}": {
       "get": {
         "summary": "Get a repository security advisory",
@@ -56207,6 +56357,97 @@
         }
       }
     },
+    "deployment-protection-rule-requested": {
+      "post": {
+        "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/github-ae@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/github-ae@latest/rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.",
+        "description": "A deployment protection rule was requested for an environment.",
+        "operationId": "deployment-protection-rule/requested",
+        "externalDocs": {
+          "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment_protection_rule"
+        },
+        "parameters": [
+          {
+            "name": "User-Agent",
+            "in": "header",
+            "example": "GitHub-Hookshot/123abc",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "X-Github-Hook-Id",
+            "in": "header",
+            "example": 12312312,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "X-Github-Event",
+            "in": "header",
+            "example": "issues",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "X-Github-Hook-Installation-Target-Id",
+            "in": "header",
+            "example": 123123,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "X-Github-Hook-Installation-Target-Type",
+            "in": "header",
+            "example": "repository",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "X-GitHub-Delivery",
+            "in": "header",
+            "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "X-Hub-Signature-256",
+            "in": "header",
+            "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Return a 200 status to indicate that the data was received successfully"
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "category": "webhooks",
+          "subcategory": "deployment-protection-rule",
+          "supported-webhook-types": [
+            "app"
+          ]
+        }
+      }
+    },
     "deployment-status-created": {
       "post": {
         "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/github-ae@latest/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/github-ae@latest/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.",
@@ -104318,6 +104559,52 @@
           "sender"
         ]
       },
+      "webhook-deployment-protection-rule-requested": {
+        "title": "deployment protection rule requested event",
+        "type": "object",
+        "properties": {
+          "action": {
+            "type": "string",
+            "enum": [
+              "requested"
+            ]
+          },
+          "environment": {
+            "description": "The name of the environment that has the deployment protection rule.",
+            "type": "string"
+          },
+          "event": {
+            "description": "The event that triggered the deployment protection rule.",
+            "type": "string"
+          },
+          "deployment_callback_url": {
+            "description": "The URL to review the deployment protection rule.",
+            "type": "string",
+            "format": "uri"
+          },
+          "deployment": {
+            "$ref": "#/components/schemas/deployment"
+          },
+          "pull_requests": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/pull-request"
+            }
+          },
+          "repository": {
+            "$ref": "#/components/schemas/repository"
+          },
+          "organization": {
+            "$ref": "#/components/schemas/organization-simple"
+          },
+          "installation": {
+            "$ref": "#/components/schemas/simple-installation"
+          },
+          "sender": {
+            "$ref": "#/components/schemas/simple-user"
+          }
+        }
+      },
       "webhook-deployment-status-created": {
         "title": "deployment_status created event",
         "type": "object",
@@ -145048,6 +145335,56 @@
           "sender"
         ]
       },
+      "webhook-rubygems-metadata": {
+        "title": "Ruby Gems metadata",
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string"
+          },
+          "readme": {
+            "type": "string"
+          },
+          "homepage": {
+            "type": "string"
+          },
+          "version_info": {
+            "type": "object",
+            "properties": {
+              "version": {
+                "type": "string"
+              }
+            }
+          },
+          "platform": {
+            "type": "string"
+          },
+          "metadata": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string"
+            }
+          },
+          "repo": {
+            "type": "string"
+          },
+          "dependencies": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              }
+            }
+          },
+          "commit_oid": {
+            "type": "string"
+          }
+        }
+      },
       "webhook-package-published": {
         "title": "package published event",
         "type": "object",
@@ -145332,7 +145669,17 @@
                   },
                   "docker_metadata": {
                     "type": "array",
-                    "items": {}
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "tags": {
+                          "type": "array",
+                          "items": {
+                            "type": "string"
+                          }
+                        }
+                      }
+                    }
                   },
                   "draft": {
                     "type": "boolean"
@@ -145762,7 +146109,9 @@
                   },
                   "rubygems_metadata": {
                     "type": "array",
-                    "items": {}
+                    "items": {
+                      "$ref": "#/components/schemas/webhook-rubygems-metadata"
+                    }
                   },
                   "source_url": {
                     "type": "string"
@@ -146111,7 +146460,17 @@
                   },
                   "docker_metadata": {
                     "type": "array",
-                    "items": {}
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "tags": {
+                          "type": "array",
+                          "items": {
+                            "type": "string"
+                          }
+                        }
+                      }
+                    }
                   },
                   "draft": {
                     "type": "boolean"
@@ -146131,7 +146490,10 @@
                   },
                   "metadata": {
                     "type": "array",
-                    "items": {}
+                    "items": {
+                      "type": "object",
+                      "additionalProperties": true
+                    }
                   },
                   "name": {
                     "type": "string"
@@ -146343,7 +146705,9 @@
                   },
                   "rubygems_metadata": {
                     "type": "array",
-                    "items": {}
+                    "items": {
+                      "$ref": "#/components/schemas/webhook-rubygems-metadata"
+                    }
                   },
                   "source_url": {
                     "type": "string",
@@ -220905,7 +221269,17 @@
                   },
                   "docker_metadata": {
                     "type": "array",
-                    "items": {}
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "tags": {
+                          "type": "array",
+                          "items": {
+                            "type": "string"
+                          }
+                        }
+                      }
+                    }
                   },
                   "draft": {
                     "type": "boolean"
@@ -221324,7 +221698,9 @@
                   },
                   "rubygems_metadata": {
                     "type": "array",
-                    "items": {}
+                    "items": {
+                      "$ref": "#/components/schemas/webhook-rubygems-metadata"
+                    }
                   },
                   "summary": {
                     "type": "string"
@@ -221630,7 +222006,16 @@
                   "docker_metadata": {
                     "type": "array",
                     "items": {
-                      "nullable": true
+                      "type": "object",
+                      "nullable": true,
+                      "properties": {
+                        "tags": {
+                          "type": "array",
+                          "items": {
+                            "type": "string"
+                          }
+                        }
+                      }
                     }
                   },
                   "draft": {
@@ -221650,7 +222035,10 @@
                   },
                   "metadata": {
                     "type": "array",
-                    "items": {}
+                    "items": {
+                      "type": "object",
+                      "additionalProperties": true
+                    }
                   },
                   "name": {
                     "type": "string"
@@ -221833,7 +222221,9 @@
                   },
                   "rubygems_metadata": {
                     "type": "array",
-                    "items": {}
+                    "items": {
+                      "$ref": "#/components/schemas/webhook-rubygems-metadata"
+                    }
                   },
                   "summary": {
                     "type": "string"

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "11.0.0",
+  "version": "11.1.0",
   "description": "GitHub's official OpenAPI spec with Octokit extensions",
   "main": "index.js",
   "files": [