@octokit/openapi 7.4.0 → 7.7.0

package/generated/ghes-3.2.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "7.4.0",
+    "version": "7.7.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": {
@@ -4251,14 +4251,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.",
@@ -5349,14 +5341,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.",
@@ -6029,14 +6013,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.",
@@ -8614,14 +8590,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.",
@@ -9419,14 +9387,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.",
@@ -10088,14 +10048,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.",
@@ -10389,14 +10341,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.",
@@ -13424,14 +13368,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.",
@@ -14283,14 +14219,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.",
@@ -15066,14 +14994,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.",
@@ -15557,14 +15477,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.",
@@ -16481,14 +16393,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.",
@@ -17257,14 +17161,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.",
@@ -18448,14 +18344,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.",
@@ -19317,14 +19205,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.",
@@ -20255,14 +20135,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.",
@@ -20943,14 +20815,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.",
@@ -21859,14 +21723,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.",
@@ -22547,14 +22403,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.",
@@ -23341,14 +23189,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.",
@@ -24162,14 +24002,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.",
@@ -76383,14 +76215,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.",
@@ -77202,14 +77026,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.",
@@ -87917,8 +87733,8 @@
                       "example": "2017-08-17T12:37:15Z"
                     },
                     "organization": {
-                      "title": "Organization Full",
-                      "description": "Organization Full",
+                      "title": "Team Organization",
+                      "description": "Team Organization",
                       "type": "object",
                       "properties": {
                         "login": {
@@ -88548,8 +88364,8 @@
                       "example": "2017-08-17T12:37:15Z"
                     },
                     "organization": {
-                      "title": "Organization Full",
-                      "description": "Organization Full",
+                      "title": "Team Organization",
+                      "description": "Team Organization",
                       "type": "object",
                       "properties": {
                         "login": {
@@ -89160,8 +88976,8 @@
                       "example": "2017-08-17T12:37:15Z"
                     },
                     "organization": {
-                      "title": "Organization Full",
-                      "description": "Organization Full",
+                      "title": "Team Organization",
+                      "description": "Team Organization",
                       "type": "object",
                       "properties": {
                         "login": {
@@ -139219,6 +139035,111 @@
                     "protected",
                     "protection_url"
                   ]
+                },
+                "examples": {
+                  "default": {
+                    "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"
+                    }
+                  }
                 }
               }
             }
@@ -141845,6 +141766,73 @@
                   "required": [
                     "url"
                   ]
+                },
+                "examples": {
+                  "default": {
+                    "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
+                      }
+                    }
+                  }
                 }
               }
             }
@@ -144903,7 +144891,7 @@
                     "properties": {
                       "contexts": {
                         "type": "array",
-                        "description": "contexts parameter",
+                        "description": "The name of the status checks",
                         "items": {
                           "type": "string"
                         }
@@ -144919,6 +144907,17 @@
                     }
                   }
                 ]
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example adding status checks to a branch protection rule",
+                  "value": {
+                    "contexts": [
+                      "continuous-integration/travis-ci",
+                      "continuous-integration/jenkins"
+                    ]
+                  }
+                }
               }
             }
           }
@@ -145128,7 +145127,7 @@
                     "properties": {
                       "contexts": {
                         "type": "array",
-                        "description": "contexts parameter",
+                        "description": "The name of the status checks",
                         "items": {
                           "type": "string"
                         }
@@ -145144,6 +145143,16 @@
                     }
                   }
                 ]
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example updating status checks for a branch protection rule",
+                  "value": {
+                    "contexts": [
+                      "continuous-integration/travis-ci"
+                    ]
+                  }
+                }
               }
             }
           }
@@ -145325,7 +145334,7 @@
                     "properties": {
                       "contexts": {
                         "type": "array",
-                        "description": "contexts parameter",
+                        "description": "The name of the status checks",
                         "items": {
                           "type": "string"
                         }
@@ -145341,6 +145350,16 @@
                     }
                   }
                 ]
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example removing status checks from a branch protection rule",
+                  "value": {
+                    "contexts": [
+                      "continuous-integration/travis-ci"
+                    ]
+                  }
+                }
               }
             }
           }
@@ -148046,7 +148065,7 @@
                     "properties": {
                       "teams": {
                         "type": "array",
-                        "description": "teams parameter",
+                        "description": "The slug values for teams",
                         "items": {
                           "type": "string"
                         }
@@ -148062,6 +148081,16 @@
                     }
                   }
                 ]
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example adding a team in a branch protection rule",
+                  "value": {
+                    "teams": [
+                      "justice-league"
+                    ]
+                  }
+                }
               }
             }
           }
@@ -148392,7 +148421,7 @@
                     "properties": {
                       "teams": {
                         "type": "array",
-                        "description": "teams parameter",
+                        "description": "The slug values for teams",
                         "items": {
                           "type": "string"
                         }
@@ -148403,11 +148432,21 @@
                     ],
                     "example": {
                       "teams": [
-                        "my-team"
+                        "justice-league"
                       ]
                     }
                   }
                 ]
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example replacing a team in a branch protection rule",
+                  "value": {
+                    "teams": [
+                      "justice-league"
+                    ]
+                  }
+                }
               }
             }
           }
@@ -148737,7 +148776,7 @@
                     "properties": {
                       "teams": {
                         "type": "array",
-                        "description": "teams parameter",
+                        "description": "The slug values for teams",
                         "items": {
                           "type": "string"
                         }
@@ -148753,6 +148792,16 @@
                     }
                   }
                 ]
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example removing a team in a branch protection rule",
+                  "value": {
+                    "teams": [
+                      "justice-league"
+                    ]
+                  }
+                }
               }
             }
           }
