@octokit/openapi 7.5.0 → 7.8.0

package/generated/ghes-3.4.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "7.5.0",
+    "version": "7.8.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": {
@@ -9402,7 +9402,7 @@
     "/organizations/{organization_id}/custom_roles": {
       "get": {
         "summary": "List custom repository roles in an organization",
-        "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/enterprise-server@3.4/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".",
+        "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/enterprise-server@3.4/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".",
         "tags": [
           "orgs"
         ],
@@ -13556,17 +13556,6 @@
               }
             }
           },
-          "302": {
-            "description": "Response if requester is not an organization member",
-            "headers": {
-              "Location": {
-                "example": "https://api.github.com/orgs/github/public_members",
-                "schema": {
-                  "type": "string"
-                }
-              }
-            }
-          },
           "422": {
             "$ref": "#/components/responses/validation_failed"
           }
@@ -22226,6 +22215,11 @@
                   "url_template": {
                     "type": "string",
                     "description": "The URL must contain `<num>` for the reference number."
+                  },
+                  "is_alphanumeric": {
+                    "type": "boolean",
+                    "default": "true",
+                    "description": "Whether this autolink reference matches alphanumeric characters. If true, the `<num>` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters."
                   }
                 },
                 "required": [
@@ -22237,7 +22231,8 @@
                 "default": {
                   "value": {
                     "key_prefix": "TICKET-",
-                    "url_template": "https://example.com/TICKET?query=<num>"
+                    "url_template": "https://example.com/TICKET?query=<num>",
+                    "is_alphanumeric": true
                   }
                 }
               }
@@ -22473,6 +22468,11 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/branch-with-protection"
+                },
+                "examples": {
+                  "default": {
+                    "$ref": "#/components/examples/branch-get"
+                  }
                 }
               }
             }
@@ -22815,6 +22815,11 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/protected-branch"
+                },
+                "examples": {
+                  "default": {
+                    "$ref": "#/components/examples/branch-protection-update"
+                  }
                 }
               }
             }
@@ -23689,7 +23694,7 @@
                     "properties": {
                       "contexts": {
                         "type": "array",
-                        "description": "contexts parameter",
+                        "description": "The name of the status checks",
                         "items": {
                           "type": "string"
                         }
@@ -23705,6 +23710,17 @@
                     }
                   }
                 ]
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example adding status checks to a branch protection rule",
+                  "value": {
+                    "contexts": [
+                      "continuous-integration/travis-ci",
+                      "continuous-integration/jenkins"
+                    ]
+                  }
+                }
               }
             }
           }
@@ -23783,7 +23799,7 @@
                     "properties": {
                       "contexts": {
                         "type": "array",
-                        "description": "contexts parameter",
+                        "description": "The name of the status checks",
                         "items": {
                           "type": "string"
                         }
@@ -23799,6 +23815,16 @@
                     }
                   }
                 ]
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example updating status checks for a branch protection rule",
+                  "value": {
+                    "contexts": [
+                      "continuous-integration/travis-ci"
+                    ]
+                  }
+                }
               }
             }
           }
@@ -23872,7 +23898,7 @@
                     "properties": {
                       "contexts": {
                         "type": "array",
-                        "description": "contexts parameter",
+                        "description": "The name of the status checks",
                         "items": {
                           "type": "string"
                         }
@@ -23888,6 +23914,16 @@
                     }
                   }
                 ]
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example removing status checks from a branch protection rule",
+                  "value": {
+                    "contexts": [
+                      "continuous-integration/travis-ci"
+                    ]
+                  }
+                }
               }
             }
           }
@@ -24413,7 +24449,7 @@
                     "properties": {
                       "teams": {
                         "type": "array",
-                        "description": "teams parameter",
+                        "description": "The slug values for teams",
                         "items": {
                           "type": "string"
                         }
@@ -24429,6 +24465,16 @@
                     }
                   }
                 ]
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example adding a team in a branch protection rule",
+                  "value": {
+                    "teams": [
+                      "justice-league"
+                    ]
+                  }
+                }
               }
             }
           }
