@octokit/openapi 7.10.0 → 7.11.0

package/generated/ghes-3.5.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "7.10.0",
+    "version": "7.11.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": {
@@ -101586,6 +101586,504 @@
           }
         },
         "responses": {
+          "200": {
+            "description": "Response when the updated information already exists",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "Full Team",
+                  "description": "Groups of organization members that gives permissions on specified repositories.",
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "description": "Unique identifier of the team",
+                      "example": 42,
+                      "type": "integer"
+                    },
+                    "node_id": {
+                      "type": "string",
+                      "example": "MDQ6VGVhbTE="
+                    },
+                    "url": {
+                      "description": "URL for the team",
+                      "example": "https://api.github.com/organizations/1/team/1",
+                      "type": "string",
+                      "format": "uri"
+                    },
+                    "html_url": {
+                      "type": "string",
+                      "format": "uri",
+                      "example": "https://github.com/orgs/rails/teams/core"
+                    },
+                    "name": {
+                      "description": "Name of the team",
+                      "example": "Developers",
+                      "type": "string"
+                    },
+                    "slug": {
+                      "type": "string",
+                      "example": "justice-league"
+                    },
+                    "description": {
+                      "type": "string",
+                      "example": "A great team.",
+                      "nullable": true
+                    },
+                    "privacy": {
+                      "description": "The level of privacy this team should have",
+                      "type": "string",
+                      "enum": [
+                        "closed",
+                        "secret"
+                      ],
+                      "example": "closed"
+                    },
+                    "permission": {
+                      "description": "Permission that the team will have for its repositories",
+                      "example": "push",
+                      "type": "string"
+                    },
+                    "members_url": {
+                      "type": "string",
+                      "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+                    },
+                    "repositories_url": {
+                      "type": "string",
+                      "format": "uri",
+                      "example": "https://api.github.com/organizations/1/team/1/repos"
+                    },
+                    "parent": {
+                      "title": "Team Simple",
+                      "description": "Groups of organization members that gives permissions on specified repositories.",
+                      "type": "object",
+                      "properties": {
+                        "id": {
+                          "description": "Unique identifier of the team",
+                          "type": "integer",
+                          "example": 1
+                        },
+                        "node_id": {
+                          "type": "string",
+                          "example": "MDQ6VGVhbTE="
+                        },
+                        "url": {
+                          "description": "URL for the team",
+                          "type": "string",
+                          "format": "uri",
+                          "example": "https://api.github.com/organizations/1/team/1"
+                        },
+                        "members_url": {
+                          "type": "string",
+                          "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+                        },
+                        "name": {
+                          "description": "Name of the team",
+                          "type": "string",
+                          "example": "Justice League"
+                        },
+                        "description": {
+                          "description": "Description of the team",
+                          "type": "string",
+                          "nullable": true,
+                          "example": "A great team."
+                        },
+                        "permission": {
+                          "description": "Permission that the team will have for its repositories",
+                          "type": "string",
+                          "example": "admin"
+                        },
+                        "privacy": {
+                          "description": "The level of privacy this team should have",
+                          "type": "string",
+                          "example": "closed"
+                        },
+                        "html_url": {
+                          "type": "string",
+                          "format": "uri",
+                          "example": "https://github.com/orgs/rails/teams/core"
+                        },
+                        "repositories_url": {
+                          "type": "string",
+                          "format": "uri",
+                          "example": "https://api.github.com/organizations/1/team/1/repos"
+                        },
+                        "slug": {
+                          "type": "string",
+                          "example": "justice-league"
+                        },
+                        "ldap_dn": {
+                          "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+                          "example": "uid=example,ou=users,dc=github,dc=com",
+                          "type": "string"
+                        }
+                      },
+                      "required": [
+                        "id",
+                        "node_id",
+                        "url",
+                        "members_url",
+                        "name",
+                        "description",
+                        "permission",
+                        "html_url",
+                        "repositories_url",
+                        "slug"
+                      ],
+                      "nullable": true
+                    },
+                    "members_count": {
+                      "type": "integer",
+                      "example": 3
+                    },
+                    "repos_count": {
+                      "type": "integer",
+                      "example": 10
+                    },
+                    "created_at": {
+                      "type": "string",
+                      "format": "date-time",
+                      "example": "2017-07-14T16:53:42Z"
+                    },
+                    "updated_at": {
+                      "type": "string",
+                      "format": "date-time",
+                      "example": "2017-08-17T12:37:15Z"
+                    },
+                    "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"
+                      ]
+                    },
+                    "ldap_dn": {
+                      "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+                      "example": "uid=example,ou=users,dc=github,dc=com",
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "id",
+                    "node_id",
+                    "url",
+                    "members_url",
+                    "name",
+                    "description",
+                    "permission",
+                    "html_url",
+                    "repositories_url",
+                    "slug",
+                    "created_at",
+                    "updated_at",
+                    "members_count",
+                    "repos_count",
+                    "organization"
+                  ]
+                },
+                "examples": {
+                  "default": {
+                    "value": {
+                      "id": 1,
+                      "node_id": "MDQ6VGVhbTE=",
+                      "url": "https://api.github.com/teams/1",
+                      "html_url": "https://github.com/orgs/github/teams/justice-league",
+                      "name": "Justice League",
+                      "slug": "justice-league",
+                      "description": "A great team.",
+                      "privacy": "closed",
+                      "permission": "admin",
+                      "members_url": "https://api.github.com/teams/1/members{/member}",
+                      "repositories_url": "https://api.github.com/teams/1/repos",
+                      "members_count": 3,
+                      "repos_count": 10,
+                      "created_at": "2017-07-14T16:53:42Z",
+                      "updated_at": "2017-08-17T12:37:15Z",
+                      "organization": {
+                        "login": "github",
+                        "id": 1,
+                        "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+                        "url": "https://api.github.com/orgs/github",
+                        "repos_url": "https://api.github.com/orgs/github/repos",
+                        "events_url": "https://api.github.com/orgs/github/events",
+                        "hooks_url": "https://api.github.com/orgs/github/hooks",
+                        "issues_url": "https://api.github.com/orgs/github/issues",
+                        "members_url": "https://api.github.com/orgs/github/members{/member}",
+                        "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
+                        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+                        "description": "A great organization",
+                        "name": "github",
+                        "company": "GitHub",
+                        "blog": "https://github.com/blog",
+                        "location": "San Francisco",
+                        "email": "octocat@github.com",
+                        "has_organization_projects": true,
+                        "has_repository_projects": true,
+                        "public_repos": 2,
+                        "public_gists": 1,
+                        "followers": 20,
+                        "following": 0,
+                        "html_url": "https://github.com/octocat",
+                        "created_at": "2008-01-14T04:33:35Z",
+                        "updated_at": "2017-08-17T12:37:15Z",
+                        "type": "Organization"
+                      },
+                      "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+                    }
+                  }
+                }
+              }
+            }
+          },
           "201": {
             "description": "Response",
             "content": {
@@ -102083,6 +102581,127 @@
                 }
               }
             }