@@ -149317,7 +149366,7 @@
                     "properties": {
                       "users": {
                         "type": "array",
-                        "description": "users parameter",
+                        "description": "The username for users",
                         "items": {
                           "type": "string"
                         }
@@ -149333,6 +149382,16 @@
                     }
                   }
                 ]
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example adding a user in a branch protection rule",
+                  "value": {
+                    "users": [
+                      "octocat"
+                    ]
+                  }
+                }
               }
             }
           }
@@ -149624,7 +149683,7 @@
                     "properties": {
                       "users": {
                         "type": "array",
-                        "description": "users parameter",
+                        "description": "The username for users",
                         "items": {
                           "type": "string"
                         }
@@ -149640,6 +149699,16 @@
                     }
                   }
                 ]
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example replacing a user in a branch protection rule",
+                  "value": {
+                    "users": [
+                      "octocat"
+                    ]
+                  }
+                }
               }
             }
           }
@@ -149930,7 +149999,7 @@
                     "properties": {
                       "users": {
                         "type": "array",
-                        "description": "users parameter",
+                        "description": "The username for users",
                         "items": {
                           "type": "string"
                         }
@@ -149946,6 +150015,16 @@
                     }
                   }
                 ]
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example removing a user in a branch protection rule",
+                  "value": {
+                    "users": [
+                      "octocat"
+                    ]
+                  }
+                }
               }
             }
           }
@@ -190383,7 +190462,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.2/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.2/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.2/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.2/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.2/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.2/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.2/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.2/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"
         ],
@@ -215703,14 +215782,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.",
@@ -218470,6 +218541,14 @@
                     ]
                   }
                 }
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example request body",
+                  "value": {
+                    "permissions": "write"
+                  }
+                }
               }
             }
           }
@@ -223270,7 +223349,8 @@
                           "type": "User",
                           "site_admin": false
                         },
-                        "author_association": "COLLABORATOR"
+                        "author_association": "COLLABORATOR",
+                        "state_reason": "completed"
                       }
                     ]
                   }
@@ -226045,7 +226125,8 @@
                         "type": "User",
                         "site_admin": false
                       },
-                      "author_association": "COLLABORATOR"
+                      "author_association": "COLLABORATOR",
+                      "state_reason": "completed"
                     }
                   }
                 }
@@ -233038,7 +233119,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"
                         }
                       }
                     ]
@@ -236906,7 +236988,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"
                       }
                     }
                   }
@@ -239539,7 +239622,8 @@
                         "type": "User",
                         "site_admin": false
                       },
-                      "author_association": "COLLABORATOR"
+                      "author_association": "COLLABORATOR",
+                      "state_reason": "completed"
                     }
                   }
                 }
@@ -239724,6 +239808,12 @@
                       "closed"
                     ]
                   },
+                  "state_reason": {
+                    "type": "string",
+                    "nullable": true,
+                    "description": "The reason for the current state",
+                    "example": "not_planned"
+                  },
                   "milestone": {
                     "oneOf": [
                       {
@@ -242278,7 +242368,8 @@
                         "type": "User",
                         "site_admin": false
                       },
-                      "author_association": "COLLABORATOR"
+                      "author_association": "COLLABORATOR",
+                      "state_reason": "completed"
                     }
                   }
                 }
@@ -245049,7 +245140,8 @@
                         "type": "User",
                         "site_admin": false
                       },
-                      "author_association": "COLLABORATOR"
+                      "author_association": "COLLABORATOR",
+                      "state_reason": "completed"
                     }
                   }
                 }
@@ -338002,7 +338094,8 @@
                           "body": "...",
                           "score": 1,
                           "locked": true,
-                          "author_association": "COLLABORATOR"
+                          "author_association": "COLLABORATOR",
+                          "state_reason": "completed"
                         }
                       ]
                     }
@@ -341821,8 +341914,8 @@
                       "example": "2017-08-17T12:37:15Z"
                     },
                     "organization": {
-                      "title": "Organization Full",
-                      "description": "Organization Full",
+                      "title": "Team Organization",
+                      "description": "Team Organization",
                       "type": "object",
                       "properties": {
                         "login": {
@@ -342430,8 +342523,8 @@
                       "example": "2017-08-17T12:37:15Z"
                     },
                     "organization": {
-                      "title": "Organization Full",
-                      "description": "Organization Full",
+                      "title": "Team Organization",
+                      "description": "Team Organization",
                       "type": "object",
                       "properties": {
                         "login": {
@@ -342923,8 +343016,8 @@
                       "example": "2017-08-17T12:37:15Z"
                     },
                     "organization": {
-                      "title": "Organization Full",
-                      "description": "Organization Full",
+                      "title": "Team Organization",
+                      "description": "Team Organization",
                       "type": "object",
                       "properties": {
                         "login": {
@@ -358650,14 +358743,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.",
@@ -377381,8 +377466,8 @@
                         "example": "2017-08-17T12:37:15Z"
                       },
                       "organization": {
-                        "title": "Organization Full",
-                        "description": "Organization Full",
+                        "title": "Team Organization",
+                        "description": "Team Organization",
                         "type": "object",
                         "properties": {
                           "login": {
@@ -389734,14 +389819,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.",