|
1 | 1 | { |
2 | 2 | "openapi": "3.0.3", |
3 | 3 | "info": { |
4 | | - "version": "5.1.2", |
| 4 | + "version": "5.1.3", |
5 | 5 | "title": "GitHub's official OpenAPI spec + Octokit extension", |
6 | 6 | "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", |
7 | 7 | "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, |
@@ -45124,112 +45124,54 @@ |
45124 | 45124 | "type": "integer", |
45125 | 45125 | "example": 1 |
45126 | 45126 | }, |
45127 | | - "events_url": { |
45128 | | - "type": "string", |
45129 | | - "format": "uri", |
45130 | | - "example": "http://api.github.com/repos/octocat/Hello-World/events" |
45131 | | - }, |
45132 | | - "forks_url": { |
45133 | | - "type": "string", |
45134 | | - "format": "uri", |
45135 | | - "example": "http://api.github.com/repos/octocat/Hello-World/forks" |
45136 | | - }, |
45137 | | - "git_commits_url": { |
45138 | | - "type": "string", |
45139 | | - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" |
45140 | | - }, |
45141 | | - "git_refs_url": { |
45142 | | - "type": "string", |
45143 | | - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" |
45144 | | - }, |
45145 | | - "git_tags_url": { |
45146 | | - "type": "string", |
45147 | | - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" |
45148 | | - }, |
45149 | | - "git_url": { "type": "string" }, |
45150 | | - "issue_comment_url": { |
45151 | | - "type": "string", |
45152 | | - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" |
45153 | | - }, |
45154 | | - "issue_events_url": { |
45155 | | - "type": "string", |
45156 | | - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" |
45157 | | - }, |
45158 | | - "issues_url": { |
45159 | | - "type": "string", |
45160 | | - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" |
45161 | | - }, |
45162 | | - "keys_url": { |
45163 | | - "type": "string", |
45164 | | - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" |
45165 | | - }, |
45166 | | - "labels_url": { |
45167 | | - "type": "string", |
45168 | | - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" |
45169 | | - }, |
45170 | | - "languages_url": { |
45171 | | - "type": "string", |
45172 | | - "format": "uri", |
45173 | | - "example": "http://api.github.com/repos/octocat/Hello-World/languages" |
45174 | | - }, |
45175 | | - "merges_url": { |
| 45127 | + "node_id": { "type": "string", "example": "MDQ6VGVhbTE=" }, |
| 45128 | + "url": { |
| 45129 | + "description": "URL for the team", |
45176 | 45130 | "type": "string", |
45177 | 45131 | "format": "uri", |
45178 | | - "example": "http://api.github.com/repos/octocat/Hello-World/merges" |
45179 | | - }, |
45180 | | - "milestones_url": { |
45181 | | - "type": "string", |
45182 | | - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" |
45183 | | - }, |
45184 | | - "notifications_url": { |
45185 | | - "type": "string", |
45186 | | - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" |
45187 | | - }, |
45188 | | - "pulls_url": { |
45189 | | - "type": "string", |
45190 | | - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" |
| 45132 | + "example": "https://api.github.com/organizations/1/team/1" |
45191 | 45133 | }, |
45192 | | - "releases_url": { |
| 45134 | + "members_url": { |
45193 | 45135 | "type": "string", |
45194 | | - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" |
| 45136 | + "example": "https://api.github.com/organizations/1/team/1/members{/member}" |
45195 | 45137 | }, |
45196 | | - "ssh_url": { "type": "string" }, |
45197 | | - "stargazers_url": { |
| 45138 | + "name": { |
| 45139 | + "description": "Name of the team", |
45198 | 45140 | "type": "string", |
45199 | | - "format": "uri", |
45200 | | - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" |
| 45141 | + "example": "Justice League" |
45201 | 45142 | }, |
45202 | | - "statuses_url": { |
| 45143 | + "description": { |
| 45144 | + "description": "Description of the team", |
45203 | 45145 | "type": "string", |
45204 | | - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" |
| 45146 | + "nullable": true, |
| 45147 | + "example": "A great team." |
45205 | 45148 | }, |
45206 | | - "subscribers_url": { |
| 45149 | + "permission": { |
| 45150 | + "description": "Permission that the team will have for its repositories", |
45207 | 45151 | "type": "string", |
45208 | | - "format": "uri", |
45209 | | - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" |
| 45152 | + "example": "admin" |
45210 | 45153 | }, |
45211 | | - "subscription_url": { |
| 45154 | + "privacy": { |
| 45155 | + "description": "The level of privacy this team should have", |
45212 | 45156 | "type": "string", |
45213 | | - "format": "uri", |
45214 | | - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" |
| 45157 | + "example": "closed" |
45215 | 45158 | }, |
45216 | | - "tags_url": { |
| 45159 | + "html_url": { |
45217 | 45160 | "type": "string", |
45218 | 45161 | "format": "uri", |
45219 | | - "example": "http://api.github.com/repos/octocat/Hello-World/tags" |
| 45162 | + "example": "https://github.com/orgs/rails/teams/core" |
45220 | 45163 | }, |
45221 | | - "teams_url": { |
| 45164 | + "repositories_url": { |
45222 | 45165 | "type": "string", |
45223 | 45166 | "format": "uri", |
45224 | | - "example": "http://api.github.com/repos/octocat/Hello-World/teams" |
45225 | | - }, |
45226 | | - "trees_url": { |
45227 | | - "type": "string", |
45228 | | - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" |
| 45167 | + "example": "https://api.github.com/organizations/1/team/1/repos" |
45229 | 45168 | }, |
45230 | | - "clone_url": { "type": "string" }, |
45231 | | - "mirror_url": { "type": "string", "nullable": true }, |
45232 | | - "parent": { "$ref": "#/components/schemas/nullable-team-simple" } |
| 45169 | + "slug": { "type": "string", "example": "justice-league" }, |
| 45170 | + "ldap_dn": { |
| 45171 | + "description": "Distinguished Name (DN) that team maps to within LDAP environment", |
| 45172 | + "example": "uid=example,ou=users,dc=github,dc=com", |
| 45173 | + "type": "string" |
| 45174 | + } |
45233 | 45175 | }, |
45234 | 45176 | "required": [ |
45235 | 45177 | "id", |
|
45241 | 45183 | "permission", |
45242 | 45184 | "html_url", |
45243 | 45185 | "repositories_url", |
45244 | | - "slug", |
45245 | | - "parent" |
45246 | | - ] |
| 45186 | + "slug" |
| 45187 | + ], |
| 45188 | + "nullable": true |
45247 | 45189 | }, |
45248 | 45190 | "team": { |
45249 | 45191 | "title": "Team", |
@@ -45300,130 +45242,42 @@ |
45300 | 45242 | "url": { |
45301 | 45243 | "type": "string", |
45302 | 45244 | "format": "uri", |
45303 | | - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" |
| 45245 | + "example": "https://api.github.com/orgs/octocat/memberships/defunkt" |
45304 | 45246 | }, |
45305 | | - "svn_url": { "type": "string" }, |
45306 | | - "homepage": { "type": "string", "nullable": true }, |
45307 | | - "language": { "type": "string", "nullable": true }, |
45308 | | - "user": { "$ref": "#/components/schemas/nullable-simple-user" }, |
45309 | | - "stargazers_count": { "type": "integer" }, |
45310 | | - "owner": { "$ref": "#/components/schemas/nullable-simple-user" }, |
45311 | | - "size": { "type": "integer" }, |
45312 | | - "default_branch": { "type": "string" }, |
45313 | | - "open_issues_count": { "type": "integer" }, |
45314 | | - "exclude_metadata": { "type": "boolean" }, |
45315 | | - "exclude_git_data": { "type": "boolean" }, |
45316 | | - "exclude_attachments": { "type": "boolean" }, |
45317 | | - "exclude_releases": { "type": "boolean" }, |
45318 | | - "exclude_owner_projects": { "type": "boolean" }, |
45319 | | - "repositories": { "type": "array", "items": { "type": "string" } }, |
45320 | | - "has_issues": { "type": "boolean" }, |
45321 | | - "has_projects": { "type": "boolean" }, |
45322 | | - "has_wiki": { "type": "boolean" }, |
45323 | | - "has_pages": { "type": "boolean" }, |
45324 | | - "has_downloads": { "type": "boolean" }, |
45325 | | - "archived": { "type": "boolean" }, |
45326 | | - "disabled": { "type": "boolean" }, |
45327 | | - "visibility": { "type": "string" }, |
45328 | | - "pushed_at": { |
| 45247 | + "state": { |
45329 | 45248 | "type": "string", |
45330 | | - "format": "date-time", |
45331 | | - "example": "2011-01-26T19:06:43Z", |
45332 | | - "nullable": true |
| 45249 | + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", |
| 45250 | + "example": "active", |
| 45251 | + "enum": ["active", "pending"] |
45333 | 45252 | }, |
45334 | | - "created_at": { |
| 45253 | + "role": { |
45335 | 45254 | "type": "string", |
45336 | | - "format": "date-time", |
45337 | | - "example": "2011-01-26T19:01:12Z", |
45338 | | - "nullable": true |
| 45255 | + "description": "The user's membership type in the organization.", |
| 45256 | + "example": "admin", |
| 45257 | + "enum": ["admin", "member", "billing_manager"] |
45339 | 45258 | }, |
45340 | | - "updated_at": { |
| 45259 | + "organization_url": { |
45341 | 45260 | "type": "string", |
45342 | | - "format": "date-time", |
45343 | | - "example": "2011-01-26T19:14:43Z", |
45344 | | - "nullable": true |
45345 | | - }, |
45346 | | - "permissions": { |
45347 | | - "type": "object", |
45348 | | - "properties": { |
45349 | | - "admin": { "type": "boolean" }, |
45350 | | - "maintain": { "type": "boolean" }, |
45351 | | - "push": { "type": "boolean" }, |
45352 | | - "triage": { "type": "boolean" }, |
45353 | | - "pull": { "type": "boolean" } |
45354 | | - } |
| 45261 | + "format": "uri", |
| 45262 | + "example": "https://api.github.com/orgs/octocat" |
45355 | 45263 | }, |
45356 | | - "template_repository": { |
45357 | | - "$ref": "#/components/schemas/nullable-repository" |
| 45264 | + "organization": { |
| 45265 | + "$ref": "#/components/schemas/organization-simple" |
45358 | 45266 | }, |
45359 | | - "temp_clone_token": { "type": "string" }, |
45360 | | - "delete_branch_on_merge": { "type": "boolean" }, |
45361 | | - "subscribers_count": { "type": "integer" }, |
45362 | | - "network_count": { "type": "integer" }, |
45363 | | - "code_of_conduct": { "$ref": "#/components/schemas/code-of-conduct" }, |
45364 | | - "license": { |
| 45267 | + "user": { "$ref": "#/components/schemas/nullable-simple-user" }, |
| 45268 | + "permissions": { |
45365 | 45269 | "type": "object", |
45366 | | - "properties": { |
45367 | | - "key": { "type": "string" }, |
45368 | | - "name": { "type": "string" }, |
45369 | | - "spdx_id": { "type": "string" }, |
45370 | | - "url": { "type": "string" }, |
45371 | | - "node_id": { "type": "string" } |
45372 | | - }, |
45373 | | - "nullable": true |
45374 | | - }, |
45375 | | - "forks": { "type": "integer", "example": 0 }, |
45376 | | - "open_issues": { "type": "integer", "example": 0 }, |
45377 | | - "watchers": { "type": "integer", "example": 0 } |
| 45270 | + "properties": { "can_create_repository": { "type": "boolean" } }, |
| 45271 | + "required": ["can_create_repository"] |
| 45272 | + } |
45378 | 45273 | }, |
45379 | 45274 | "required": [ |
45380 | | - "archive_url", |
45381 | | - "assignees_url", |
45382 | | - "blobs_url", |
45383 | | - "branches_url", |
45384 | | - "collaborators_url", |
45385 | | - "comments_url", |
45386 | | - "commits_url", |
45387 | | - "compare_url", |
45388 | | - "contents_url", |
45389 | | - "contributors_url", |
45390 | | - "deployments_url", |
45391 | | - "description", |
45392 | | - "downloads_url", |
45393 | | - "events_url", |
45394 | | - "fork", |
45395 | | - "forks_url", |
45396 | | - "full_name", |
45397 | | - "git_commits_url", |
45398 | | - "git_refs_url", |
45399 | | - "git_tags_url", |
45400 | | - "hooks_url", |
45401 | | - "html_url", |
45402 | | - "id", |
45403 | | - "node_id", |
45404 | | - "issue_comment_url", |
45405 | | - "issue_events_url", |
45406 | | - "issues_url", |
45407 | | - "keys_url", |
45408 | | - "labels_url", |
45409 | | - "languages_url", |
45410 | | - "merges_url", |
45411 | | - "milestones_url", |
45412 | | - "name", |
45413 | | - "notifications_url", |
45414 | | - "owner", |
45415 | | - "guid", |
45416 | 45275 | "state", |
45417 | | - "lock_repositories", |
45418 | | - "exclude_metadata", |
45419 | | - "exclude_git_data", |
45420 | | - "exclude_attachments", |
45421 | | - "exclude_releases", |
45422 | | - "exclude_owner_projects", |
45423 | | - "repositories", |
| 45276 | + "role", |
| 45277 | + "organization_url", |
45424 | 45278 | "url", |
45425 | | - "created_at", |
45426 | | - "updated_at" |
| 45279 | + "organization", |
| 45280 | + "user" |
45427 | 45281 | ] |
45428 | 45282 | }, |
45429 | 45283 | "migration": { |
@@ -45463,45 +45317,13 @@ |
45463 | 45317 | "format": "date-time", |
45464 | 45318 | "example": "2015-07-06T15:33:38-07:00" |
45465 | 45319 | }, |
45466 | | - "forks": { "type": "integer", "example": 0 }, |
45467 | | - "open_issues": { "type": "integer", "example": 0 }, |
45468 | | - "watchers": { "type": "integer", "example": 0 } |
| 45320 | + "node_id": { "type": "string" }, |
| 45321 | + "archive_url": { "type": "string", "format": "uri" }, |
| 45322 | + "exclude": { "type": "array", "items": {} } |
45469 | 45323 | }, |
45470 | 45324 | "required": [ |
45471 | | - "archive_url", |
45472 | | - "assignees_url", |
45473 | | - "blobs_url", |
45474 | | - "branches_url", |
45475 | | - "collaborators_url", |
45476 | | - "comments_url", |
45477 | | - "commits_url", |
45478 | | - "compare_url", |
45479 | | - "contents_url", |
45480 | | - "contributors_url", |
45481 | | - "deployments_url", |
45482 | | - "description", |
45483 | | - "downloads_url", |
45484 | | - "events_url", |
45485 | | - "fork", |
45486 | | - "forks_url", |
45487 | | - "full_name", |
45488 | | - "git_commits_url", |
45489 | | - "git_refs_url", |
45490 | | - "git_tags_url", |
45491 | | - "hooks_url", |
45492 | | - "html_url", |
45493 | 45325 | "id", |
45494 | 45326 | "node_id", |
45495 | | - "issue_comment_url", |
45496 | | - "issue_events_url", |
45497 | | - "issues_url", |
45498 | | - "keys_url", |
45499 | | - "labels_url", |
45500 | | - "languages_url", |
45501 | | - "merges_url", |
45502 | | - "milestones_url", |
45503 | | - "name", |
45504 | | - "notifications_url", |
45505 | 45327 | "owner", |
45506 | 45328 | "guid", |
45507 | 45329 | "state", |
|
0 commit comments