@octokit/openapi 7.5.0 → 7.6.0

package/generated/ghes-3.3-diff-to-ghes-3.4.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "7.5.0",
+    "version": "7.6.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": {
@@ -2710,6 +2710,11 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/branch-with-protection"
+                },
+                "examples": {
+                  "default": {
+                    "$ref": "#/components/examples/branch-get"
+                  }
                 }
               }
             }
@@ -3044,6 +3049,11 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/protected-branch"
+                },
+                "examples": {
+                  "default": {
+                    "$ref": "#/components/examples/branch-protection-update"
+                  }
                 }
               }
             }
@@ -5090,14 +5100,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.",
@@ -6058,7 +6060,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",
@@ -8113,6 +8115,258 @@
         ],
         "nullable": true
       },
+      "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
+          },
+          "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"
+        ]
+      },
       "commit": {
         "title": "Commit",
         "description": "Commit",
@@ -10107,6 +10361,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",
@@ -10303,6 +10660,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-pull-request-review": {
         "value": {
           "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews",