@octokit/openapi 7.2.0 → 7.5.0

package/generated/ghes-3.5.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "7.2.0",
+    "version": "7.5.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": {
@@ -4087,6 +4087,14 @@
                                   "write"
                                 ]
                               },
+                              "organization_custom_roles": {
+                                "type": "string",
+                                "description": "The level of permission to grant the access token for custom roles management.",
+                                "enum": [
+                                  "read",
+                                  "write"
+                                ]
+                              },
                               "deployments": {
                                 "type": "string",
                                 "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -5169,6 +5177,14 @@
                                 "write"
                               ]
                             },
+                            "organization_custom_roles": {
+                              "type": "string",
+                              "description": "The level of permission to grant the access token for custom roles management.",
+                              "enum": [
+                                "read",
+                                "write"
+                              ]
+                            },
                             "deployments": {
                               "type": "string",
                               "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -5833,6 +5849,14 @@
                                 "write"
                               ]
                             },
+                            "organization_custom_roles": {
+                              "type": "string",
+                              "description": "The level of permission to grant the access token for custom roles management.",
+                              "enum": [
+                                "read",
+                                "write"
+                              ]
+                            },
                             "deployments": {
                               "type": "string",
                               "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -8402,6 +8426,14 @@
                               "write"
                             ]
                           },
+                          "organization_custom_roles": {
+                            "type": "string",
+                            "description": "The level of permission to grant the access token for custom roles management.",
+                            "enum": [
+                              "read",
+                              "write"
+                            ]
+                          },
                           "deployments": {
                             "type": "string",
                             "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -9191,6 +9223,14 @@
                             "write"
                           ]
                         },
+                        "organization_custom_roles": {
+                          "type": "string",
+                          "description": "The level of permission to grant the access token for custom roles management.",
+                          "enum": [
+                            "read",
+                            "write"
+                          ]
+                        },
                         "deployments": {
                           "type": "string",
                           "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -9844,6 +9884,14 @@
                           "write"
                         ]
                       },
+                      "organization_custom_roles": {
+                        "type": "string",
+                        "description": "The level of permission to grant the access token for custom roles management.",
+                        "enum": [
+                          "read",
+                          "write"
+                        ]
+                      },
                       "deployments": {
                         "type": "string",
                         "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -10129,6 +10177,14 @@
                             "write"
                           ]
                         },
+                        "organization_custom_roles": {
+                          "type": "string",
+                          "description": "The level of permission to grant the access token for custom roles management.",
+                          "enum": [
+                            "read",
+                            "write"
+                          ]
+                        },
                         "deployments": {
                           "type": "string",
                           "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -13104,6 +13160,14 @@
                                 "write"
                               ]
                             },
+                            "organization_custom_roles": {
+                              "type": "string",
+                              "description": "The level of permission to grant the access token for custom roles management.",
+                              "enum": [
+                                "read",
+                                "write"
+                              ]
+                            },
                             "deployments": {
                               "type": "string",
                               "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -13947,6 +14011,14 @@
                                 "write"
                               ]
                             },
+                            "organization_custom_roles": {
+                              "type": "string",
+                              "description": "The level of permission to grant the access token for custom roles management.",
+                              "enum": [
+                                "read",
+                                "write"
+                              ]
+                            },
                             "deployments": {
                               "type": "string",
                               "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -14714,6 +14786,14 @@
                           "write"
                         ]
                       },
+                      "organization_custom_roles": {
+                        "type": "string",
+                        "description": "The level of permission to grant the access token for custom roles management.",
+                        "enum": [
+                          "read",
+                          "write"
+                        ]
+                      },
                       "deployments": {
                         "type": "string",
                         "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -15189,6 +15269,14 @@
                                 "write"
                               ]
                             },
+                            "organization_custom_roles": {
+                              "type": "string",
+                              "description": "The level of permission to grant the access token for custom roles management.",
+                              "enum": [
+                                "read",
+                                "write"
+                              ]
+                            },
                             "deployments": {
                               "type": "string",
                               "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -16486,6 +16574,14 @@
                                   "write"
                                 ]
                               },
+                              "organization_custom_roles": {
+                                "type": "string",
+                                "description": "The level of permission to grant the access token for custom roles management.",
+                                "enum": [
+                                  "read",
+                                  "write"
+                                ]
+                              },
                               "deployments": {
                                 "type": "string",
                                 "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -17339,6 +17435,14 @@
                                 "write"
                               ]
                             },
+                            "organization_custom_roles": {
+                              "type": "string",
+                              "description": "The level of permission to grant the access token for custom roles management.",
+                              "enum": [
+                                "read",
+                                "write"
+                              ]
+                            },
                             "deployments": {
                               "type": "string",
                               "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -18261,6 +18365,14 @@
                                 "write"
                               ]
                             },
+                            "organization_custom_roles": {
+                              "type": "string",
+                              "description": "The level of permission to grant the access token for custom roles management.",
+                              "enum": [
+                                "read",
+                                "write"
+                              ]
+                            },
                             "deployments": {
                               "type": "string",
                               "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -18933,6 +19045,14 @@
                                 "write"
                               ]
                             },
+                            "organization_custom_roles": {
+                              "type": "string",
+                              "description": "The level of permission to grant the access token for custom roles management.",
+                              "enum": [
+                                "read",
+                                "write"
+                              ]
+                            },
                             "deployments": {
                               "type": "string",
                               "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -19833,6 +19953,14 @@
                                 "write"
                               ]
                             },
+                            "organization_custom_roles": {
+                              "type": "string",
+                              "description": "The level of permission to grant the access token for custom roles management.",
+                              "enum": [
+                                "read",
+                                "write"
+                              ]
+                            },
                             "deployments": {
                               "type": "string",
                               "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -20505,6 +20633,14 @@
                                 "write"
                               ]
                             },
+                            "organization_custom_roles": {
+                              "type": "string",
+                              "description": "The level of permission to grant the access token for custom roles management.",
+                              "enum": [
+                                "read",
+                                "write"
+                              ]
+                            },
                             "deployments": {
                               "type": "string",
                               "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -21283,6 +21419,14 @@
                                 "write"
                               ]
                             },
+                            "organization_custom_roles": {
+                              "type": "string",
+                              "description": "The level of permission to grant the access token for custom roles management.",
+                              "enum": [
+                                "read",
+                                "write"
+                              ]
+                            },
                             "deployments": {
                               "type": "string",
                               "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -22088,6 +22232,14 @@
                                 "write"
                               ]
                             },
+                            "organization_custom_roles": {
+                              "type": "string",
+                              "description": "The level of permission to grant the access token for custom roles management.",
+                              "enum": [
+                                "read",
+                                "write"
+                              ]
+                            },
                             "deployments": {
                               "type": "string",
                               "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -60079,6 +60231,7 @@
         "parameters": [
           {
             "name": "organization_id",
+            "description": "The unique identifier of the organization.",
             "in": "path",
             "required": true,
             "schema": {
@@ -60532,7 +60685,13 @@
           "category": "orgs",
           "subcategory": null
         },
-        "x-octokit": {}
+        "x-octokit": {
+          "diff": {
+            "ghes-3.6": {
+              "type": "changed"
+            }
+          }
+        }
       },
       "patch": {
         "summary": "Update an organization",
@@ -61122,7 +61281,13 @@
           "category": "orgs",
           "subcategory": null
         },
-        "x-octokit": {}
+        "x-octokit": {
+          "diff": {
+            "ghes-3.6": {
+              "type": "changed"
+            }
+          }
+        }
       }
     },
     "/orgs/{org}/actions/cache/usage": {
@@ -82908,6 +83073,14 @@
                             "write"
                           ]
                         },
+                        "organization_custom_roles": {
+                          "type": "string",
+                          "description": "The level of permission to grant the access token for custom roles management.",
+                          "enum": [
+                            "read",
+                            "write"
+                          ]
+                        },
                         "deployments": {
                           "type": "string",
                           "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -83711,6 +83884,14 @@
                                   "write"
                                 ]
                               },
+                              "organization_custom_roles": {
+                                "type": "string",
+                                "description": "The level of permission to grant the access token for custom roles management.",
+                                "enum": [
+                                  "read",
+                                  "write"
+                                ]
+                              },
                               "deployments": {
                                 "type": "string",
                                 "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -97280,6 +97461,40 @@
                     "type": "boolean",
                     "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
                     "default": false
+                  },
+                  "squash_merge_commit_title": {
+                    "type": "string",
+                    "enum": [
+                      "PR_TITLE",
+                      "COMMIT_OR_PR_TITLE"
+                    ],
+                    "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
+                  },
+                  "squash_merge_commit_message": {
+                    "type": "string",
+                    "enum": [
+                      "PR_BODY",
+                      "COMMIT_MESSAGES",
+                      "BLANK"
+                    ],
+                    "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
+                  },
+                  "merge_commit_title": {
+                    "type": "string",
+                    "enum": [
+                      "PR_TITLE",
+                      "MERGE_MESSAGE"
+                    ],
+                    "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
+                  },
+                  "merge_commit_message": {
+                    "type": "string",
+                    "enum": [
+                      "PR_BODY",
+                      "PR_TITLE",
+                      "BLANK"
+                    ],
+                    "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
                   }
                 },
                 "required": [
@@ -100766,7 +100981,13 @@
           "category": "teams",
           "subcategory": null
         },
