@octokit/openapi 11.0.0 → 11.1.1

package/generated/ghes-3.8.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "11.0.0",
+    "version": "11.1.1",
     "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": {
@@ -46711,7 +46711,7 @@
         "operationId": "gists/update",
         "externalDocs": {
           "description": "API method documentation",
-          "url": "https://docs.github.com/enterprise-server@3.8/rest/reference/gists/#update-a-gist"
+          "url": "https://docs.github.com/rest/reference/gists/#update-a-gist"
         },
         "parameters": [
           {
@@ -46729,6 +46729,7 @@
           "content": {
             "application/json": {
               "schema": {
+                "type": "object",
                 "properties": {
                   "description": {
                     "description": "The description of the gist.",
@@ -46745,29 +46746,21 @@
                     },
                     "type": "object",
                     "additionalProperties": {
-                      "type": "object",
-                      "nullable": true,
-                      "properties": {
-                        "content": {
-                          "description": "The new content of the file.",
-                          "type": "string"
-                        },
-                        "filename": {
-                          "description": "The new filename for the file.",
-                          "type": "string",
-                          "nullable": true
-                        }
-                      },
-                      "anyOf": [
-                        {
-                          "required": [
-                            "content"
-                          ]
-                        },
+                      "oneOf": [
                         {
-                          "required": [
-                            "filename"
-                          ]
+                          "type": "object",
+                          "nullable": true,
+                          "properties": {
+                            "content": {
+                              "description": "The new content of the file.",
+                              "type": "string"
+                            },
+                            "filename": {
+                              "description": "The new filename for the file.",
+                              "type": "string",
+                              "nullable": true
+                            }
+                          }
                         },
                         {
                           "type": "object",
@@ -46777,19 +46770,6 @@
                     }
                   }
                 },
-                "anyOf": [
-                  {
-                    "required": [
-                      "description"
-                    ]
-                  },
-                  {
-                    "required": [
-                      "files"
-                    ]
-                  }
-                ],
-                "type": "object",
                 "nullable": true
               },
               "examples": {
@@ -230718,7 +230698,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"
         ],
@@ -331797,14 +331777,14 @@
       },
       "post": {
         "summary": "Request reviewers for a pull request",
-        "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.8/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.8/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
+        "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
         "tags": [
           "pulls"
         ],
         "operationId": "pulls/request-reviewers",
         "externalDocs": {
           "description": "API method documentation",
-          "url": "https://docs.github.com/enterprise-server@3.8/rest/reference/pulls#request-reviewers-for-a-pull-request"
+          "url": "https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request"
         },
         "parameters": [
           {
@@ -331856,19 +331836,7 @@
                       "type": "string"
                     }
                   }
-                },
-                "anyOf": [
-                  {
-                    "required": [
-                      "reviewers"
-                    ]
-                  },
-                  {
-                    "required": [
-                      "team_reviewers"
-                    ]
-                  }
-                ]
+                }
               },
               "examples": {
                 "default": {
@@ -332782,6 +332750,9 @@
                           "privacy": {
                             "type": "string"
                           },
+                          "notification_setting": {
+                            "type": "string"
+                          },
                           "permission": {
                             "type": "string"
                           },
@@ -332873,6 +332844,11 @@
                                 "type": "string",
                                 "example": "closed"
                               },
+                              "notification_setting": {
+                                "description": "The notification setting the team has set",
+                                "type": "string",
+                                "example": "notifications_enabled"
+                              },
                               "html_url": {
                                 "type": "string",
                                 "format": "uri",
@@ -336161,6 +336137,7 @@
                           "slug": "justice-league",
                           "description": "A great team.",
                           "privacy": "closed",
+                          "notification_setting": "notifications_enabled",
                           "permission": "admin",
                           "members_url": "https://api.github.com/teams/1/members{/member}",
                           "repositories_url": "https://api.github.com/teams/1/repos",
@@ -336490,6 +336467,7 @@
                         }
                       },
                       "author_association": "OWNER",
+                      "auto_merge": null,
                       "draft": false
                     }
                   }
@@ -336534,13 +336512,7 @@
           "category": "pulls",
           "subcategory": "review-requests"
         },
-        "x-octokit": {
-          "diff": {
-            "api.github.com": {
-              "type": "changed"
-            }
-          }
-        }
+        "x-octokit": {}
       },
       "delete": {
         "summary": "Remove requested reviewers from a pull request",
@@ -443385,6 +443357,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 does not exist in GitHub Enterprise Server 3.8. It was added in api.github.com",
+        "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}/timing": {
       "get": {
         "summary": "Get workflow run usage",
@@ -443815,6 +443809,112 @@
         }
       }
     },
