@octokit/openapi 7.2.0 → 7.5.0

package/generated/ghes-3.6.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": {
@@ -10014,6 +10014,7 @@
         "parameters": [
           {
             "name": "organization_id",
+            "description": "The unique identifier of the organization.",
             "in": "path",
             "required": true,
             "schema": {
@@ -10211,6 +10212,11 @@
                     "description": "Whether organization members can fork private organization repositories.",
                     "default": false
                   },
+                  "web_commit_signoff_required": {
+                    "type": "boolean",
+                    "description": "Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.",
+                    "default": false
+                  },
                   "blog": {
                     "type": "string",
                     "example": "\"http://github.blog\""
@@ -16033,6 +16039,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": [
@@ -20226,6 +20266,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.",
@@ -20235,6 +20309,11 @@
                     "type": "boolean",
                     "description": "Either `true` to allow private forks, or `false` to prevent private forks.",
                     "default": false
+                  },
+                  "web_commit_signoff_required": {
+                    "type": "boolean",
+                    "description": "Either `true` to require contributors to sign off on web-based commits, or `false` to not require contributors to sign off on web-based commits.",
+                    "default": false
                   }
                 }
               },
@@ -20847,6 +20926,11 @@
                     "description": "Whether to enable debug logging for the re-run."
                   }
                 }
+              },
+              "examples": {
+                "default": {
+                  "value": null
+                }
               }
             }
           }
@@ -22384,9 +22468,12 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "object",
-                  "properties": {},
-                  "additionalProperties": false
+                  "$ref": "#/components/schemas/empty-object"
+                },
+                "examples": {
+                  "default": {
+                    "value": null
+                  }
                 }
               }
             }
@@ -22691,6 +22778,17 @@
                   "state",
                   "comment"
                 ]
+              },
+              "examples": {
+                "default": {
+                  "value": {
+                    "environment_ids": [
+                      161171787
+                    ],
+                    "state": "approved",
+                    "comment": "Ship it!"
+                  }
+                }
               }
             }
           }
@@ -22761,6 +22859,11 @@
                     "description": "Whether to enable debug logging for the re-run."
                   }
                 }
+              },
+              "examples": {
+                "default": {
+                  "value": null
+                }
               }
             }
           }
@@ -22771,9 +22874,12 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "object",
-                  "properties": {},
-                  "additionalProperties": false
+                  "$ref": "#/components/schemas/empty-object"
+                },
+                "examples": {
+                  "default": {
+                    "value": null
+                  }
                 }
               }
             }
@@ -22825,6 +22931,11 @@
                     "description": "Whether to enable debug logging for the re-run."
                   }
                 }
+              },
+              "examples": {
+                "default": {
+                  "value": null
+                }
               }
             }
           }
@@ -23078,9 +23189,12 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "object",
-                  "properties": {},
-                  "additionalProperties": false
+                  "$ref": "#/components/schemas/empty-object"
+                },
+                "examples": {
+                  "default": {
+                    "value": null
+                  }
                 }
               }
             }
@@ -51573,6 +51687,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,
@@ -58356,6 +58504,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.",
@@ -60296,6 +60452,40 @@
               "use_squash_pr_title_as_default": {
                 "type": "boolean"
               },
+              "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."
+              },
               "allow_merge_commit": {
                 "type": "boolean"
               },
@@ -60339,6 +60529,40 @@
             "description": "Whether a squash merge commit can use the pull request title as default.",
             "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."
+          },
           "allow_merge_commit": {
             "description": "Whether to allow merge commits for pull requests.",
             "default": true,
@@ -60349,6 +60573,11 @@
             "description": "Whether to allow forking this repo",
             "type": "boolean"
           },
+          "web_commit_signoff_required": {
+            "description": "Whether to require contributors to sign off on web-based commits",
+            "default": false,
+            "type": "boolean"
+          },
           "subscribers_count": {
             "type": "integer"
           },
@@ -64321,6 +64550,40 @@
               "use_squash_pr_title_as_default": {
                 "type": "boolean"
               },
+              "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."
+              },
               "allow_merge_commit": {
                 "type": "boolean"
               },
@@ -64364,6 +64627,40 @@
             "description": "Whether a squash merge commit can use the pull request title as default.",
             "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."
+          },
           "allow_merge_commit": {
             "description": "Whether to allow merge commits for pull requests.",
             "default": true,
@@ -64374,6 +64671,11 @@
             "description": "Whether to allow forking this repo",
             "type": "boolean"
           },
+          "web_commit_signoff_required": {
+            "description": "Whether to require contributors to sign off on web-based commits",
+            "default": false,
+            "type": "boolean"
+          },
           "subscribers_count": {
             "type": "integer"
           },
@@ -64843,6 +65145,10 @@
           },
           "allow_forking": {
             "type": "boolean"
+          },
+          "web_commit_signoff_required": {
+            "type": "boolean",
+            "example": false
           }
         },
         "required": [
@@ -65253,6 +65559,10 @@
             "example": false,
             "nullable": true
           },
+          "web_commit_signoff_required": {
+            "type": "boolean",
+            "example": false
+          },
           "updated_at": {
             "type": "string",
             "format": "date-time"
@@ -67253,6 +67563,12 @@
             "type": "boolean",
             "example": false
           },
+          "web_commit_signoff_required": {
+            "description": "Whether to require contributors to sign off on web-based commits",
+            "default": false,
+            "type": "boolean",
+            "example": false
+          },
           "subscribers_count": {
             "type": "integer"
           },
@@ -68020,10 +68336,52 @@
             "type": "boolean",
             "example": false
           },
+          "squash_merge_commit_title": {
+            "type": "string",
+            "example": "PR_TITLE",
+            "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",
+            "example": "PR_BODY",
+            "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",
+            "example": "PR_TITLE",
+            "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",
+            "example": "PR_BODY",
+            "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."
+          },
           "allow_forking": {
             "type": "boolean",
             "example": true
           },
+          "web_commit_signoff_required": {
+            "type": "boolean",
+            "example": false
+          },
           "subscribers_count": {
             "type": "integer",
             "example": 42
@@ -77787,6 +78145,9 @@
                   },
                   "is_template": {
                     "type": "boolean"
+                  },
+                  "web_commit_signoff_required": {
+                    "type": "boolean"
                   }
                 },
                 "required": [
@@ -78361,6 +78722,9 @@
                   },
                   "allow_forking": {
                     "type": "boolean"
+                  },
+                  "web_commit_signoff_required": {
+                    "type": "boolean"
                   }
                 },
                 "required": [
@@ -80438,6 +80802,10 @@
           },
           "is_template": {
             "type": "boolean"
+          },
+          "web_commit_signoff_required": {
+            "type": "boolean",
+            "example": false
           }
         },
         "required": [
@@ -86919,6 +87287,7 @@
           "members_can_create_public_pages": true,
           "members_can_create_private_pages": true,
           "members_can_fork_private_repositories": false,
+          "web_commit_signoff_required": false,
           "updated_at": "2014-03-03T18:58:10Z"
         }
       },
@@ -90701,6 +91070,7 @@
           "delete_branch_on_merge": true,
           "allow_merge_commit": true,
           "allow_forking": true,
+          "web_commit_signoff_required": false,
           "subscribers_count": 42,
           "network_count": 0,
           "organization": {