@@ -24498,7 +24544,7 @@
                     "properties": {
                       "teams": {
                         "type": "array",
-                        "description": "teams parameter",
+                        "description": "The slug values for teams",
                         "items": {
                           "type": "string"
                         }
@@ -24509,11 +24555,21 @@
                     ],
                     "example": {
                       "teams": [
-                        "my-team"
+                        "justice-league"
                       ]
                     }
                   }
                 ]
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example replacing a team in a branch protection rule",
+                  "value": {
+                    "teams": [
+                      "justice-league"
+                    ]
+                  }
+                }
               }
             }
           }
@@ -24582,7 +24638,7 @@
                     "properties": {
                       "teams": {
                         "type": "array",
-                        "description": "teams parameter",
+                        "description": "The slug values for teams",
                         "items": {
                           "type": "string"
                         }
@@ -24598,6 +24654,16 @@
                     }
                   }
                 ]
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example removing a team in a branch protection rule",
+                  "value": {
+                    "teams": [
+                      "justice-league"
+                    ]
+                  }
+                }
               }
             }
           }
@@ -24722,7 +24788,7 @@
                     "properties": {
                       "users": {
                         "type": "array",
-                        "description": "users parameter",
+                        "description": "The username for users",
                         "items": {
                           "type": "string"
                         }
@@ -24738,6 +24804,16 @@
                     }
                   }
                 ]
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example adding a user in a branch protection rule",
+                  "value": {
+                    "users": [
+                      "octocat"
+                    ]
+                  }
+                }
               }
             }
           }
@@ -24807,7 +24883,7 @@
                     "properties": {
                       "users": {
                         "type": "array",
-                        "description": "users parameter",
+                        "description": "The username for users",
                         "items": {
                           "type": "string"
                         }
@@ -24823,6 +24899,16 @@
                     }
                   }
                 ]
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example replacing a user in a branch protection rule",
+                  "value": {
+                    "users": [
+                      "octocat"
+                    ]
+                  }
+                }
               }
             }
           }
@@ -24891,7 +24977,7 @@
                     "properties": {
                       "users": {
                         "type": "array",
-                        "description": "users parameter",
+                        "description": "The username for users",
                         "items": {
                           "type": "string"
                         }
@@ -24907,6 +24993,16 @@
                     }
                   }
                 ]
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example removing a user in a branch protection rule",
+                  "value": {
+                    "users": [
+                      "octocat"
+                    ]
+                  }
+                }
               }
             }
           }
@@ -26751,7 +26847,7 @@
       },
       "delete": {
         "summary": "Delete a code scanning analysis from a repository",
-        "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `analysis_key`\n* `environment`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n  **Inner loop**:\n  * Delete the identified analysis.\n  * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.",
+        "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `category`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n  **Inner loop**:\n  * Delete the identified analysis.\n  * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.",
         "operationId": "code-scanning/delete-analysis",
         "tags": [
           "code-scanning"
@@ -28202,6 +28298,9 @@
           },
           "500": {
             "$ref": "#/components/responses/internal_error"
+          },
+          "503": {
+            "$ref": "#/components/responses/service_unavailable"
           }
         },
         "x-github": {
@@ -28623,6 +28722,9 @@
           },
           "500": {
             "$ref": "#/components/responses/internal_error"
+          },
+          "503": {
+            "$ref": "#/components/responses/service_unavailable"
           }
         },
         "x-github": {
@@ -28636,7 +28738,7 @@
     "/repos/{owner}/{repo}/contents/{path}": {
       "get": {
         "summary": "Get repository content",
-        "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/enterprise-server@3.4/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/enterprise-server@3.4/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Note**:\n*   To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.4/rest/reference/git#trees).\n*   This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/enterprise-server@3.4/rest/reference/git#get-a-tree).\n*   This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.",
+        "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/enterprise-server@3.4/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/enterprise-server@3.4/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Notes**:\n*   To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.4/rest/reference/git#trees).\n*   This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/enterprise-server@3.4/rest/reference/git#get-a-tree).\n *  Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. \n*   This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.",
         "tags": [
           "repos"
         ],
@@ -32962,6 +33064,14 @@
                     ]
                   }
                 }
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example request body",
+                  "value": {
+                    "permissions": "write"
+                  }
+                }
               }
             }
           }