+    "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": {
+      "get": {
+        "summary": "Get all deployment protection rules for an environment",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.8. It was added in api.github.com",
+        "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 does not exist in GitHub Enterprise Server 3.8. It was added in api.github.com",
+        "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 does not exist in GitHub Enterprise Server 3.8. It was added in api.github.com",
+        "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 does not exist in GitHub Enterprise Server 3.8. It was added in api.github.com",
+        "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 does not exist in GitHub Enterprise Server 3.8. It was added in api.github.com",
+        "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",
@@ -444259,6 +444359,28 @@
         }
       }
     },
+    "/repos/{owner}/{repo}/security-advisories/reports": {
+      "post": {
+        "summary": "Privately report a security vulnerability",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.8. It was added in api.github.com",
+        "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",
@@ -666548,7 +666670,17 @@
                           },
                           "docker_metadata": {
                             "type": "array",
-                            "items": {}
+                            "items": {
+                              "type": "object",
+                              "properties": {
+                                "tags": {
+                                  "type": "array",
+                                  "items": {
+                                    "type": "string"
+                                  }
+                                }
+                              }
+                            }
                           },
                           "draft": {
                             "type": "boolean"
@@ -666978,7 +667110,56 @@
                           },
                           "rubygems_metadata": {
                             "type": "array",
-                            "items": {}
+                            "items": {
+                              "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"
+                                }
+                              }
+                            }
                           },
                           "source_url": {
                             "type": "string"
@@ -668900,7 +669081,17 @@
                           },
                           "docker_metadata": {
                             "type": "array",
-                            "items": {}
+                            "items": {
+                              "type": "object",
+                              "properties": {
+                                "tags": {
+                                  "type": "array",
+                                  "items": {
+                                    "type": "string"
+                                  }
+                                }
+                              }
+                            }
                           },
                           "draft": {
                             "type": "boolean"
@@ -668920,7 +669111,10 @@
                           },
                           "metadata": {
                             "type": "array",
-                            "items": {}
+                            "items": {
+                              "type": "object",
+                              "additionalProperties": true
+                            }
                           },
                           "name": {
                             "type": "string"
@@ -669132,7 +669326,56 @@
                           },
                           "rubygems_metadata": {
                             "type": "array",
-                            "items": {}
+                            "items": {
+                              "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"
+                                }
+                              }
+                            }
                           },
                           "source_url": {
                             "type": "string",
@@ -837884,7 +838127,17 @@
                           },
                           "docker_metadata": {
                             "type": "array",
-                            "items": {}
+                            "items": {
+                              "type": "object",
+                              "properties": {
+                                "tags": {
+                                  "type": "array",
+                                  "items": {
+                                    "type": "string"
+                                  }
+                                }
+                              }
+                            }
                           },
                           "draft": {
                             "type": "boolean"
@@ -838303,7 +838556,56 @@
                           },
                           "rubygems_metadata": {
                             "type": "array",
-                            "items": {}
+                            "items": {
+                              "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"
+                                }
+                              }
+                            }
                           },
                           "summary": {
                             "type": "string"
@@ -840182,7 +840484,16 @@
                           "docker_metadata": {
                             "type": "array",
                             "items": {
-                              "nullable": true
+                              "type": "object",
+                              "nullable": true,
+                              "properties": {
+                                "tags": {
+                                  "type": "array",
+                                  "items": {
+                                    "type": "string"
+                                  }
+                                }
+                              }
                             }
                           },
                           "draft": {
@@ -840202,7 +840513,10 @@
                           },
                           "metadata": {
                             "type": "array",
-                            "items": {}
+                            "items": {
+                              "type": "object",
+                              "additionalProperties": true
+                            }
                           },
                           "name": {
                             "type": "string"
@@ -840385,7 +840699,56 @@
                           },
                           "rubygems_metadata": {
                             "type": "array",
-                            "items": {}
+                            "items": {
+                              "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"
+                                }
+                              }
+                            }
                           },
                           "summary": {
                             "type": "string"