-        "x-octokit": {}
+        "x-octokit": {
+          "diff": {
+            "ghes-3.6": {
+              "type": "changed"
+            }
+          }
+        }
       }
     },
     "/orgs/{org}/teams/{team_slug}": {
@@ -101333,7 +101554,13 @@
           "category": "teams",
           "subcategory": null
         },
-        "x-octokit": {}
+        "x-octokit": {
+          "diff": {
+            "ghes-3.6": {
+              "type": "changed"
+            }
+          }
+        }
       },
       "patch": {
         "summary": "Update a team",
@@ -101924,7 +102151,13 @@
           "category": "teams",
           "subcategory": null
         },
-        "x-octokit": {}
+        "x-octokit": {
+          "diff": {
+            "ghes-3.6": {
+              "type": "changed"
+            }
+          }
+        }
       },
       "delete": {
         "summary": "Delete a team",
@@ -123200,6 +123433,40 @@
                     "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
                     "default": false
                   },
+                  "squash_merge_commit_title": {
+                    "type": "string",
+                    "enum": [
+                      "PR_TITLE",
+                      "COMMIT_OR_PR_TITLE"
+                    ],
+                    "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
+                  },
+                  "squash_merge_commit_message": {
+                    "type": "string",
+                    "enum": [
+                      "PR_BODY",
+                      "COMMIT_MESSAGES",
+                      "BLANK"
+                    ],
+                    "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
+                  },
+                  "merge_commit_title": {
+                    "type": "string",
+                    "enum": [
+                      "PR_TITLE",
+                      "MERGE_MESSAGE"
+                    ],
+                    "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
+                  },
+                  "merge_commit_message": {
+                    "type": "string",
+                    "enum": [
+                      "PR_BODY",
+                      "PR_TITLE",
+                      "BLANK"
+                    ],
+                    "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
+                  },
                   "archived": {
                     "type": "boolean",
                     "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.",
@@ -127474,7 +127741,6 @@
                         "node_id": "MDc6TGljZW5zZW1pdA==",
                         "html_url": "https://github.com/licenses/mit"
                       },
-                      "language": null,
                       "forks_count": 9,
                       "forks": 9,
                       "stargazers_count": 80,
@@ -129425,6 +129691,11 @@
               "schema": {
                 "type": "object",
                 "nullable": true
+              },
+              "examples": {
+                "default": {
+                  "value": null
+                }
               }
             }
           }
@@ -147790,9 +148061,16 @@
             "content": {
               "application/json": {
                 "schema": {
+                  "title": "Empty Object",
+                  "description": "An object without any properties.",
                   "type": "object",
                   "properties": {},
                   "additionalProperties": false
+                },
+                "examples": {
+                  "default": {
+                    "value": null
+                  }
                 }
               }
             }
@@ -148985,6 +149263,17 @@
                   "state",
                   "comment"
                 ]
+              },
+              "examples": {
+                "default": {
+                  "value": {
+                    "environment_ids": [
+                      161171787
+                    ],
+                    "state": "approved",
+                    "comment": "Ship it!"
+                  }
+                }
               }
             }
           }
@@ -149574,6 +149863,11 @@
               "schema": {
                 "type": "object",
                 "nullable": true
+              },
+              "examples": {
+                "default": {
+                  "value": null
+                }
               }
             }
           }
@@ -149584,9 +149878,16 @@
             "content": {
               "application/json": {
                 "schema": {
+                  "title": "Empty Object",
+                  "description": "An object without any properties.",
                   "type": "object",
                   "properties": {},
                   "additionalProperties": false
+                },
+                "examples": {
+                  "default": {
+                    "value": null
+                  }
                 }
               }
             }
@@ -149655,6 +149956,11 @@
               "schema": {
                 "type": "object",
                 "nullable": true
+              },
+              "examples": {
+                "default": {
+                  "value": null
+                }
               }
             }
           }
@@ -150092,9 +150398,16 @@
             "content": {
               "application/json": {
                 "schema": {
+                  "title": "Empty Object",
+                  "description": "An object without any properties.",
                   "type": "object",
                   "properties": {},
                   "additionalProperties": false
+                },
+                "examples": {
+                  "default": {
+                    "value": null
+                  }
                 }
               }
             }
@@ -232626,7 +232939,6 @@
                         "node_id": "MDc6TGljZW5zZW1pdA==",
                         "html_url": "https://github.com/licenses/mit"
                       },