@@ -34063,6 +34173,12 @@
                       "closed"
                     ]
                   },
+                  "state_reason": {
+                    "type": "string",
+                    "nullable": true,
+                    "description": "The reason for the current state",
+                    "example": "not_planned"
+                  },
                   "milestone": {
                     "oneOf": [
                       {
@@ -38621,6 +38737,9 @@
           },
           "500": {
             "$ref": "#/components/responses/internal_error"
+          },
+          "503": {
+            "$ref": "#/components/responses/service_unavailable"
           }
         },
         "x-github": {
@@ -39168,6 +39287,9 @@
           },
           "500": {
             "$ref": "#/components/responses/internal_error"
+          },
+          "503": {
+            "$ref": "#/components/responses/service_unavailable"
           }
         },
         "x-github": {
@@ -43138,7 +43260,7 @@
     "/repos/{template_owner}/{template_repo}/generate": {
       "post": {
         "summary": "Create a repository using a template",
-        "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.4/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n*   `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n*   `repo` scope to create a private repository",
+        "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.4/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n*   `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n*   `repo` scope to create a private repository",
         "tags": [
           "repos"
         ],
@@ -53295,14 +53417,6 @@
               "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.",
@@ -55306,6 +55420,10 @@
           "starred_at": {
             "type": "string",
             "example": "\"2020-07-09T00:17:42Z\""
+          },
+          "anonymous_access_enabled": {
+            "type": "boolean",
+            "description": "Whether anonymous git access is enabled for this repository"
           }
         },
         "required": [
@@ -59214,6 +59332,10 @@
           "starred_at": {
             "type": "string",
             "example": "\"2020-07-09T00:17:42Z\""
+          },
+          "anonymous_access_enabled": {
+            "type": "boolean",
+            "description": "Whether anonymous git access is enabled for this repository"
           }
         },
         "required": [
@@ -60847,6 +60969,263 @@
           "parent"
         ]
       },
+      "team-organization": {
+        "title": "Team Organization",
+        "description": "Team Organization",
+        "type": "object",
+        "properties": {
+          "login": {
+            "type": "string",
+            "example": "github"
+          },
+          "id": {
+            "type": "integer",
+            "example": 1
+          },
+          "node_id": {
+            "type": "string",
+            "example": "MDEyOk9yZ2FuaXphdGlvbjE="
+          },
+          "url": {
+            "type": "string",
+            "format": "uri",
+            "example": "https://api.github.com/orgs/github"
+          },
+          "repos_url": {
+            "type": "string",
+            "format": "uri",
+            "example": "https://api.github.com/orgs/github/repos"
+          },
+          "events_url": {
+            "type": "string",
+            "format": "uri",
+            "example": "https://api.github.com/orgs/github/events"
+          },
+          "hooks_url": {
+            "type": "string",
+            "example": "https://api.github.com/orgs/github/hooks"
+          },
+          "issues_url": {
+            "type": "string",
+            "example": "https://api.github.com/orgs/github/issues"
+          },
+          "members_url": {
+            "type": "string",
+            "example": "https://api.github.com/orgs/github/members{/member}"
+          },
+          "public_members_url": {
+            "type": "string",
+            "example": "https://api.github.com/orgs/github/public_members{/member}"
+          },
+          "avatar_url": {
+            "type": "string",
+            "example": "https://github.com/images/error/octocat_happy.gif"
+          },
+          "description": {
+            "type": "string",
+            "example": "A great organization",
+            "nullable": true
+          },
+          "name": {
+            "type": "string",
+            "example": "github"
+          },
+          "company": {
+            "type": "string",
+            "example": "GitHub"
+          },
+          "blog": {
+            "type": "string",
+            "format": "uri",
+            "example": "https://github.com/blog"
+          },
+          "location": {
+            "type": "string",
+            "example": "San Francisco"
+          },
+          "email": {
+            "type": "string",
+            "format": "email",
+            "example": "octocat@github.com"
+          },
+          "twitter_username": {
+            "type": "string",
+            "example": "github",
+            "nullable": true
+          },
+          "is_verified": {
+            "type": "boolean",
+            "example": true
+          },
+          "has_organization_projects": {
+            "type": "boolean",
+            "example": true
+          },
+          "has_repository_projects": {
+            "type": "boolean",
+            "example": true
+          },
+          "public_repos": {
+            "type": "integer",
+            "example": 2
+          },
+          "public_gists": {
+            "type": "integer",
+            "example": 1
+          },
+          "followers": {
+            "type": "integer",
+            "example": 20
+          },
+          "following": {
+            "type": "integer",
+            "example": 0
+          },
+          "html_url": {
+            "type": "string",
+            "format": "uri",
+            "example": "https://github.com/octocat"
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time",
+            "example": "2008-01-14T04:33:35Z"
+          },
+          "type": {
+            "type": "string",
+            "example": "Organization"
+          },
+          "total_private_repos": {
+            "type": "integer",
+            "example": 100
+          },
+          "owned_private_repos": {
+            "type": "integer",
+            "example": 100
+          },
+          "private_gists": {
+            "type": "integer",
+            "example": 81,
+            "nullable": true
+          },
+          "disk_usage": {
+            "type": "integer",
+            "example": 10000,
+            "nullable": true
+          },
+          "collaborators": {
+            "type": "integer",
+            "example": 8,
+            "nullable": true
+          },
+          "billing_email": {
+            "type": "string",
+            "format": "email",
+            "example": "org@example.com",
+            "nullable": true
+          },
+          "plan": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string"
+              },
+              "space": {
+                "type": "integer"
+              },
+              "private_repos": {
+                "type": "integer"
+              },
+              "filled_seats": {
+                "type": "integer"
+              },
+              "seats": {
+                "type": "integer"
+              }
+            },
+            "required": [
+              "name",
+              "space",
+              "private_repos"
+            ]
+          },
+          "default_repository_permission": {
+            "type": "string",
+            "nullable": true
+          },
+          "members_can_create_repositories": {
+            "type": "boolean",
+            "example": true,
+            "nullable": true
+          },
+          "two_factor_requirement_enabled": {
+            "type": "boolean",
+            "example": true,
+            "nullable": true
+          },
+          "members_allowed_repository_creation_type": {
+            "type": "string",
+            "example": "all"
+          },
+          "members_can_create_public_repositories": {
+            "type": "boolean",
+            "example": true
+          },
+          "members_can_create_private_repositories": {
+            "type": "boolean",
+            "example": true
+          },
+          "members_can_create_internal_repositories": {
+            "type": "boolean",
+            "example": true
+          },
+          "members_can_create_pages": {
+            "type": "boolean",
+            "example": true
+          },
+          "members_can_create_public_pages": {
+            "type": "boolean",
+            "example": true
+          },
+          "members_can_create_private_pages": {
+            "type": "boolean",
+            "example": true
+          },
+          "members_can_fork_private_repositories": {
+            "type": "boolean",
+            "example": false,
+            "nullable": true
+          },
+          "updated_at": {
+            "type": "string",
+            "format": "date-time"
+          }
+        },
+        "required": [
+          "login",
+          "url",
+          "id",
+          "node_id",
+          "repos_url",
+          "events_url",
+          "hooks_url",
+          "issues_url",
+          "members_url",
+          "public_members_url",
+          "avatar_url",
+          "description",
+          "html_url",
+          "has_organization_projects",
+          "has_repository_projects",
+          "public_repos",
+          "public_gists",
+          "followers",
+          "following",
+          "type",
+          "created_at",
+          "updated_at"
+        ]
+      },
       "team-full": {
         "title": "Full Team",
         "description": "Groups of organization members that gives permissions on specified repositories.",
@@ -60931,7 +61310,7 @@
             "example": "2017-08-17T12:37:15Z"
           },
           "organization": {
-            "$ref": "#/components/schemas/organization-full"
+            "$ref": "#/components/schemas/team-organization"
           },
           "ldap_dn": {
             "description": "Distinguished Name (DN) that team maps to within LDAP environment",
@@ -65629,6 +66008,11 @@
             "nullable": true,
             "type": "string",
             "description": "Detailed documentation for the rule as GitHub Flavored Markdown."
+          },
+          "help_uri": {
+            "nullable": true,
+            "type": "string",
+            "description": "A link to the documentation for the rule used to detect the alert."
           }
         }
       },
