@octokit/openapi 7.1.0 → 7.4.0

package/generated/ghes-3.6.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "7.1.0",
+    "version": "7.4.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": {
@@ -16033,6 +16034,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 +20261,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.",
@@ -20847,6 +20916,11 @@
                     "description": "Whether to enable debug logging for the re-run."
                   }
                 }
+              },
+              "examples": {
+                "default": {
+                  "value": null
+                }
               }
             }
           }
@@ -22384,9 +22458,12 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "object",
-                  "properties": {},
-                  "additionalProperties": false
+                  "$ref": "#/components/schemas/empty-object"
+                },
+                "examples": {
+                  "default": {
+                    "value": null
+                  }
                 }
               }
             }
@@ -22691,6 +22768,17 @@
                   "state",
                   "comment"
                 ]
+              },
+              "examples": {
+                "default": {
+                  "value": {
+                    "environment_ids": [
+                      161171787
+                    ],
+                    "state": "approved",
+                    "comment": "Ship it!"
+                  }
+                }
               }
             }
           }
@@ -22761,6 +22849,11 @@
                     "description": "Whether to enable debug logging for the re-run."
                   }
                 }
+              },
+              "examples": {
+                "default": {
+                  "value": null
+                }
               }
             }
           }
@@ -22771,9 +22864,12 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "object",
-                  "properties": {},
-                  "additionalProperties": false
+                  "$ref": "#/components/schemas/empty-object"
+                },
+                "examples": {
+                  "default": {
+                    "value": null
+                  }
                 }
               }
             }
@@ -22825,6 +22921,11 @@
                     "description": "Whether to enable debug logging for the re-run."
                   }
                 }
+              },
+              "examples": {
+                "default": {
+                  "value": null
+                }
               }
             }
           }
@@ -23078,9 +23179,12 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "object",
-                  "properties": {},
-                  "additionalProperties": false
+                  "$ref": "#/components/schemas/empty-object"
+                },
+                "examples": {
+                  "default": {
+                    "value": null
+                  }
                 }
               }
             }
@@ -51573,6 +51677,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,
@@ -53547,6 +53685,12 @@
               "text/plain": {
                 "schema": {
                   "type": "string"
+                },
+                "examples": {
+                  "default": {
+                    "summary": "Example response",
+                    "value": "Responsive is better than fast"
+                  }
                 }
               }
             }
@@ -53702,6 +53846,50 @@
         }
       }
     },
+    "/enterprises/{enterprise}/consumed-licenses": {
+      "get": {
+        "summary": "List enterprise consumed licenses",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
+        "tags": [
+          "enterprise-admin"
+        ],
+        "operationId": "enterprise-admin/get-consumed-licenses",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/reference/enterprise-admin#list-enterprise-consumed-licenses"
+        },
+        "x-octokit": {
+          "api.github.com": "removed"
+        },
+        "responses": {
+          "501": {
+            "description": "Not Implemented"
+          }
+        }
+      }
+    },
+    "/enterprises/{enterprise}/license-sync-status": {
+      "get": {
+        "summary": "Get a license sync status",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
+        "tags": [
+          "enterprise-admin"
+        ],
+        "operationId": "enterprise-admin/get-license-sync-status",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/reference/enterprise-admin#get-a-license-sync-status"
+        },
+        "x-octokit": {
+          "api.github.com": "removed"
+        },
+        "responses": {
+          "501": {
+            "description": "Not Implemented"
+          }
+        }
+      }
+    },
     "/enterprises/{enterprise}/settings/billing/actions": {
       "get": {
         "summary": "Get GitHub Actions billing for an enterprise",
@@ -58306,6 +58494,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.",
@@ -60246,6 +60442,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"
               },
@@ -60289,6 +60519,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,
@@ -64271,6 +64535,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"
               },
@@ -64314,6 +64612,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,
@@ -67970,6 +68302,44 @@
             "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