-                      "language": null,
                       "forks_count": 9,
                       "forks": 9,
                       "stargazers_count": 80,
@@ -239738,6 +240050,14 @@
                             "write"
                           ]
                         },
+                        "organization_custom_roles": {
+                          "type": "string",
+                          "description": "The level of permission to grant the access token for custom roles management.",
+                          "enum": [
+                            "read",
+                            "write"
+                          ]
+                        },
                         "deployments": {
                           "type": "string",
                           "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -313252,7 +313572,13 @@
           "category": "pulls",
           "subcategory": null
         },
-        "x-octokit": {}
+        "x-octokit": {
+          "diff": {
+            "ghes-3.6": {
+              "type": "changed"
+            }
+          }
+        }
       }
     },
     "/repos/{owner}/{repo}/pulls/comments": {
@@ -319239,7 +319565,13 @@
           "category": "pulls",
           "subcategory": null
         },
-        "x-octokit": {}
+        "x-octokit": {
+          "diff": {
+            "ghes-3.6": {
+              "type": "changed"
+            }
+          }
+        }
       },
       "patch": {
         "summary": "Update a pull request",
@@ -322646,7 +322978,13 @@
           "category": "pulls",
           "subcategory": null
         },
-        "x-octokit": {}
+        "x-octokit": {
+          "diff": {
+            "ghes-3.6": {
+              "type": "changed"
+            }
+          }
+        }
       }
     },
     "/repos/{owner}/{repo}/pulls/{pull_number}/comments": {
@@ -364581,7 +364919,13 @@
           "category": "search",
           "subcategory": null
         },
-        "x-octokit": {}
+        "x-octokit": {
+          "diff": {
+            "ghes-3.6": {
+              "type": "changed"
+            }
+          }
+        }
       }
     },
     "/search/topics": {
@@ -367339,7 +367683,13 @@
           "subcategory": null
         },
         "deprecated": true,
-        "x-octokit": {}
+        "x-octokit": {
+          "diff": {
+            "ghes-3.6": {
+              "type": "changed"
+            }
+          }
+        }
       },
       "patch": {
         "summary": "Update a team (Legacy)",
@@ -368546,7 +368896,13 @@
           "subcategory": null
         },
         "deprecated": true,
-        "x-octokit": {}
+        "x-octokit": {
+          "diff": {
+            "ghes-3.6": {
+              "type": "changed"
+            }
+          }
+        }
       },
       "delete": {
         "summary": "Delete a team (Legacy)",
@@ -383773,6 +384129,14 @@
                                   "write"
                                 ]
                               },
+                              "organization_custom_roles": {
+                                "type": "string",
+                                "description": "The level of permission to grant the access token for custom roles management.",
+                                "enum": [
+                                  "read",
+                                  "write"
+                                ]
+                              },
                               "deployments": {
                                 "type": "string",
                                 "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -398687,6 +399051,40 @@
                     "type": "boolean",
                     "example": false
                   },
+                  "squash_merge_commit_title": {
+                    "type": "string",
+                    "enum": [
+                      "PR_TITLE",
+                      "COMMIT_OR_PR_TITLE"
+                    ],
+                    "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
+                  },
+                  "squash_merge_commit_message": {
+                    "type": "string",
+                    "enum": [
+                      "PR_BODY",
+                      "COMMIT_MESSAGES",
+                      "BLANK"
+                    ],
+                    "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
+                  },
+                  "merge_commit_title": {
+                    "type": "string",
+                    "enum": [
+                      "PR_TITLE",
+                      "MERGE_MESSAGE"
+                    ],
+                    "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
+                  },
+                  "merge_commit_message": {
+                    "type": "string",
+                    "enum": [
+                      "PR_BODY",
+                      "PR_TITLE",
+                      "BLANK"
+                    ],
+                    "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
+                  },
                   "has_downloads": {
                     "description": "Whether downloads are enabled.",
                     "default": true,
@@ -408225,7 +408623,13 @@
           "category": "teams",
           "subcategory": null
         },
-        "x-octokit": {}
+        "x-octokit": {
+          "diff": {
+            "ghes-3.6": {
+              "type": "changed"
+            }
+          }
+        }
       }
     },
     "/users": {
@@ -420209,6 +420613,14 @@
                             "write"
                           ]
                         },
+                        "organization_custom_roles": {
+                          "type": "string",
+                          "description": "The level of permission to grant the access token for custom roles management.",
+                          "enum": [
+                            "read",
+                            "write"
+                          ]
+                        },
                         "deployments": {
                           "type": "string",
                           "description": "The level of permission to grant the access token for deployments and deployment statuses.",