@@ -85863,6 +86247,109 @@
           }
         ]
       },
+      "branch-get": {
+        "value": {
+          "name": "main",
+          "commit": {
+            "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+            "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk",
+            "commit": {
+              "author": {
+                "name": "The Octocat",
+                "email": "octocat@nowhere.com",
+                "date": "2012-03-06T23:06:50Z"
+              },
+              "committer": {
+                "name": "The Octocat",
+                "email": "octocat@nowhere.com",
+                "date": "2012-03-06T23:06:50Z"
+              },
+              "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
+              "tree": {
+                "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608",
+                "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608"
+              },
+              "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+              "comment_count": 77,
+              "verification": {
+                "verified": false,
+                "reason": "unsigned",
+                "signature": null,
+                "payload": null
+              }
+            },
+            "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+            "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+            "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments",
+            "author": {
+              "login": "octocat",
+              "id": 583231,
+              "node_id": "MDQ6VXNlcjU4MzIzMQ==",
+              "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
+              "gravatar_id": "",
+              "url": "https://api.github.com/users/octocat",
+              "html_url": "https://github.com/octocat",
+              "followers_url": "https://api.github.com/users/octocat/followers",
+              "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+              "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+              "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+              "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+              "organizations_url": "https://api.github.com/users/octocat/orgs",
+              "repos_url": "https://api.github.com/users/octocat/repos",
+              "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+              "received_events_url": "https://api.github.com/users/octocat/received_events",
+              "type": "User",
+              "site_admin": false
+            },
+            "committer": {
+              "login": "octocat",
+              "id": 583231,
+              "node_id": "MDQ6VXNlcjU4MzIzMQ==",
+              "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
+              "gravatar_id": "",
+              "url": "https://api.github.com/users/octocat",
+              "html_url": "https://github.com/octocat",
+              "followers_url": "https://api.github.com/users/octocat/followers",
+              "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+              "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+              "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+              "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+              "organizations_url": "https://api.github.com/users/octocat/orgs",
+              "repos_url": "https://api.github.com/users/octocat/repos",
+              "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+              "received_events_url": "https://api.github.com/users/octocat/received_events",
+              "type": "User",
+              "site_admin": false
+            },
+            "parents": [
+              {
+                "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
+                "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
+                "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e"
+              },
+              {
+                "sha": "762941318ee16e59dabbacb1b4049eec22f0d303",
+                "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303",
+                "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303"
+              }
+            ]
+          },
+          "_links": {
+            "self": "https://api.github.com/repos/octocat/Hello-World/branches/main",
+            "html": "https://github.com/octocat/Hello-World/tree/main"
+          },
+          "protected": false,
+          "protection": {
+            "enabled": false,
+            "required_status_checks": {
+              "enforcement_level": "off",
+              "contexts": [],
+              "checks": []
+            }
+          },
+          "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection"
+        }
+      },
       "branch-protection": {
         "value": {
           "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection",
@@ -86059,6 +86546,71 @@
           }
         }
       },