+          },
+          "403": {
+            "description": "Forbidden",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "Basic Error",
+                  "description": "Basic Error",
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string"
+                    },
+                    "documentation_url": {
+                      "type": "string"
+                    },
+                    "url": {
+                      "type": "string"
+                    },
+                    "status": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Resource not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "Basic Error",
+                  "description": "Basic Error",
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string"
+                    },
+                    "documentation_url": {
+                      "type": "string"
+                    },
+                    "url": {
+                      "type": "string"
+                    },
+                    "status": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation failed",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "Validation Error",
+                  "description": "Validation Error",
+                  "type": "object",
+                  "required": [
+                    "message",
+                    "documentation_url"
+                  ],
+                  "properties": {
+                    "message": {
+                      "type": "string"
+                    },
+                    "documentation_url": {
+                      "type": "string"
+                    },
+                    "errors": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "required": [
+                          "code"
+                        ],
+                        "properties": {
+                          "resource": {
+                            "type": "string"
+                          },
+                          "field": {
+                            "type": "string"
+                          },
+                          "message": {
+                            "type": "string"
+                          },
+                          "code": {
+                            "type": "string"
+                          },
+                          "index": {
+                            "type": "integer"
+                          },
+                          "value": {
+                            "oneOf": [
+                              {
+                                "type": "string",
+                                "nullable": true
+                              },
+                              {
+                                "type": "integer",
+                                "nullable": true
+                              },
+                              {
+                                "type": "array",
+                                "nullable": true,
+                                "items": {
+                                  "type": "string"
+                                }
+                              }
+                            ]
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
           }
         },
         "x-github": {
@@ -212599,6 +213218,7 @@
             "description": "The base branch and head branch to compare. This parameter expects the format `{base}...{head}`.",
             "in": "path",
             "required": true,
+            "x-multi-segment": true,
             "schema": {
               "type": "string"
             }
@@ -236977,7 +237597,7 @@
     "/repos/{owner}/{repo}/git/trees/{tree_sha}": {
       "get": {
         "summary": "Get a tree",
-        "description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.",
+        "description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.",
         "tags": [
           "git"
         ],