+      "branch-protection-update": {
+        "value": {
+          "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection",
+          "required_status_checks": {
+            "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks",
+            "strict": true,
+            "contexts": [
+              "continuous-integration/travis-ci"
+            ],
+            "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts",
+            "checks": [
+              {
+                "context": "continuous-integration/travis-ci",
+                "app_id": null
+              }
+            ]
+          },
+          "restrictions": {
+            "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions",
+            "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users",
+            "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams",
+            "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps",
+            "users": [],
+            "teams": [],
+            "apps": []
+          },
+          "required_pull_request_reviews": {
+            "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews",
+            "dismiss_stale_reviews": true,
+            "require_code_owner_reviews": true,
+            "required_approving_review_count": 2,
+            "dismissal_restrictions": {
+              "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions",
+              "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users",
+              "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams",
+              "users": [],
+              "teams": [],
+              "apps": []
+            }
+          },
+          "required_signatures": {
+            "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures",
+            "enabled": false
+          },
+          "enforce_admins": {
+            "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins",
+            "enabled": true
+          },
+          "required_linear_history": {
+            "enabled": true
+          },
+          "allow_force_pushes": {
+            "enabled": true
+          },
+          "allow_deletions": {
+            "enabled": true
+          },
+          "block_creations": {
+            "enabled": true
+          },
+          "required_conversation_resolution": {
+            "enabled": true
+          }
+        }
+      },
       "protected-branch-admin-enforced-2": {
         "value": {
           "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins",
@@ -87488,7 +88040,8 @@
               "security",
               "external/cwe/cwe-022"
             ],
-            "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..."
+            "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...",
+            "help_uri": "https://codeql.github.com/"
           },
           "tool": {
             "name": "CodeQL",
@@ -87558,7 +88111,8 @@
               "security",
               "external/cwe/cwe-022"
             ],
-            "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..."
+            "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...",
+            "help_uri": "https://codeql.github.com/"
           },
           "tool": {
             "name": "CodeQL",
@@ -87594,6 +88148,7 @@
             "ref": "refs/heads/main",
             "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
             "environment": "",
+            "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
             "state": "open",
             "fixed_at": null,
             "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
@@ -90854,7 +91409,8 @@
               "type": "User",
               "site_admin": false
             },
-            "author_association": "COLLABORATOR"
+            "author_association": "COLLABORATOR",
+            "state_reason": "completed"
           }
         ]
       },
@@ -91014,7 +91570,8 @@
             "type": "User",
             "site_admin": false
           },
-          "author_association": "COLLABORATOR"
+          "author_association": "COLLABORATOR",
+          "state_reason": "completed"
         }
       },
       "issue-comment-items": {
@@ -91250,7 +91807,8 @@
               "closed_at": null,
               "created_at": "2011-04-22T13:33:48Z",
               "updated_at": "2011-04-22T13:33:48Z",
-              "author_association": "COLLABORATOR"
+              "author_association": "COLLABORATOR",
+              "state_reason": "completed"
             }
           }
         ]
@@ -91459,7 +92017,8 @@
             "closed_at": null,
             "created_at": "2011-04-22T13:33:48Z",
             "updated_at": "2011-04-22T13:33:48Z",
-            "author_association": "COLLABORATOR"
+            "author_association": "COLLABORATOR",
+            "state_reason": "completed"
           }
         }
       },
@@ -95683,7 +96242,8 @@
               "body": "...",
               "score": 1,
               "locked": true,
-              "author_association": "COLLABORATOR"
+              "author_association": "COLLABORATOR",
+              "state_reason": "completed"
             }
           ]
         }