1#%RAML 0.8 2--- 3title: GitHub API 4version: v3 5baseUri: https://api.github.com/ 6securitySchemes: 7 - basic: 8 type: Basic Authentication 9 - oauth_2_0: 10 description: | 11 OAuth2 is a protocol that lets external apps request authorization to private 12 details in a user's GitHub account without getting their password. This is 13 preferred over Basic Authentication because tokens can be limited to specific 14 types of data, and can be revoked by users at any time. 15 type: OAuth 2.0 16 describedBy: 17 headers: 18 Authorization: 19 description: | 20 Used to send a valid OAuth 2 access token. Do not use together with 21 the "access_token" query string parameter. 22 type: string 23 queryParameters: 24 access_token: 25 description: | 26 Used to send a valid OAuth 2 access token. Do not use together with 27 the "Authorization" header 28 type: string 29 responses: 30 404: 31 description: Unauthorized 32 settings: 33 authorizationUri: https://github.com/login/oauth/authorize 34 accessTokenUri: https://github.com/login/oauth/access_token 35 authorizationGrants: [ code ] 36 scopes: 37 - "user" 38 - "user:email" 39 - "user:follow" 40 - "public_repo" 41 - "repo" 42 - "repo:status" 43 - "delete_repo" 44 - "notifications" 45 - "gist" 46securedBy: [ oauth_2_0, basic ] 47mediaType: application/json 48resourceTypes: 49 - base: 50 get?: &common 51 headers: 52 X-GitHub-Media-Type: 53 description: | 54 You can check the current version of media type in responses. 55 type: string 56 Accept: 57 description: Is used to set specified media type. 58 type: string 59 X-RateLimit-Limit: 60 type: integer 61 X-RateLimit-Remaining: 62 type: integer 63 X-RateLimit-Reset: 64 type: integer 65 X-GitHub-Request-Id: 66 type: integer 67 responses: 68 403: 69 description: | 70 API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting 71 for details. 72 post?: *common 73 patch?: *common 74 put?: *common 75 delete?: *common 76 - item: 77 type: base 78 get?: 79 post?: 80 patch?: 81 put?: 82 delete?: 83 responses: 84 204: 85 description: Item removed. 86 - collection: 87 type: base 88 get?: 89 post?: 90traits: 91 - historical: 92 queryParameters: 93 since: 94 description: | 95 Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ. 96 Only gists updated at or after this time are returned. 97 type: string 98 - filterable: 99 queryParameters: 100 filter: 101 description: | 102 Issues assigned to you / created by you / mentioning you / you're 103 subscribed to updates for / All issues the authenticated user can see 104 enum: 105 - assigned 106 - created 107 - mentioned 108 - subscribed 109 - all 110 default: all 111 required: true 112 state: 113 enum: 114 - open 115 - closed 116 default: open 117 required: true 118 labels: 119 description: String list of comma separated Label names. Example - bug,ui,@high. 120 type: string 121 required: true 122 sort: 123 enum: 124 - created 125 - updated 126 - comments 127 default: created 128 required: true 129 direction: 130 enum: 131 - asc 132 - desc 133 default: desc 134 required: true 135 since: 136 description: | 137 Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. 138 Only issues updated at or after this time are returned. 139 type: string 140# Search 141/search: 142 /repositories: 143 type: collection 144 get: 145 is: [filterable] 146 description: Search repositories. 147 queryParameters: 148 q: 149 description: | 150 The search terms. This can be any combination of the supported repository 151 search parameters: 152 'Search In' Qualifies which fields are searched. With this qualifier you 153 can restrict the search to just the repository name, description, readme, 154 or any combination of these. 155 'Size' Finds repositories that match a certain size (in kilobytes). 156 'Forks' Filters repositories based on the number of forks, and/or whether 157 forked repositories should be included in the results at all. 158 'Created' and 'Last Updated' Filters repositories based on times of 159 creation, or when they were last updated. 160 'Users or Repositories' Limits searches to a specific user or repository. 161 'Languages' Searches repositories based on the language they're written in. 162 'Stars' Searches repositories based on the number of stars. 163 type: string 164 required: true 165 sort: 166 description: If not provided, results are sorted by best match. 167 enum: 168 - stars 169 - forks 170 - updated 171 order: 172 enum: 173 - asc 174 - desc 175 default: desc 176 responses: 177 200: 178 body: 179 schema: | 180 { 181 "$schema": "http://json-schema.org/draft-03/schema", 182 "type": "object", 183 "properties": { 184 "total_count": { 185 "type": "integer" 186 }, 187 "items": [ 188 { 189 "properties": { 190 "id": { 191 "type": "integer" 192 }, 193 "name": { 194 "type": "string" 195 }, 196 "full_name": { 197 "type": "string" 198 }, 199 "owner": { 200 "properties": { 201 "login": { 202 "type": "string" 203 }, 204 "id": { 205 "type": "integer" 206 }, 207 "avatar_url": { 208 "type": "string" 209 }, 210 "gravatar_id": { 211 "type": "string" 212 }, 213 "url": { 214 "type": "string" 215 }, 216 "received_events_url": { 217 "type": "string" 218 }, 219 "type": { 220 "type": "string" 221 } 222 }, 223 "type": "object" 224 }, 225 "private": { 226 "type": "boolean" 227 }, 228 "html_url": { 229 "type": "string" 230 }, 231 "description": { 232 "type": "string" 233 }, 234 "fork": { 235 "type": "boolean" 236 }, 237 "url": { 238 "type": "string" 239 }, 240 "created_at": { 241 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 242 "type": "string" 243 }, 244 "updated_at": { 245 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 246 "type": "string" 247 }, 248 "pushed_at": { 249 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 250 "type": "string" 251 }, 252 "homepage": { 253 "type": "string" 254 }, 255 "size": { 256 "type": "integer" 257 }, 258 "watchers_count": { 259 "type": "integer" 260 }, 261 "language": { 262 "type": "string" 263 }, 264 "forks_count": { 265 "type": "integer" 266 }, 267 "open_issues_count": { 268 "type": "integer" 269 }, 270 "forks": { 271 "type": "integer" 272 }, 273 "open_issues": { 274 "type": "integer" 275 }, 276 "watchers": { 277 "type": "integer" 278 }, 279 "master_branch": { 280 "type": "string" 281 }, 282 "default_branch": { 283 "type": "string" 284 }, 285 "score": { 286 "type": "number" 287 } 288 }, 289 "type": "object" 290 } 291 ], 292 "type": "array" 293 } 294 } 295 example: | 296 { 297 "total_count": 40, 298 "items": [ 299 { 300 "id": 3081286, 301 "name": "Tetris", 302 "full_name": "dtrupenn/Tetris", 303 "owner": { 304 "login": "dtrupenn", 305 "id": 872147, 306 "avatar_url": "https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", 307 "gravatar_id": "e7956084e75f239de85d3a31bc172ace", 308 "url": "https://api.github.com/users/dtrupenn", 309 "received_events_url": "https://api.github.com/users/dtrupenn/received_events", 310 "type": "User" 311 }, 312 "private": false, 313 "html_url": "https://github.com/dtrupenn/Tetris", 314 "description": "A C implementation of Tetris using Pennsim through LC4", 315 "fork": false, 316 "url": "https://api.github.com/repos/dtrupenn/Tetris", 317 "created_at": "2012-01-01T00:31:50Z", 318 "updated_at": "2013-01-05T17:58:47Z", 319 "pushed_at": "2012-01-01T00:37:02Z", 320 "homepage": "", 321 "size": 524, 322 "watchers_count": 1, 323 "language": "Assembly", 324 "forks_count": 0, 325 "open_issues_count": 0, 326 "forks": 0, 327 "open_issues": 0, 328 "watchers": 1, 329 "master_branch": "master", 330 "default_branch": "master", 331 "score": 10.309712 332 } 333 ] 334 } 335 /code: 336 type: collection 337 get: 338 description: Search code. 339 queryParameters: 340 q: 341 description: | 342 The search terms. This can be any combination of the supported code 343 search parameters: 344 'Search In' Qualifies which fields are searched. With this qualifier 345 you can restrict the search to just the file contents, the file path, 346 or both. 347 'Languages' Searches code based on the language it's written in. 348 'Forks' Filters repositories based on the number of forks, and/or 349 whether code from forked repositories should be included in the results 350 at all. 351 'Size' Finds files that match a certain size (in bytes). 352 'Path' Specifies the path that the resulting file must be at. 353 'Extension' Matches files with a certain extension. 354 'Users' or 'Repositories' Limits searches to a specific user or repository. 355 type: string 356 required: true 357 sort: 358 description: | 359 Can only be 'indexed', which indicates how recently a file has been indexed 360 by the GitHub search infrastructure. If not provided, results are sorted 361 by best match. 362 enum: 363 - indexed 364 order: 365 enum: 366 - asc 367 - desc 368 default: desc 369 responses: 370 200: 371 body: 372 schema: | 373 { 374 "$schema": "http://json-schema.org/draft-03/schema", 375 "type": "object", 376 "properties": { 377 "total_count": { 378 "type": "integer" 379 }, 380 "items": [ 381 { 382 "properties": { 383 "name": { 384 "type": "string" 385 }, 386 "path": { 387 "type": "string" 388 }, 389 "sha": { 390 "type": "string" 391 }, 392 "url": { 393 "type": "string" 394 }, 395 "git_url": { 396 "type": "string" 397 }, 398 "html_url": { 399 "type": "string" 400 }, 401 "repository": { 402 "properties": { 403 "id": { 404 "type": "integer" 405 }, 406 "name": { 407 "type": "string" 408 }, 409 "full_name": { 410 "type": "string" 411 }, 412 "owner": { 413 "properties": { 414 "login": { 415 "type": "string" 416 }, 417 "id": { 418 "type": "integer" 419 }, 420 "avatar_url": { 421 "type": "string" 422 }, 423 "gravatar_id": { 424 "type": "string" 425 }, 426 "url": { 427 "type": "string" 428 }, 429 "html_url": { 430 "type": "string" 431 }, 432 "followers_url": { 433 "type": "string" 434 }, 435 "following_url": { 436 "type": "string" 437 }, 438 "gists_url": { 439 "type": "string" 440 }, 441 "starred_url": { 442 "type": "string" 443 }, 444 "subscriptions_url": { 445 "type": "string" 446 }, 447 "organizations_url": { 448 "type": "string" 449 }, 450 "repos_url": { 451 "type": "string" 452 }, 453 "events_url": { 454 "type": "string" 455 }, 456 "received_events_url": { 457 "type": "string" 458 }, 459 "type": { 460 "type": "string" 461 } 462 }, 463 "type": "object" 464 }, 465 "private": { 466 "type": "boolean" 467 }, 468 "html_url": { 469 "type": "string" 470 }, 471 "description": { 472 "type": "string" 473 }, 474 "fork": { 475 "type": "boolean" 476 }, 477 "url": { 478 "type": "string" 479 }, 480 "forks_url": { 481 "type": "string" 482 }, 483 "keys_url": { 484 "type": "string" 485 }, 486 "collaborators_url": { 487 "type": "string" 488 }, 489 "teams_url": { 490 "type": "string" 491 }, 492 "hooks_url": { 493 "type": "string" 494 }, 495 "issue_events_url": { 496 "type": "string" 497 }, 498 "events_url": { 499 "type": "string" 500 }, 501 "assignees_url": { 502 "type": "string" 503 }, 504 "branches_url": { 505 "type": "string" 506 }, 507 "tags_url": { 508 "type": "string" 509 }, 510 "blobs_url": { 511 "type": "string" 512 }, 513 "git_tags_url": { 514 "type": "string" 515 }, 516 "git_refs_url": { 517 "type": "string" 518 }, 519 "trees_url": { 520 "type": "string" 521 }, 522 "statuses_url": { 523 "type": "string" 524 }, 525 "languages_url": { 526 "type": "string" 527 }, 528 "stargazers_url": { 529 "type": "string" 530 }, 531 "contributors_url": { 532 "type": "string" 533 }, 534 "subscribers_url": { 535 "type": "string" 536 }, 537 "subscription_url": { 538 "type": "string" 539 }, 540 "commits_url": { 541 "type": "string" 542 }, 543 "git_commits_url": { 544 "type": "string" 545 }, 546 "comments_url": { 547 "type": "string" 548 }, 549 "issue_comment_url": { 550 "type": "string" 551 }, 552 "contents_url": { 553 "type": "string" 554 }, 555 "compare_url": { 556 "type": "string" 557 }, 558 "merges_url": { 559 "type": "string" 560 }, 561 "archive_url": { 562 "type": "string" 563 }, 564 "downloads_url": { 565 "type": "string" 566 }, 567 "issues_url": { 568 "type": "string" 569 }, 570 "pulls_url": { 571 "type": "string" 572 }, 573 "milestones_url": { 574 "type": "string" 575 }, 576 "notifications_url": { 577 "type": "string" 578 }, 579 "labels_url": { 580 "type": "string" 581 } 582 }, 583 "type": "object" 584 }, 585 "score": { 586 "type": "number" 587 } 588 }, 589 "type": "object" 590 } 591 ], 592 "type": "array" 593 } 594 } 595 example: | 596 { 597 "total_count": 104, 598 "items": [ 599 { 600 "name": "github-issue-importer.gemspec", 601 "path": "github-issue-importer.gemspec", 602 "sha": "394508202991504d8a0771ae027454facaaa045a", 603 "url": "https://api.github.com/repositories/1586630/contents/github-issue-importer.gemspec?ref=aa22a4be513163c73531e96bd99f4b49d6ded8a6", 604 "git_url": "https://api.github.com/repositories/1586630/git/blobs/394508202991504d8a0771ae027454facaaa045a", 605 "html_url": "https://github.com/johnf/github-issue-importer/blob/aa22a4be513163c73531e96bd99f4b49d6ded8a6/github-issue-importer.gemspec", 606 "repository": { 607 "id": 1586630, 608 "name": "github-issue-importer", 609 "full_name": "johnf/github-issue-importer", 610 "owner": { 611 "login": "johnf", 612 "id": 42590, 613 "avatar_url": "https://secure.gravatar.com/avatar/ab4d879ba3233a270aa14f447c795505?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", 614 "gravatar_id": "ab4d879ba3233a270aa14f447c795505", 615 "url": "https://api.github.com/users/johnf", 616 "html_url": "https://github.com/johnf", 617 "followers_url": "https://api.github.com/users/johnf/followers", 618 "following_url": "https://api.github.com/users/johnf/following{/other_user}", 619 "gists_url": "https://api.github.com/users/johnf/gists{/gist_id}", 620 "starred_url": "https://api.github.com/users/johnf/starred{/owner}{/repo}", 621 "subscriptions_url": "https://api.github.com/users/johnf/subscriptions", 622 "organizations_url": "https://api.github.com/users/johnf/orgs", 623 "repos_url": "https://api.github.com/users/johnf/repos", 624 "events_url": "https://api.github.com/users/johnf/events{/privacy}", 625 "received_events_url": "https://api.github.com/users/johnf/received_events", 626 "type": "User" 627 }, 628 "private": false, 629 "html_url": "https://github.com/johnf/github-issue-importer", 630 "description": "Import Issues from Launchpad (for now) into github", 631 "fork": false, 632 "url": "https://api.github.com/repos/johnf/github-issue-importer", 633 "forks_url": "https://api.github.com/repos/johnf/github-issue-importer/forks", 634 "keys_url": "https://api.github.com/repos/johnf/github-issue-importer/keys{/key_id}", 635 "collaborators_url": "https://api.github.com/repos/johnf/github-issue-importer/collaborators{/collaborator}", 636 "teams_url": "https://api.github.com/repos/johnf/github-issue-importer/teams", 637 "hooks_url": "https://api.github.com/repos/johnf/github-issue-importer/hooks", 638 "issue_events_url": "https://api.github.com/repos/johnf/github-issue-importer/issues/events{/number}", 639 "events_url": "https://api.github.com/repos/johnf/github-issue-importer/events", 640 "assignees_url": "https://api.github.com/repos/johnf/github-issue-importer/assignees{/user}", 641 "branches_url": "https://api.github.com/repos/johnf/github-issue-importer/branches{/branch}", 642 "tags_url": "https://api.github.com/repos/johnf/github-issue-importer/tags", 643 "blobs_url": "https://api.github.com/repos/johnf/github-issue-importer/git/blobs{/sha}", 644 "git_tags_url": "https://api.github.com/repos/johnf/github-issue-importer/git/tags{/sha}", 645 "git_refs_url": "https://api.github.com/repos/johnf/github-issue-importer/git/refs{/sha}", 646 "trees_url": "https://api.github.com/repos/johnf/github-issue-importer/git/trees{/sha}", 647 "statuses_url": "https://api.github.com/repos/johnf/github-issue-importer/statuses/{sha}", 648 "languages_url": "https://api.github.com/repos/johnf/github-issue-importer/languages", 649 "stargazers_url": "https://api.github.com/repos/johnf/github-issue-importer/stargazers", 650 "contributors_url": "https://api.github.com/repos/johnf/github-issue-importer/contributors", 651 "subscribers_url": "https://api.github.com/repos/johnf/github-issue-importer/subscribers", 652 "subscription_url": "https://api.github.com/repos/johnf/github-issue-importer/subscription", 653 "commits_url": "https://api.github.com/repos/johnf/github-issue-importer/commits{/sha}", 654 "git_commits_url": "https://api.github.com/repos/johnf/github-issue-importer/git/commits{/sha}", 655 "comments_url": "https://api.github.com/repos/johnf/github-issue-importer/comments{/number}", 656 "issue_comment_url": "https://api.github.com/repos/johnf/github-issue-importer/issues/comments/{number}", 657 "contents_url": "https://api.github.com/repos/johnf/github-issue-importer/contents/{+path}", 658 "compare_url": "https://api.github.com/repos/johnf/github-issue-importer/compare/{base}...{head}", 659 "merges_url": "https://api.github.com/repos/johnf/github-issue-importer/merges", 660 "archive_url": "https://api.github.com/repos/johnf/github-issue-importer/{archive_format}{/ref}", 661 "downloads_url": "https://api.github.com/repos/johnf/github-issue-importer/downloads", 662 "issues_url": "https://api.github.com/repos/johnf/github-issue-importer/issues{/number}", 663 "pulls_url": "https://api.github.com/repos/johnf/github-issue-importer/pulls{/number}", 664 "milestones_url": "https://api.github.com/repos/johnf/github-issue-importer/milestones{/number}", 665 "notifications_url": "https://api.github.com/repos/johnf/github-issue-importer/notifications{?since,all,participating}", 666 "labels_url": "https://api.github.com/repos/johnf/github-issue-importer/labels{/name}" 667 }, 668 "score": 0.96691436 669 } 670 ] 671 } 672 /users: 673 type: collection 674 get: 675 description: Search users. 676 queryParameters: 677 q: 678 description: | 679 The search terms. This can be any combination of the supported user 680 search parameters: 681 'Search In' Qualifies which fields are searched. With this qualifier you 682 can restrict the search to just the username, public email, full name, 683 location, or any combination of these. 684 'Repository count' Filters users based on the number of repositories they 685 have. 686 'Location' Filter users by the location indicated in their profile. 687 'Language' Search for users that have repositories that match a certain 688 language. 689 'Created' Filter users based on when they joined. 690 'Followers' Filter users based on the number of followers they have. 691 type: string 692 required: true 693 sort: 694 description: If not provided, results are sorted by best match. 695 enum: 696 - followers 697 - repositories 698 - joined 699 order: 700 enum: 701 - asc 702 - desc 703 default: desc 704 responses: 705 200: 706 body: 707 schema: | 708 { 709 "$schema": "http://json-schema.org/draft-03/schema", 710 "type": "object", 711 "properties": { 712 "total_count": { 713 "type": "integer" 714 }, 715 "items": [ 716 { 717 "properties": { 718 "login": { 719 "type": "string" 720 }, 721 "id": { 722 "type": "integer" 723 }, 724 "avatar_url": { 725 "type": "string" 726 }, 727 "gravatar_id": { 728 "type": "string" 729 }, 730 "url": { 731 "type": "string" 732 }, 733 "html_url": { 734 "type": "string" 735 }, 736 "followers_url": { 737 "type": "string" 738 }, 739 "subscriptions_url": { 740 "type": "string" 741 }, 742 "organizations_url": { 743 "type": "string" 744 }, 745 "repos_url": { 746 "type": "string" 747 }, 748 "received_events_url": { 749 "type": "string" 750 }, 751 "type": { 752 "type": "string" 753 }, 754 "score": { 755 "type": "number" 756 } 757 }, 758 "type": "object" 759 } 760 ], 761 "type": "array" 762 } 763 } 764 example: | 765 { 766 "total_count": 12, 767 "items": [ 768 { 769 "login": "mojombo", 770 "id": 1, 771 "avatar_url": "https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", 772 "gravatar_id": "25c7c18223fb42a4c6ae1c8db6f50f9b", 773 "url": "https://api.github.com/users/mojombo", 774 "html_url": "https://github.com/mojombo", 775 "followers_url": "https://api.github.com/users/mojombo/followers", 776 "subscriptions_url": "https://api.github.com/users/mojombo/subscriptions", 777 "organizations_url": "https://api.github.com/users/mojombo/orgs", 778 "repos_url": "https://api.github.com/users/mojombo/repos", 779 "received_events_url": "https://api.github.com/users/mojombo/received_events", 780 "type": "User", 781 "score": 105.47857 782 } 783 ] 784 } 785# Events 786/events: 787 type: collection 788 is: [filterable] 789 get: 790 is: [filterable, historical] 791 description: List public events. 792 responses: 793 200: 794 body: 795 schema: | 796 { 797 "$schema": "http://json-schema.org/draft-03/schema", 798 "type": "array", 799 "properties": [ 800 { 801 "properties": { 802 "type": { 803 "type": "string" 804 }, 805 "public": { 806 "type": "boolean" 807 }, 808 "payload": { 809 "properties": {}, 810 "type": "object" 811 }, 812 "repo": { 813 "properties": { 814 "id": { 815 "type": "integer" 816 }, 817 "name": { 818 "type": "string" 819 }, 820 "url": { 821 "type": "string" 822 } 823 }, 824 "type": "object" 825 }, 826 "actor": { 827 "properties": { 828 "login": { 829 "type": "string" 830 }, 831 "id": { 832 "type": "integer" 833 }, 834 "avatar_url": { 835 "type": "string" 836 }, 837 "gravatar_id": { 838 "type": "string" 839 }, 840 "url": { 841 "type": "string" 842 } 843 }, 844 "type": "object" 845 }, 846 "org": { 847 "properties": { 848 "login": { 849 "type": "string" 850 }, 851 "id": { 852 "type": "integer" 853 }, 854 "avatar_url": { 855 "type": "string" 856 }, 857 "gravatar_id": { 858 "type": "string" 859 }, 860 "url": { 861 "type": "string" 862 } 863 }, 864 "type": "object" 865 }, 866 "created_at": { 867 "type": "timestamp" 868 }, 869 "id": { 870 "type": "integer" 871 } 872 }, 873 "type": "object" 874 } 875 ] 876 } 877 example: | 878 [ 879 { 880 "type": "Event", 881 "public": true, 882 "payload": { 883 884 }, 885 "repo": { 886 "id": 3, 887 "name": "octocat/Hello-World", 888 "url": "https://api.github.com/repos/octocat/Hello-World" 889 }, 890 "actor": { 891 "login": "octocat", 892 "id": 1, 893 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 894 "gravatar_id": "somehexcode", 895 "url": "https://api.github.com/users/octocat" 896 }, 897 "org": { 898 "login": "octocat", 899 "id": 1, 900 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 901 "gravatar_id": "somehexcode", 902 "url": "https://api.github.com/users/octocat" 903 }, 904 "created_at": "2011-09-06T17:26:27Z", 905 "id": "12345" 906 } 907 ] 908# Feeds 909/feeds: 910 type: collection 911 get: 912 description: | 913 List Feeds. 914 GitHub provides several timeline resources in Atom format. The Feeds API 915 lists all the feeds available to the authenticating user. 916 responses: 917 200: 918 body: 919 schema: | 920 { 921 "$schema": "http://json-schema.org/draft-03/schema", 922 "type": "object", 923 "properties": { 924 "timeline_url": { 925 "type": "string" 926 }, 927 "user_url": { 928 "type": "string" 929 }, 930 "current_user_public": { 931 "type": "string" 932 }, 933 "current_user_url": { 934 "type": "string" 935 }, 936 "current_user_actor_url": { 937 "type": "string" 938 }, 939 "current_user_organization_url": { 940 "type": "string" 941 }, 942 "_links": { 943 "properties": { 944 "timeline": { 945 "properties": { 946 "href": { 947 "type": "string" 948 }, 949 "type": { 950 "type": "string" 951 } 952 }, 953 "type": "object" 954 }, 955 "user": { 956 "properties": { 957 "href": { 958 "type": "string" 959 }, 960 "type": { 961 "type": "string" 962 } 963 }, 964 "type": "object" 965 }, 966 "current_user_public": { 967 "properties": { 968 "href": { 969 "type": "string" 970 }, 971 "type": { 972 "type": "string" 973 } 974 }, 975 "type": "object" 976 }, 977 "current_user": { 978 "properties": { 979 "href": { 980 "type": "string" 981 }, 982 "type": { 983 "type": "string" 984 } 985 }, 986 "type": "object" 987 }, 988 "current_user_actor": { 989 "properties": { 990 "href": { 991 "type": "string" 992 }, 993 "type": { 994 "type": "string" 995 } 996 }, 997 "type": "object" 998 }, 999 "current_user_organization": { 1000 "properties": { 1001 "href": { 1002 "type": "string" 1003 }, 1004 "type": { 1005 "type": "string" 1006 } 1007 }, 1008 "type": "object" 1009 } 1010 } 1011 } 1012 } 1013 } 1014 example: | 1015 { 1016 "timeline_url": "https://github.com/timeline", 1017 "user_url": "https://github.com/{user}", 1018 "current_user_public": "https://github.com/defunkt", 1019 "current_user_url": "https://github.com/defunkt.private?token=abc123", 1020 "current_user_actor_url": "https://github.com/defunkt.private.actor?token=abc123", 1021 "current_user_organization_url": "https://github.com/organizations/{org}/defunkt.private.atom?token=abc123", 1022 "_links": { 1023 "timeline": { 1024 "href": "https://github.com/timeline", 1025 "type": "application/atom+xml" 1026 }, 1027 "user": { 1028 "href": "https://github.com/{user}", 1029 "type": "application/atom+xml" 1030 }, 1031 "current_user_public": { 1032 "href": "https://github.com/defunkt", 1033 "type": "application/atom+xml" 1034 }, 1035 "current_user": { 1036 "href": "https://github.com/defunkt.private?token=abc123", 1037 "type": "application/atom+xml" 1038 }, 1039 "current_user_actor": { 1040 "href": "https://github.com/defunkt.private.actor?token=abc123", 1041 "type": "application/atom+xml" 1042 }, 1043 "current_user_organization": { 1044 "href": "https://github.com/organizations/{org}/defunkt.private.atom?token=abc123", 1045 "type": "application/atom+xml" 1046 } 1047 } 1048 } 1049# Meta 1050/meta: 1051 type: collection 1052 get: 1053 description: This gives some information about GitHub.com, the service. 1054 responses: 1055 200: 1056 body: 1057 schema: | 1058 { 1059 "$schema": "http://json-schema.org/draft-03/schema", 1060 "type": "object", 1061 "properties": { 1062 "hooks": [ 1063 { 1064 "description": "An Array of IP addresses in CIDR format specifying the addresses that incoming service hooks will originate from.", 1065 "type": "string" 1066 } 1067 ], 1068 "type": "array", 1069 "git": [ 1070 { 1071 "description": "An Array of IP addresses in CIDR format specifying the Git servers at GitHub.", 1072 "type": "string" 1073 } 1074 ] 1075 } 1076 } 1077 example: | 1078 { 1079 "hooks": [ 1080 "127.0.0.1/32" 1081 ], 1082 "git": [ 1083 "127.0.0.1/32" 1084 ] 1085 } 1086# Rate limit 1087/rate_limit: 1088 type: collection 1089 get: 1090 description: | 1091 Get your current rate limit status 1092 Note: Accessing this endpoint does not count against your rate limit. 1093 responses: 1094 200: 1095 body: 1096 schema: | 1097 { 1098 "$schema": "http://json-schema.org/draft-03/schema", 1099 "type": "object", 1100 "properties": { 1101 "rate": { 1102 "properties": { 1103 "limit": { 1104 "type": "integer" 1105 }, 1106 "remaining": { 1107 "type": "integer" 1108 }, 1109 "reset": { 1110 "type": "integer" 1111 } 1112 } 1113 } 1114 } 1115 } 1116 example: | 1117 { 1118 "rate": { 1119 "limit": 5000, 1120 "remaining": 4999, 1121 "reset": 1372700873 1122 } 1123 } 1124# Issues 1125/issues: 1126 type: item 1127 get: 1128 is: [ filterable ] 1129 description: | 1130 List issues. 1131 List all issues across all the authenticated user's visible repositories. 1132 responses: 1133 200: 1134 body: 1135 schema: | 1136 { 1137 "$schema": "http://json-schema.org/draft-03/schema", 1138 "type": "array", 1139 "issues": [ 1140 { 1141 "properties": { 1142 "url": { 1143 "type": "string" 1144 }, 1145 "html_url": { 1146 "type": "string" 1147 }, 1148 "number": { 1149 "type": "integer" 1150 }, 1151 "state": { 1152 "enum": [ 1153 "open", 1154 "closed" 1155 ] 1156 }, 1157 "title": { 1158 "type": "string" 1159 }, 1160 "body": { 1161 "type": "string" 1162 }, 1163 "user": { 1164 "properties": { 1165 "login": { 1166 "type": "string" 1167 }, 1168 "id": { 1169 "type": "integer" 1170 }, 1171 "avatar_url": { 1172 "type": "string" 1173 }, 1174 "gravatar_id": { 1175 "type": "string" 1176 }, 1177 "url": { 1178 "type": "string" 1179 } 1180 }, 1181 "type": "object" 1182 }, 1183 "labels": [ 1184 { 1185 "properties": { 1186 "url": { 1187 "type": "string" 1188 }, 1189 "name": { 1190 "type": "string" 1191 }, 1192 "color": { 1193 "type": "string" 1194 } 1195 }, 1196 "type": "object" 1197 } 1198 ], 1199 "type": "array", 1200 "assignee": { 1201 "properties": { 1202 "login": { 1203 "type": "string" 1204 }, 1205 "id": { 1206 "type": "integer" 1207 }, 1208 "avatar_url": { 1209 "type": "string" 1210 }, 1211 "gravatar_id": { 1212 "type": "string" 1213 }, 1214 "url": { 1215 "type": "string" 1216 } 1217 }, 1218 "type": "object" 1219 }, 1220 "milestone": { 1221 "properties": { 1222 "url": { 1223 "type": "string" 1224 }, 1225 "number": { 1226 "type": "integer" 1227 }, 1228 "state": { 1229 "enum": [ 1230 "open", 1231 "closed" 1232 ] 1233 }, 1234 "title": { 1235 "type": "string" 1236 }, 1237 "description": { 1238 "type": "string" 1239 }, 1240 "creator": { 1241 "properties": { 1242 "login": { 1243 "type": "string" 1244 }, 1245 "id": { 1246 "type": "integer" 1247 }, 1248 "avatar_url": { 1249 "type": "string" 1250 }, 1251 "gravatar_id": { 1252 "type": "string" 1253 }, 1254 "url": { 1255 "type": "string" 1256 } 1257 }, 1258 "type": "object" 1259 }, 1260 "open_issues": { 1261 "type": "integer" 1262 }, 1263 "closed_issues": { 1264 "type": "integer" 1265 }, 1266 "created_at": { 1267 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 1268 "type": "string" 1269 }, 1270 "due_on": { 1271 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 1272 "type": "string" 1273 } 1274 }, 1275 "type": "object" 1276 }, 1277 "comments": { 1278 "type": "integer" 1279 }, 1280 "pull_request": { 1281 "properties": { 1282 "html_url": { 1283 "type": "string" 1284 }, 1285 "diff_url": { 1286 "type": "string" 1287 }, 1288 "patch_url": { 1289 "type": "string" 1290 } 1291 }, 1292 "type": "object" 1293 }, 1294 "closed_at": { 1295 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 1296 "type": "string" 1297 }, 1298 "created_at": { 1299 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 1300 "type": "string" 1301 }, 1302 "updated_at": { 1303 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 1304 "type": "string" 1305 } 1306 }, 1307 "type": "object" 1308 } 1309 ] 1310 } 1311 example: | 1312 [ 1313 { 1314 "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", 1315 "html_url": "https://github.com/octocat/Hello-World/issues/1347", 1316 "number": 1347, 1317 "state": "open", 1318 "title": "Found a bug", 1319 "body": "I'm having a problem with this.", 1320 "user": { 1321 "login": "octocat", 1322 "id": 1, 1323 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 1324 "gravatar_id": "somehexcode", 1325 "url": "https://api.github.com/users/octocat" 1326 }, 1327 "labels": [ 1328 { 1329 "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", 1330 "name": "bug", 1331 "color": "f29513" 1332 } 1333 ], 1334 "assignee": { 1335 "login": "octocat", 1336 "id": 1, 1337 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 1338 "gravatar_id": "somehexcode", 1339 "url": "https://api.github.com/users/octocat" 1340 }, 1341 "milestone": { 1342 "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", 1343 "number": 1, 1344 "state": "open", 1345 "title": "v1.0", 1346 "description": "", 1347 "creator": { 1348 "login": "octocat", 1349 "id": 1, 1350 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 1351 "gravatar_id": "somehexcode", 1352 "url": "https://api.github.com/users/octocat" 1353 }, 1354 "open_issues": 4, 1355 "closed_issues": 8, 1356 "created_at": "2011-04-10T20:09:31Z", 1357 "due_on": null 1358 }, 1359 "comments": 0, 1360 "pull_request": { 1361 "html_url": "https://github.com/octocat/Hello-World/issues/1347", 1362 "diff_url": "https://github.com/octocat/Hello-World/issues/1347.diff", 1363 "patch_url": "https://github.com/octocat/Hello-World/issues/1347.patch" 1364 }, 1365 "closed_at": null, 1366 "created_at": "2011-04-22T13:33:48Z", 1367 "updated_at": "2011-04-22T13:33:48Z" 1368 } 1369 ] 1370# Other 1371/notifications: 1372 type: collection 1373 get: 1374 description: | 1375 List your notifications. 1376 List all notifications for the current user, grouped by repository. 1377 queryParameters: 1378 all: 1379 description: True to show notifications marked as read. 1380 type: string 1381 participating: 1382 description: | 1383 True to show only notifications in which the user is directly participating 1384 or mentioned. 1385 type: string 1386 since: 1387 description: | 1388 Time filters out any notifications updated before the given time. The 1389 time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. 1390 Example: "2012-10-09T23:39:01Z". 1391 type: string 1392 responses: 1393 200: 1394 body: 1395 schema: | 1396 { 1397 "$schema": "http://json-schema.org/draft-03/schema", 1398 "type": "array", 1399 "properties": [ 1400 { 1401 "properties": { 1402 "id": { 1403 "type": "integer" 1404 }, 1405 "repository": { 1406 "properties": { 1407 "id": { 1408 "type": "integer" 1409 }, 1410 "owner": { 1411 "properties": { 1412 "login": { 1413 "type": "string" 1414 }, 1415 "id": { 1416 "type": "integer" 1417 }, 1418 "avatar_url": { 1419 "type": "string" 1420 }, 1421 "gravatar_id": { 1422 "type": "string" 1423 }, 1424 "url": { 1425 "type": "string" 1426 } 1427 }, 1428 "type": "object" 1429 }, 1430 "name": { 1431 "type": "string" 1432 }, 1433 "full_name": { 1434 "type": "string" 1435 }, 1436 "description": { 1437 "type": "string" 1438 }, 1439 "private": { 1440 "type": "boolean" 1441 }, 1442 "fork": { 1443 "type": "boolean" 1444 }, 1445 "url": { 1446 "type": "string" 1447 }, 1448 "html_url": { 1449 "type": "string" 1450 } 1451 }, 1452 "type": "object" 1453 }, 1454 "subject": { 1455 "properties": { 1456 "title": { 1457 "type": "string" 1458 }, 1459 "url": { 1460 "type": "string" 1461 }, 1462 "latest_comment_url": { 1463 "type": "string" 1464 }, 1465 "type": { 1466 "type": "string" 1467 } 1468 }, 1469 "type": "object" 1470 }, 1471 "reason": { 1472 "type": "string" 1473 }, 1474 "unread": { 1475 "type": "boolean" 1476 }, 1477 "updated_at": { 1478 "type": "string" 1479 }, 1480 "last_read_at": { 1481 "type": "string" 1482 }, 1483 "url": { 1484 "type": "string" 1485 } 1486 }, 1487 "type": "object" 1488 } 1489 ] 1490 } 1491 example: | 1492 [ 1493 { 1494 "id": 1, 1495 "repository": { 1496 "id": 1296269, 1497 "owner": { 1498 "login": "octocat", 1499 "id": 1, 1500 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 1501 "gravatar_id": "somehexcode", 1502 "url": "https://api.github.com/users/octocat" 1503 }, 1504 "name": "Hello-World", 1505 "full_name": "octocat/Hello-World", 1506 "description": "This your first repo!", 1507 "private": false, 1508 "fork": false, 1509 "url": "https://api.github.com/repos/octocat/Hello-World", 1510 "html_url": "https://github.com/octocat/Hello-World" 1511 }, 1512 "subject": { 1513 "title": "Greetings", 1514 "url": "https://api.github.com/repos/pengwynn/octokit/issues/123", 1515 "latest_comment_url": "https://api.github.com/repos/pengwynn/octokit/issues/comments/123", 1516 "type": "Issue" 1517 }, 1518 "reason": "subscribed", 1519 "unread": true, 1520 "updated_at": "2012-09-25T07:54:41-07:00", 1521 "last_read_at": "2012-09-25T07:54:41-07:00", 1522 "url": "https://api.github.com/notifications/threads/1" 1523 } 1524 ] 1525 put: 1526 description: | 1527 Mark as read. 1528 Marking a notification as "read" removes it from the default view on GitHub.com. 1529 body: 1530 application/json: 1531 schema: | 1532 { 1533 "$schema": "http://json-schema.org/draft-03/schema", 1534 "type": "object", 1535 "properties": { 1536 "last_read_at": { 1537 "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated. Default: Now.", 1538 "type": "string" 1539 } 1540 } 1541 } 1542 responses: 1543 205: 1544 description: Marked as read. 1545 /threads/{id}: 1546 uriParameters: 1547 id: 1548 description: Id of a thread. 1549 type: integer 1550 type: item 1551 get: 1552 description: View a single thread. 1553 responses: 1554 200: 1555 body: 1556 schema: | 1557 { 1558 "$schema": "http://json-schema.org/draft-03/schema", 1559 "type": "array", 1560 "properties": [ 1561 { 1562 "properties": { 1563 "id": { 1564 "type": "integer" 1565 }, 1566 "repository": { 1567 "properties": { 1568 "id": { 1569 "type": "integer" 1570 }, 1571 "owner": { 1572 "properties": { 1573 "login": { 1574 "type": "string" 1575 }, 1576 "id": { 1577 "type": "integer" 1578 }, 1579 "avatar_url": { 1580 "type": "string" 1581 }, 1582 "gravatar_id": { 1583 "type": "string" 1584 }, 1585 "url": { 1586 "type": "string" 1587 } 1588 }, 1589 "type": "object" 1590 }, 1591 "name": { 1592 "type": "string" 1593 }, 1594 "full_name": { 1595 "type": "string" 1596 }, 1597 "description": { 1598 "type": "string" 1599 }, 1600 "private": { 1601 "type": "boolean" 1602 }, 1603 "fork": { 1604 "type": "boolean" 1605 }, 1606 "url": { 1607 "type": "string" 1608 }, 1609 "html_url": { 1610 "type": "string" 1611 } 1612 }, 1613 "type": "object" 1614 }, 1615 "subject": { 1616 "properties": { 1617 "title": { 1618 "type": "string" 1619 }, 1620 "url": { 1621 "type": "string" 1622 }, 1623 "latest_comment_url": { 1624 "type": "string" 1625 }, 1626 "type": { 1627 "type": "string" 1628 } 1629 }, 1630 "type": "object" 1631 }, 1632 "reason": { 1633 "type": "string" 1634 }, 1635 "unread": { 1636 "type": "boolean" 1637 }, 1638 "updated_at": { 1639 "type": "string" 1640 }, 1641 "last_read_at": { 1642 "type": "string" 1643 }, 1644 "url": { 1645 "type": "string" 1646 } 1647 }, 1648 "type": "object" 1649 } 1650 ] 1651 } 1652 example: | 1653 [ 1654 { 1655 "id": 1, 1656 "repository": { 1657 "id": 1296269, 1658 "owner": { 1659 "login": "octocat", 1660 "id": 1, 1661 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 1662 "gravatar_id": "somehexcode", 1663 "url": "https://api.github.com/users/octocat" 1664 }, 1665 "name": "Hello-World", 1666 "full_name": "octocat/Hello-World", 1667 "description": "This your first repo!", 1668 "private": false, 1669 "fork": false, 1670 "url": "https://api.github.com/repos/octocat/Hello-World", 1671 "html_url": "https://github.com/octocat/Hello-World" 1672 }, 1673 "subject": { 1674 "title": "Greetings", 1675 "url": "https://api.github.com/repos/pengwynn/octokit/issues/123", 1676 "latest_comment_url": "https://api.github.com/repos/pengwynn/octokit/issues/comments/123", 1677 "type": "Issue" 1678 }, 1679 "reason": "subscribed", 1680 "unread": true, 1681 "updated_at": "2012-09-25T07:54:41-07:00", 1682 "last_read_at": "2012-09-25T07:54:41-07:00", 1683 "url": "https://api.github.com/notifications/threads/1" 1684 } 1685 ] 1686 patch: 1687 responses: 1688 205: 1689 description: Thread marked as read. 1690 /subscription: 1691 type: item 1692 get: 1693 description: Get a Thread Subscription. 1694 responses: 1695 200: 1696 body: 1697 schema: | 1698 { 1699 "$schema": "http://json-schema.org/draft-03/schema", 1700 "type": "object", 1701 "properties": { 1702 "subscribed":{ 1703 "type": "boolean" 1704 }, 1705 "ignored": { 1706 "type": "boolean" 1707 }, 1708 "reason": { 1709 "type": "boolean" 1710 }, 1711 "created_at": { 1712 "type": "string" 1713 }, 1714 "url": { 1715 "type": "string" 1716 }, 1717 "thread_url": { 1718 "type": "string" 1719 } 1720 } 1721 } 1722 example: | 1723 { 1724 "subscribed": true, 1725 "ignored": false, 1726 "reason": null, 1727 "created_at": "2012-10-06T21:34:12Z", 1728 "url": "https://api.github.com/notifications/threads/1/subscription", 1729 "thread_url": "https://api.github.com/notifications/threads/1" 1730 } 1731 put: 1732 description: | 1733 Set a Thread Subscription. 1734 This lets you subscribe to a thread, or ignore it. Subscribing to a thread 1735 is unnecessary if the user is already subscribed to the repository. Ignoring 1736 a thread will mute all future notifications (until you comment or get @mentioned). 1737 body: 1738 application/json: 1739 schema: | 1740 { 1741 "$schema": "http://json-schema.org/draft-03/schema", 1742 "type": "object", 1743 "properties": { 1744 "subscribed": { 1745 "description": "Determines if notifications should be received from this thread.", 1746 "type": "boolean" 1747 }, 1748 "ignored": { 1749 "description": "Determines if all notifications should be blocked from this thread.", 1750 "type": "string" 1751 } 1752 } 1753 } 1754 responses: 1755 200: 1756 body: 1757 schema: | 1758 { 1759 "$schema": "http://json-schema.org/draft-03/schema", 1760 "type": "object", 1761 "properties": { 1762 "subscribed":{ 1763 "type": "boolean" 1764 }, 1765 "ignored": { 1766 "type": "boolean" 1767 }, 1768 "reason": { 1769 "type": "boolean" 1770 }, 1771 "created_at": { 1772 "type": "string" 1773 }, 1774 "url": { 1775 "type": "string" 1776 }, 1777 "thread_url": { 1778 "type": "string" 1779 } 1780 } 1781 } 1782 example: | 1783 { 1784 "subscribed": true, 1785 "ignored": false, 1786 "reason": null, 1787 "created_at": "2012-10-06T21:34:12Z", 1788 "url": "https://api.github.com/notifications/threads/1/subscription", 1789 "thread_url": "https://api.github.com/notifications/threads/1" 1790 } 1791 delete: 1792 description: Delete a Thread Subscription. 1793/gists: 1794 securedBy: [ null, oauth_2_0 ] 1795 type: collection 1796 get: 1797 is: [ historical ] 1798 description: | 1799 List the authenticated user's gists or if called anonymously, this will 1800 return all public gists. 1801 responses: 1802 200: 1803 body: 1804 schema: | 1805 { 1806 "$schema": "http://json-schema.org/draft-03/schema", 1807 "type": "array", 1808 "gists": [ 1809 { 1810 "type": "object", 1811 "properties": { 1812 "url": { 1813 "type": "string" 1814 }, 1815 "id": { 1816 "type": "string" 1817 }, 1818 "description": { 1819 "type": "string" 1820 }, 1821 "public": { 1822 "type": "boolean" 1823 }, 1824 "user": { 1825 "properties": { 1826 "login": { 1827 "type": "string" 1828 }, 1829 "id": { 1830 "type": "integer" 1831 }, 1832 "avatar_url": { 1833 "type": "string" 1834 }, 1835 "gravatar_id": { 1836 "type": "string" 1837 }, 1838 "url": { 1839 "type": "string" 1840 } 1841 }, 1842 "type": "object" 1843 }, 1844 "files": { 1845 "properties": { 1846 "ring.erl": { 1847 "properties": { 1848 "size": { 1849 "type": "integer" 1850 }, 1851 "filename": { 1852 "type": "string" 1853 }, 1854 "raw_url": { 1855 "type": "string" 1856 } 1857 }, 1858 "type": "object" 1859 } 1860 }, 1861 "type": "object" 1862 }, 1863 "comments": { 1864 "type": "integer" 1865 }, 1866 "comments_url": { 1867 "type": "string" 1868 }, 1869 "html_url": { 1870 "type": "string" 1871 }, 1872 "git_pull_url": { 1873 "type": "string" 1874 }, 1875 "git_push_url": { 1876 "type": "string" 1877 }, 1878 "created_at": { 1879 "type": "string" 1880 } 1881 } 1882 } 1883 ] 1884 } 1885 example: | 1886 [ 1887 { 1888 "url": "https://api.github.com/gists/20c98223d9b59e1d48e5", 1889 "id": "1", 1890 "description": "description of gist", 1891 "public": true, 1892 "user": { 1893 "login": "octocat", 1894 "id": 1, 1895 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 1896 "gravatar_id": "somehexcode", 1897 "url": "https://api.github.com/users/octocat" 1898 }, 1899 "files": { 1900 "ring.erl": { 1901 "size": 932, 1902 "filename": "ring.erl", 1903 "raw_url": "https://gist.github.com/raw/365370/8c4d2d43d178df44f4c03a7f2ac0ff512853564e/ring.erl" 1904 } 1905 }, 1906 "comments": 0, 1907 "comments_url": "https://api.github.com/gists/19d18b30e8af75090307/comments/", 1908 "html_url": "https://gist.github.com/1", 1909 "git_pull_url": "git://gist.github.com/1.git", 1910 "git_push_url": "git@gist.github.com:1.git", 1911 "created_at": "2010-04-14T02:15:15Z" 1912 } 1913 ] 1914 post: 1915 description: Create a gist. 1916 body: 1917 application/json: 1918 schema: | 1919 { 1920 "$schema": "http://json-schema.org/draft-03/schema", 1921 "type": "object", 1922 "properties": { 1923 "description": { 1924 "type": "string" 1925 }, 1926 "public": { 1927 "type": "boolean" 1928 }, 1929 "files": { 1930 "description": "Files that make up this gist. The key of which should be a required string filename and the value another required hash with parameter 'content'.", 1931 "type": "string" 1932 }, 1933 "content": { 1934 "description": "File contents.", 1935 "type": "string" 1936 } 1937 }, 1938 "required": [ "public", "files", "content" ] 1939 } 1940 responses: 1941 201: 1942 body: 1943 schema: | 1944 { 1945 "$schema": "http://json-schema.org/draft-03/schema", 1946 "type": "object", 1947 "properties": { 1948 "url": { 1949 "type": "string" 1950 }, 1951 "id": { 1952 "type": "string" 1953 }, 1954 "description": { 1955 "type": "string" 1956 }, 1957 "public": { 1958 "type": "boolean" 1959 }, 1960 "user": { 1961 "properties": { 1962 "login": { 1963 "type": "string" 1964 }, 1965 "id": { 1966 "type": "integer" 1967 }, 1968 "avatar_url": { 1969 "type": "string" 1970 }, 1971 "gravatar_id": { 1972 "type": "string" 1973 }, 1974 "url": { 1975 "type": "string" 1976 } 1977 }, 1978 "type": "object" 1979 }, 1980 "files": { 1981 "properties": { 1982 "ring.erl": { 1983 "properties": { 1984 "size": { 1985 "type": "integer" 1986 }, 1987 "filename": { 1988 "type": "string" 1989 }, 1990 "raw_url": { 1991 "type": "string" 1992 } 1993 }, 1994 "type": "object" 1995 } 1996 }, 1997 "type": "object" 1998 }, 1999 "comments": { 2000 "type": "integer" 2001 }, 2002 "comments_url": { 2003 "type": "string" 2004 }, 2005 "html_url": { 2006 "type": "string" 2007 }, 2008 "git_pull_url": { 2009 "type": "string" 2010 }, 2011 "git_push_url": { 2012 "type": "string" 2013 }, 2014 "created_at": { 2015 "description": "Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.", 2016 "type": "string" 2017 }, 2018 "forks": [ 2019 { 2020 "properties": { 2021 "user": { 2022 "properties": { 2023 "login": { 2024 "type": "string" 2025 }, 2026 "id": { 2027 "type": "integer" 2028 }, 2029 "avatar_url": { 2030 "type": "string" 2031 }, 2032 "gravatar_id": { 2033 "type": "string" 2034 }, 2035 "url": { 2036 "type": "string" 2037 } 2038 }, 2039 "type": "object" 2040 }, 2041 "url": { 2042 "type": "string" 2043 }, 2044 "created_at": { 2045 "description": "Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.", 2046 "type": "string" 2047 } 2048 }, 2049 "type": "object" 2050 } 2051 ], 2052 "type": "array", 2053 "history": [ 2054 { 2055 "properties": { 2056 "url": { 2057 "type": "string" 2058 }, 2059 "version": { 2060 "type": "string" 2061 }, 2062 "user": { 2063 "properties": { 2064 "login": { 2065 "type": "string" 2066 }, 2067 "id": { 2068 "type": "integer" 2069 }, 2070 "avatar_url": { 2071 "type": "string" 2072 }, 2073 "gravatar_id": { 2074 "type": "string" 2075 }, 2076 "url": { 2077 "type": "string" 2078 } 2079 }, 2080 "type": "object" 2081 }, 2082 "change_status": { 2083 "properties": { 2084 "deletions": { 2085 "type": "integer" 2086 }, 2087 "additions": { 2088 "type": "integer" 2089 }, 2090 "total": { 2091 "type": "integer" 2092 } 2093 }, 2094 "type": "object" 2095 }, 2096 "committed_at": { 2097 "description": "Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.", 2098 "type": "string" 2099 }, 2100 "type": "object" 2101 } 2102 } 2103 ] 2104 } 2105 } 2106 example: | 2107 { 2108 "url": "https://api.github.com/gists/20c98223d9b59e1d48e5", 2109 "id": "1", 2110 "description": "description of gist", 2111 "public": true, 2112 "user": { 2113 "login": "octocat", 2114 "id": 1, 2115 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 2116 "gravatar_id": "somehexcode", 2117 "url": "https://api.github.com/users/octocat" 2118 }, 2119 "files": { 2120 "ring.erl": { 2121 "size": 932, 2122 "filename": "ring.erl", 2123 "raw_url": "https://gist.github.com/raw/365370/8c4d2d43d178df44f4c03a7f2ac0ff512853564e/ring.erl" 2124 } 2125 }, 2126 "comments": 0, 2127 "comments_url": "https://api.github.com/gists/19d18b30e8af75090307/comments/", 2128 "html_url": "https://gist.github.com/1", 2129 "git_pull_url": "git://gist.github.com/1.git", 2130 "git_push_url": "git@gist.github.com:1.git", 2131 "created_at": "2010-04-14T02:15:15Z", 2132 "forks": [ 2133 { 2134 "user": { 2135 "login": "octocat", 2136 "id": 1, 2137 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 2138 "gravatar_id": "somehexcode", 2139 "url": "https://api.github.com/users/octocat" 2140 }, 2141 "url": "https://api.github.com/gists/d39d0d37fb24f12e2045", 2142 "created_at": "2011-04-14T16:00:49Z" 2143 } 2144 ], 2145 "history": [ 2146 { 2147 "url": "https://api.github.com/gists/3a8bdc16d2e39d809469", 2148 "version": "57a7f021a713b1c5a6a199b54cc514735d2d462f", 2149 "user": { 2150 "login": "octocat", 2151 "id": 1, 2152 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 2153 "gravatar_id": "somehexcode", 2154 "url": "https://api.github.com/users/octocat" 2155 }, 2156 "change_status": { 2157 "deletions": 0, 2158 "additions": 180, 2159 "total": 180 2160 }, 2161 "committed_at": "2010-04-14T02:15:15Z" 2162 } 2163 ] 2164 } 2165 # Public 2166 /public: 2167 securedBy: [ null, oauth_2_0 ] 2168 type: collection 2169 get: 2170 is: [ historical ] 2171 description: List all public gists. 2172 responses: 2173 200: 2174 body: 2175 schema: | 2176 { 2177 "$schema": "http://json-schema.org/draft-03/schema", 2178 "type": "array", 2179 "gists": [ 2180 { 2181 "type": "object", 2182 "properties": { 2183 "url": { 2184 "type": "string" 2185 }, 2186 "id": { 2187 "type": "string" 2188 }, 2189 "description": { 2190 "type": "string" 2191 }, 2192 "public": { 2193 "type": "boolean" 2194 }, 2195 "user": { 2196 "properties": { 2197 "login": { 2198 "type": "string" 2199 }, 2200 "id": { 2201 "type": "integer" 2202 }, 2203 "avatar_url": { 2204 "type": "string" 2205 }, 2206 "gravatar_id": { 2207 "type": "string" 2208 }, 2209 "url": { 2210 "type": "string" 2211 } 2212 }, 2213 "type": "object" 2214 }, 2215 "files": { 2216 "properties": { 2217 "ring.erl": { 2218 "properties": { 2219 "size": { 2220 "type": "integer" 2221 }, 2222 "filename": { 2223 "type": "string" 2224 }, 2225 "raw_url": { 2226 "type": "string" 2227 } 2228 }, 2229 "type": "object" 2230 } 2231 }, 2232 "type": "object" 2233 }, 2234 "comments": { 2235 "type": "integer" 2236 }, 2237 "comments_url": { 2238 "type": "string" 2239 }, 2240 "html_url": { 2241 "type": "string" 2242 }, 2243 "git_pull_url": { 2244 "type": "string" 2245 }, 2246 "git_push_url": { 2247 "type": "string" 2248 }, 2249 "created_at": { 2250 "type": "string" 2251 } 2252 } 2253 } 2254 ] 2255 } 2256 example: | 2257 [ 2258 { 2259 "url": "https://api.github.com/gists/20c98223d9b59e1d48e5", 2260 "id": "1", 2261 "description": "description of gist", 2262 "public": true, 2263 "user": { 2264 "login": "octocat", 2265 "id": 1, 2266 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 2267 "gravatar_id": "somehexcode", 2268 "url": "https://api.github.com/users/octocat" 2269 }, 2270 "files": { 2271 "ring.erl": { 2272 "size": 932, 2273 "filename": "ring.erl", 2274 "raw_url": "https://gist.github.com/raw/365370/8c4d2d43d178df44f4c03a7f2ac0ff512853564e/ring.erl" 2275 } 2276 }, 2277 "comments": 0, 2278 "comments_url": "https://api.github.com/gists/19d18b30e8af75090307/comments/", 2279 "html_url": "https://gist.github.com/1", 2280 "git_pull_url": "git://gist.github.com/1.git", 2281 "git_push_url": "git@gist.github.com:1.git", 2282 "created_at": "2010-04-14T02:15:15Z" 2283 } 2284 ] 2285 # Starred 2286 /starred: 2287 securedBy: [ null, oauth_2_0 ] 2288 type: collection 2289 get: 2290 is: [ historical ] 2291 description: List the authenticated user's starred gists. 2292 responses: 2293 200: 2294 body: 2295 schema: | 2296 { 2297 "$schema": "http://json-schema.org/draft-03/schema", 2298 "type": "array", 2299 "gists": [ 2300 { 2301 "type": "object", 2302 "properties": { 2303 "url": { 2304 "type": "string" 2305 }, 2306 "id": { 2307 "type": "string" 2308 }, 2309 "description": { 2310 "type": "string" 2311 }, 2312 "public": { 2313 "type": "boolean" 2314 }, 2315 "user": { 2316 "properties": { 2317 "login": { 2318 "type": "string" 2319 }, 2320 "id": { 2321 "type": "integer" 2322 }, 2323 "avatar_url": { 2324 "type": "string" 2325 }, 2326 "gravatar_id": { 2327 "type": "string" 2328 }, 2329 "url": { 2330 "type": "string" 2331 } 2332 }, 2333 "type": "object" 2334 }, 2335 "files": { 2336 "properties": { 2337 "ring.erl": { 2338 "properties": { 2339 "size": { 2340 "type": "integer" 2341 }, 2342 "filename": { 2343 "type": "string" 2344 }, 2345 "raw_url": { 2346 "type": "string" 2347 } 2348 }, 2349 "type": "object" 2350 } 2351 }, 2352 "type": "object" 2353 }, 2354 "comments": { 2355 "type": "integer" 2356 }, 2357 "comments_url": { 2358 "type": "string" 2359 }, 2360 "html_url": { 2361 "type": "string" 2362 }, 2363 "git_pull_url": { 2364 "type": "string" 2365 }, 2366 "git_push_url": { 2367 "type": "string" 2368 }, 2369 "created_at": { 2370 "type": "string" 2371 } 2372 } 2373 } 2374 ] 2375 } 2376 example: | 2377 [ 2378 { 2379 "url": "https://api.github.com/gists/20c98223d9b59e1d48e5", 2380 "id": "1", 2381 "description": "description of gist", 2382 "public": true, 2383 "user": { 2384 "login": "octocat", 2385 "id": 1, 2386 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 2387 "gravatar_id": "somehexcode", 2388 "url": "https://api.github.com/users/octocat" 2389 }, 2390 "files": { 2391 "ring.erl": { 2392 "size": 932, 2393 "filename": "ring.erl", 2394 "raw_url": "https://gist.github.com/raw/365370/8c4d2d43d178df44f4c03a7f2ac0ff512853564e/ring.erl" 2395 } 2396 }, 2397 "comments": 0, 2398 "comments_url": "https://api.github.com/gists/19d18b30e8af75090307/comments/", 2399 "html_url": "https://gist.github.com/1", 2400 "git_pull_url": "git://gist.github.com/1.git", 2401 "git_push_url": "git@gist.github.com:1.git", 2402 "created_at": "2010-04-14T02:15:15Z" 2403 } 2404 ] 2405 # ID 2406 /{id}: 2407 uriParameters: 2408 id: 2409 description: Id of a thread. 2410 type: integer 2411 type: item 2412 get: 2413 description: Get a single gist. 2414 responses: 2415 200: 2416 body: 2417 schema: | 2418 { 2419 "$schema": "http://json-schema.org/draft-03/schema", 2420 "type": "object", 2421 "properties": { 2422 "url": { 2423 "type": "string" 2424 }, 2425 "id": { 2426 "type": "string" 2427 }, 2428 "description": { 2429 "type": "string" 2430 }, 2431 "public": { 2432 "type": "boolean" 2433 }, 2434 "user": { 2435 "properties": { 2436 "login": { 2437 "type": "string" 2438 }, 2439 "id": { 2440 "type": "integer" 2441 }, 2442 "avatar_url": { 2443 "type": "string" 2444 }, 2445 "gravatar_id": { 2446 "type": "string" 2447 }, 2448 "url": { 2449 "type": "string" 2450 } 2451 }, 2452 "type": "object" 2453 }, 2454 "files": { 2455 "properties": { 2456 "ring.erl": { 2457 "properties": { 2458 "size": { 2459 "type": "integer" 2460 }, 2461 "filename": { 2462 "type": "string" 2463 }, 2464 "raw_url": { 2465 "type": "string" 2466 } 2467 }, 2468 "type": "object" 2469 } 2470 }, 2471 "type": "object" 2472 }, 2473 "comments": { 2474 "type": "integer" 2475 }, 2476 "comments_url": { 2477 "type": "string" 2478 }, 2479 "html_url": { 2480 "type": "string" 2481 }, 2482 "git_pull_url": { 2483 "type": "string" 2484 }, 2485 "git_push_url": { 2486 "type": "string" 2487 }, 2488 "created_at": { 2489 "description": "Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.", 2490 "type": "string" 2491 }, 2492 "forks": [ 2493 { 2494 "properties": { 2495 "user": { 2496 "properties": { 2497 "login": { 2498 "type": "string" 2499 }, 2500 "id": { 2501 "type": "integer" 2502 }, 2503 "avatar_url": { 2504 "type": "string" 2505 }, 2506 "gravatar_id": { 2507 "type": "string" 2508 }, 2509 "url": { 2510 "type": "string" 2511 } 2512 }, 2513 "type": "object" 2514 }, 2515 "url": { 2516 "type": "string" 2517 }, 2518 "created_at": { 2519 "description": "Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.", 2520 "type": "string" 2521 } 2522 }, 2523 "type": "object" 2524 } 2525 ], 2526 "type": "array", 2527 "history": [ 2528 { 2529 "properties": { 2530 "url": { 2531 "type": "string" 2532 }, 2533 "version": { 2534 "type": "string" 2535 }, 2536 "user": { 2537 "properties": { 2538 "login": { 2539 "type": "string" 2540 }, 2541 "id": { 2542 "type": "integer" 2543 }, 2544 "avatar_url": { 2545 "type": "string" 2546 }, 2547 "gravatar_id": { 2548 "type": "string" 2549 }, 2550 "url": { 2551 "type": "string" 2552 } 2553 }, 2554 "type": "object" 2555 }, 2556 "change_status": { 2557 "properties": { 2558 "deletions": { 2559 "type": "integer" 2560 }, 2561 "additions": { 2562 "type": "integer" 2563 }, 2564 "total": { 2565 "type": "integer" 2566 } 2567 }, 2568 "type": "object" 2569 }, 2570 "committed_at": { 2571 "description": "Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.", 2572 "type": "string" 2573 }, 2574 "type": "object" 2575 } 2576 } 2577 ] 2578 } 2579 } 2580 example: | 2581 { 2582 "url": "https://api.github.com/gists/20c98223d9b59e1d48e5", 2583 "id": "1", 2584 "description": "description of gist", 2585 "public": true, 2586 "user": { 2587 "login": "octocat", 2588 "id": 1, 2589 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 2590 "gravatar_id": "somehexcode", 2591 "url": "https://api.github.com/users/octocat" 2592 }, 2593 "files": { 2594 "ring.erl": { 2595 "size": 932, 2596 "filename": "ring.erl", 2597 "raw_url": "https://gist.github.com/raw/365370/8c4d2d43d178df44f4c03a7f2ac0ff512853564e/ring.erl" 2598 } 2599 }, 2600 "comments": 0, 2601 "comments_url": "https://api.github.com/gists/19d18b30e8af75090307/comments/", 2602 "html_url": "https://gist.github.com/1", 2603 "git_pull_url": "git://gist.github.com/1.git", 2604 "git_push_url": "git@gist.github.com:1.git", 2605 "created_at": "2010-04-14T02:15:15Z", 2606 "forks": [ 2607 { 2608 "user": { 2609 "login": "octocat", 2610 "id": 1, 2611 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 2612 "gravatar_id": "somehexcode", 2613 "url": "https://api.github.com/users/octocat" 2614 }, 2615 "url": "https://api.github.com/gists/d39d0d37fb24f12e2045", 2616 "created_at": "2011-04-14T16:00:49Z" 2617 } 2618 ], 2619 "history": [ 2620 { 2621 "url": "https://api.github.com/gists/3a8bdc16d2e39d809469", 2622 "version": "57a7f021a713b1c5a6a199b54cc514735d2d462f", 2623 "user": { 2624 "login": "octocat", 2625 "id": 1, 2626 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 2627 "gravatar_id": "somehexcode", 2628 "url": "https://api.github.com/users/octocat" 2629 }, 2630 "change_status": { 2631 "deletions": 0, 2632 "additions": 180, 2633 "total": 180 2634 }, 2635 "committed_at": "2010-04-14T02:15:15Z" 2636 } 2637 ] 2638 } 2639 patch: 2640 description: Edit a gist. 2641 body: 2642 application/json: 2643 schema: | 2644 { 2645 "$schema": "http://json-schema.org/draft-03/schema", 2646 "type": "object", 2647 "properties": { 2648 "description": { 2649 "type": "string" 2650 }, 2651 "files": { 2652 "properties": { 2653 "file1.txt": { 2654 "properties": { 2655 "content": { 2656 "type": "string" 2657 } 2658 }, 2659 "type": "object" 2660 }, 2661 "old_name.txt": { 2662 "properties": { 2663 "filename": { 2664 "type": "string" 2665 }, 2666 "content": { 2667 "type": "string" 2668 } 2669 }, 2670 "type": "object" 2671 }, 2672 "new_file.txt": { 2673 "properties": { 2674 "content": { 2675 "type": "string" 2676 } 2677 }, 2678 "type": "object" 2679 }, 2680 "delete_this_file.txt": { 2681 "type": "string" 2682 } 2683 } 2684 } 2685 } 2686 } 2687 responses: 2688 200: 2689 body: 2690 schema: | 2691 { 2692 "$schema": "http://json-schema.org/draft-03/schema", 2693 "type": "object", 2694 "properties": { 2695 "url": { 2696 "type": "string" 2697 }, 2698 "id": { 2699 "type": "string" 2700 }, 2701 "description": { 2702 "type": "string" 2703 }, 2704 "public": { 2705 "type": "boolean" 2706 }, 2707 "user": { 2708 "properties": { 2709 "login": { 2710 "type": "string" 2711 }, 2712 "id": { 2713 "type": "integer" 2714 }, 2715 "avatar_url": { 2716 "type": "string" 2717 }, 2718 "gravatar_id": { 2719 "type": "string" 2720 }, 2721 "url": { 2722 "type": "string" 2723 } 2724 }, 2725 "type": "object" 2726 }, 2727 "files": { 2728 "properties": { 2729 "ring.erl": { 2730 "properties": { 2731 "size": { 2732 "type": "integer" 2733 }, 2734 "filename": { 2735 "type": "string" 2736 }, 2737 "raw_url": { 2738 "type": "string" 2739 } 2740 }, 2741 "type": "object" 2742 } 2743 }, 2744 "type": "object" 2745 }, 2746 "comments": { 2747 "type": "integer" 2748 }, 2749 "comments_url": { 2750 "type": "string" 2751 }, 2752 "html_url": { 2753 "type": "string" 2754 }, 2755 "git_pull_url": { 2756 "type": "string" 2757 }, 2758 "git_push_url": { 2759 "type": "string" 2760 }, 2761 "created_at": { 2762 "description": "Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.", 2763 "type": "string" 2764 }, 2765 "forks": [ 2766 { 2767 "properties": { 2768 "user": { 2769 "properties": { 2770 "login": { 2771 "type": "string" 2772 }, 2773 "id": { 2774 "type": "integer" 2775 }, 2776 "avatar_url": { 2777 "type": "string" 2778 }, 2779 "gravatar_id": { 2780 "type": "string" 2781 }, 2782 "url": { 2783 "type": "string" 2784 } 2785 }, 2786 "type": "object" 2787 }, 2788 "url": { 2789 "type": "string" 2790 }, 2791 "created_at": { 2792 "description": "Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.", 2793 "type": "string" 2794 } 2795 }, 2796 "type": "object" 2797 } 2798 ], 2799 "type": "array", 2800 "history": [ 2801 { 2802 "properties": { 2803 "url": { 2804 "type": "string" 2805 }, 2806 "version": { 2807 "type": "string" 2808 }, 2809 "user": { 2810 "properties": { 2811 "login": { 2812 "type": "string" 2813 }, 2814 "id": { 2815 "type": "integer" 2816 }, 2817 "avatar_url": { 2818 "type": "string" 2819 }, 2820 "gravatar_id": { 2821 "type": "string" 2822 }, 2823 "url": { 2824 "type": "string" 2825 } 2826 }, 2827 "type": "object" 2828 }, 2829 "change_status": { 2830 "properties": { 2831 "deletions": { 2832 "type": "integer" 2833 }, 2834 "additions": { 2835 "type": "integer" 2836 }, 2837 "total": { 2838 "type": "integer" 2839 } 2840 }, 2841 "type": "object" 2842 }, 2843 "committed_at": { 2844 "description": "Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.", 2845 "type": "string" 2846 }, 2847 "type": "object" 2848 } 2849 } 2850 ] 2851 } 2852 } 2853 example: | 2854 { 2855 "url": "https://api.github.com/gists/20c98223d9b59e1d48e5", 2856 "id": "1", 2857 "description": "description of gist", 2858 "public": true, 2859 "user": { 2860 "login": "octocat", 2861 "id": 1, 2862 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 2863 "gravatar_id": "somehexcode", 2864 "url": "https://api.github.com/users/octocat" 2865 }, 2866 "files": { 2867 "ring.erl": { 2868 "size": 932, 2869 "filename": "ring.erl", 2870 "raw_url": "https://gist.github.com/raw/365370/8c4d2d43d178df44f4c03a7f2ac0ff512853564e/ring.erl" 2871 } 2872 }, 2873 "comments": 0, 2874 "comments_url": "https://api.github.com/gists/19d18b30e8af75090307/comments/", 2875 "html_url": "https://gist.github.com/1", 2876 "git_pull_url": "git://gist.github.com/1.git", 2877 "git_push_url": "git@gist.github.com:1.git", 2878 "created_at": "2010-04-14T02:15:15Z", 2879 "forks": [ 2880 { 2881 "user": { 2882 "login": "octocat", 2883 "id": 1, 2884 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 2885 "gravatar_id": "somehexcode", 2886 "url": "https://api.github.com/users/octocat" 2887 }, 2888 "url": "https://api.github.com/gists/d39d0d37fb24f12e2045", 2889 "created_at": "2011-04-14T16:00:49Z" 2890 } 2891 ], 2892 "history": [ 2893 { 2894 "url": "https://api.github.com/gists/3a8bdc16d2e39d809469", 2895 "version": "57a7f021a713b1c5a6a199b54cc514735d2d462f", 2896 "user": { 2897 "login": "octocat", 2898 "id": 1, 2899 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 2900 "gravatar_id": "somehexcode", 2901 "url": "https://api.github.com/users/octocat" 2902 }, 2903 "change_status": { 2904 "deletions": 0, 2905 "additions": 180, 2906 "total": 180 2907 }, 2908 "committed_at": "2010-04-14T02:15:15Z" 2909 } 2910 ] 2911 } 2912 delete: 2913 description: Delete a gist. 2914 # Star 2915 /star: 2916 type: base 2917 put: 2918 description: Star a gist. 2919 responses: 2920 204: 2921 description: Starred. 2922 delete: 2923 description: Unstar a gist. 2924 responses: 2925 204: 2926 description: Item removed. 2927 get: 2928 description: Check if a gist is starred. 2929 responses: 2930 204: 2931 description: Exists. 2932 404: 2933 description: Not exists. 2934 # Forks 2935 /forks: 2936 type: base 2937 post: 2938 description: Fork a gist. 2939 responses: 2940 204: 2941 description: Exists. 2942 404: 2943 description: Not exists. 2944 /comments: 2945 type: collection 2946 get: 2947 description: List comments on a gist. 2948 responses: 2949 200: 2950 body: 2951 schema: | 2952 { 2953 "$schema": "http://json-schema.org/draft-03/schema", 2954 "type": "array", 2955 "comments": [ 2956 { 2957 "properties": { 2958 "id": { 2959 "type": "integer" 2960 }, 2961 "url": { 2962 "type": "string" 2963 }, 2964 "body": { 2965 "type": "string" 2966 }, 2967 "user": { 2968 "properties": { 2969 "login": { 2970 "type": "string" 2971 }, 2972 "id": { 2973 "type": "integer" 2974 }, 2975 "avatar_url": { 2976 "type": "string" 2977 }, 2978 "gravatar_id": { 2979 "type": "string" 2980 }, 2981 "url": { 2982 "type": "string" 2983 } 2984 }, 2985 "type": "object" 2986 }, 2987 "created_at": { 2988 "description": "ISO 8601.", 2989 "type": "string" 2990 } 2991 }, 2992 "type": "object" 2993 } 2994 ] 2995 } 2996 example: | 2997 [ 2998 { 2999 "id": 1, 3000 "url": "https://api.github.com/gists/ae709e9cf889e485e65f/comments/1", 3001 "body": "Just commenting for the sake of commenting", 3002 "user": { 3003 "login": "octocat", 3004 "id": 1, 3005 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 3006 "gravatar_id": "somehexcode", 3007 "url": "https://api.github.com/users/octocat" 3008 }, 3009 "created_at": "2011-04-18T23:23:56Z" 3010 } 3011 ] 3012 post: 3013 description: Create a comment 3014 body: 3015 application/json: 3016 schema: | 3017 { 3018 "$schema": "http://json-schema.org/draft-03/schema", 3019 "type": "object", 3020 "properties": { 3021 "body": { 3022 "type": "string" 3023 } 3024 }, 3025 "required": [ "body" ] 3026 } 3027 responses: 3028 201: 3029 body: 3030 schema: | 3031 { 3032 "$schema": "http://json-schema.org/draft-03/schema", 3033 "type": "object", 3034 "properties": { 3035 "id": { 3036 "type": "integer" 3037 }, 3038 "url": { 3039 "type": "string" 3040 }, 3041 "body": { 3042 "type": "string" 3043 }, 3044 "user": { 3045 "properties": { 3046 "login": { 3047 "type": "string" 3048 }, 3049 "id": { 3050 "type": "integer" 3051 }, 3052 "avatar_url": { 3053 "type": "string" 3054 }, 3055 "gravatar_id": { 3056 "type": "string" 3057 }, 3058 "url": { 3059 "type": "string" 3060 } 3061 }, 3062 "type": "object" 3063 }, 3064 "created_at": { 3065 "description": "ISO 8601.", 3066 "type": "string" 3067 } 3068 } 3069 } 3070 example: | 3071 { 3072 "id": 1, 3073 "url": "https://api.github.com/gists/83ba86d111d39709da8c/comments/1", 3074 "body": "Just commenting for the sake of commenting", 3075 "user": { 3076 "login": "octocat", 3077 "id": 1, 3078 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 3079 "gravatar_id": "somehexcode", 3080 "url": "https://api.github.com/users/octocat" 3081 }, 3082 "created_at": "2011-04-18T23:23:56Z" 3083 } 3084 /{commentId}: 3085 type: item 3086 uriParameters: 3087 commentId: 3088 description: Id of the comment. 3089 type: integer 3090 get: 3091 description: Get a single comment. 3092 responses: 3093 200: 3094 body: 3095 schema: | 3096 { 3097 "$schema": "http://json-schema.org/draft-03/schema", 3098 "type": "object", 3099 "properties": { 3100 "id": { 3101 "type": "integer" 3102 }, 3103 "url": { 3104 "type": "string" 3105 }, 3106 "body": { 3107 "type": "string" 3108 }, 3109 "user": { 3110 "properties": { 3111 "login": { 3112 "type": "string" 3113 }, 3114 "id": { 3115 "type": "integer" 3116 }, 3117 "avatar_url": { 3118 "type": "string" 3119 }, 3120 "gravatar_id": { 3121 "type": "string" 3122 }, 3123 "url": { 3124 "type": "string" 3125 } 3126 }, 3127 "type": "object" 3128 }, 3129 "created_at": { 3130 "description": "ISO 8601.", 3131 "type": "string" 3132 } 3133 } 3134 } 3135 example: | 3136 { 3137 "id": 1, 3138 "url": "https://api.github.com/gists/83ba86d111d39709da8c/comments/1", 3139 "body": "Just commenting for the sake of commenting", 3140 "user": { 3141 "login": "octocat", 3142 "id": 1, 3143 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 3144 "gravatar_id": "somehexcode", 3145 "url": "https://api.github.com/users/octocat" 3146 }, 3147 "created_at": "2011-04-18T23:23:56Z" 3148 } 3149 patch: 3150 description: Edit a comment. 3151 body: 3152 application/json: 3153 schema: | 3154 { 3155 "$schema": "http://json-schema.org/draft-03/schema", 3156 "type": "object", 3157 "properties": { 3158 "id": { 3159 "type": "integer" 3160 }, 3161 "url": { 3162 "type": "string" 3163 }, 3164 "body": { 3165 "type": "string" 3166 }, 3167 "user": { 3168 "properties": { 3169 "login": { 3170 "type": "string" 3171 }, 3172 "id": { 3173 "type": "integer" 3174 }, 3175 "avatar_url": { 3176 "type": "string" 3177 }, 3178 "gravatar_id": { 3179 "type": "string" 3180 }, 3181 "url": { 3182 "type": "string" 3183 } 3184 }, 3185 "type": "object" 3186 }, 3187 "created_at": { 3188 "description": "ISO 8601.", 3189 "type": "string" 3190 } 3191 } 3192 } 3193 responses: 3194 200: 3195 body: 3196 schema: | 3197 { 3198 "$schema": "http://json-schema.org/draft-03/schema", 3199 "type": "object", 3200 "properties": { 3201 "id": { 3202 "type": "integer" 3203 }, 3204 "url": { 3205 "type": "string" 3206 }, 3207 "body": { 3208 "type": "string" 3209 }, 3210 "user": { 3211 "properties": { 3212 "login": { 3213 "type": "string" 3214 }, 3215 "id": { 3216 "type": "integer" 3217 }, 3218 "avatar_url": { 3219 "type": "string" 3220 }, 3221 "gravatar_id": { 3222 "type": "string" 3223 }, 3224 "url": { 3225 "type": "string" 3226 } 3227 }, 3228 "type": "object" 3229 }, 3230 "created_at": { 3231 "description": "ISO 8601.", 3232 "type": "string" 3233 } 3234 } 3235 } 3236 example: | 3237 { 3238 "id": 1, 3239 "url": "https://api.github.com/gists/83ba86d111d39709da8c/comments/1", 3240 "body": "Just commenting for the sake of commenting", 3241 "user": { 3242 "login": "octocat", 3243 "id": 1, 3244 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 3245 "gravatar_id": "somehexcode", 3246 "url": "https://api.github.com/users/octocat" 3247 }, 3248 "created_at": "2011-04-18T23:23:56Z" 3249 } 3250 delete: 3251 description: Delete a comment. 3252/orgs/{orgId}: 3253 uriParameters: 3254 orgId: 3255 description: Id of organisation. 3256 type: integer 3257 type: item 3258 get: 3259 description: Get an Organization. 3260 responses: 3261 200: 3262 body: 3263 schema: | 3264 { 3265 "$schema": "http://json-schema.org/draft-03/schema", 3266 "type": "object", 3267 "properties": { 3268 "login": { 3269 "type": "string" 3270 }, 3271 "id": { 3272 "type": "integer" 3273 }, 3274 "url": { 3275 "type": "string" 3276 }, 3277 "avatar_url": { 3278 "type": "string" 3279 }, 3280 "name": { 3281 "type": "string" 3282 }, 3283 "company": { 3284 "type": "string" 3285 }, 3286 "blog": { 3287 "type": "string" 3288 }, 3289 "location": { 3290 "type": "string" 3291 }, 3292 "email": { 3293 "type": "string" 3294 }, 3295 "public_repos": { 3296 "type": "integer" 3297 }, 3298 "public_gists": { 3299 "type": "integer" 3300 }, 3301 "followers": { 3302 "type": "integer" 3303 }, 3304 "following": { 3305 "type": "integer" 3306 }, 3307 "html_url": { 3308 "type": "string" 3309 }, 3310 "created_at": { 3311 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 3312 "type": "string" 3313 }, 3314 "type": { 3315 "type": "string" 3316 } 3317 } 3318 } 3319 example: | 3320 { 3321 "login": "github", 3322 "id": 1, 3323 "url": "https://api.github.com/orgs/github", 3324 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 3325 "name": "github", 3326 "company": "GitHub", 3327 "blog": "https://github.com/blog", 3328 "location": "San Francisco", 3329 "email": "octocat@github.com", 3330 "public_repos": 2, 3331 "public_gists": 1, 3332 "followers": 20, 3333 "following": 0, 3334 "html_url": "https://github.com/octocat", 3335 "created_at": "2008-01-14T04:33:35Z", 3336 "type": "Organization" 3337 } 3338 patch: 3339 body: 3340 application/json: 3341 schema: | 3342 { 3343 "$schema": "http://json-schema.org/draft-03/schema", 3344 "type": "object", 3345 "properties": { 3346 "billing_email": { 3347 "description": "Billing email address. This address is not publicized.", 3348 "type": "string" 3349 }, 3350 "company": { 3351 "type": "string" 3352 }, 3353 "email": { 3354 "description": "Publicly visible email address.", 3355 "type": "string" 3356 }, 3357 "location": { 3358 "type": "string" 3359 }, 3360 "name": { 3361 "type": "string" 3362 } 3363 } 3364 } 3365 responses: 3366 200: 3367 body: 3368 schema: | 3369 { 3370 "$schema": "http://json-schema.org/draft-03/schema", 3371 "type": "object", 3372 "properties": { 3373 "login": { 3374 "type": "string" 3375 }, 3376 "id": { 3377 "type": "integer" 3378 }, 3379 "url": { 3380 "type": "string" 3381 }, 3382 "avatar_url": { 3383 "type": "string" 3384 }, 3385 "name": { 3386 "type": "string" 3387 }, 3388 "company": { 3389 "type": "string" 3390 }, 3391 "blog": { 3392 "type": "string" 3393 }, 3394 "location": { 3395 "type": "string" 3396 }, 3397 "email": { 3398 "type": "string" 3399 }, 3400 "public_repos": { 3401 "type": "integer" 3402 }, 3403 "public_gists": { 3404 "type": "integer" 3405 }, 3406 "followers": { 3407 "type": "integer" 3408 }, 3409 "following": { 3410 "type": "integer" 3411 }, 3412 "html_url": { 3413 "type": "string" 3414 }, 3415 "created_at": { 3416 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 3417 "type": "string" 3418 }, 3419 "type": { 3420 "type": "string" 3421 } 3422 } 3423 } 3424 example: | 3425 { 3426 "login": "github", 3427 "id": 1, 3428 "url": "https://api.github.com/orgs/github", 3429 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 3430 "name": "github", 3431 "company": "GitHub", 3432 "blog": "https://github.com/blog", 3433 "location": "San Francisco", 3434 "email": "octocat@github.com", 3435 "public_repos": 2, 3436 "public_gists": 1, 3437 "followers": 20, 3438 "following": 0, 3439 "html_url": "https://github.com/octocat", 3440 "created_at": "2008-01-14T04:33:35Z", 3441 "type": "Organization" 3442 } 3443 description: Edit an Organization. 3444 # Events 3445 /events: 3446 type: collection 3447 get: 3448 description: List public events for an organization. 3449 responses: 3450 200: 3451 body: 3452 schema: | 3453 { 3454 "$schema": "http://json-schema.org/draft-03/schema", 3455 "type": "array", 3456 "properties": [ 3457 { 3458 "properties": { 3459 "type": { 3460 "type": "string" 3461 }, 3462 "public": { 3463 "type": "boolean" 3464 }, 3465 "payload": { 3466 "properties": {}, 3467 "type": "object" 3468 }, 3469 "repo": { 3470 "properties": { 3471 "id": { 3472 "type": "integer" 3473 }, 3474 "name": { 3475 "type": "string" 3476 }, 3477 "url": { 3478 "type": "string" 3479 } 3480 }, 3481 "type": "object" 3482 }, 3483 "actor": { 3484 "properties": { 3485 "login": { 3486 "type": "string" 3487 }, 3488 "id": { 3489 "type": "integer" 3490 }, 3491 "avatar_url": { 3492 "type": "string" 3493 }, 3494 "gravatar_id": { 3495 "type": "string" 3496 }, 3497 "url": { 3498 "type": "string" 3499 } 3500 }, 3501 "type": "object" 3502 }, 3503 "org": { 3504 "properties": { 3505 "login": { 3506 "type": "string" 3507 }, 3508 "id": { 3509 "type": "integer" 3510 }, 3511 "avatar_url": { 3512 "type": "string" 3513 }, 3514 "gravatar_id": { 3515 "type": "string" 3516 }, 3517 "url": { 3518 "type": "string" 3519 } 3520 }, 3521 "type": "object" 3522 }, 3523 "created_at": { 3524 "type": "timestamp" 3525 }, 3526 "id": { 3527 "type": "integer" 3528 } 3529 }, 3530 "type": "object" 3531 } 3532 ] 3533 } 3534 example: | 3535 [ 3536 { 3537 "type": "Event", 3538 "public": true, 3539 "payload": { 3540 3541 }, 3542 "repo": { 3543 "id": 3, 3544 "name": "octocat/Hello-World", 3545 "url": "https://api.github.com/repos/octocat/Hello-World" 3546 }, 3547 "actor": { 3548 "login": "octocat", 3549 "id": 1, 3550 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 3551 "gravatar_id": "somehexcode", 3552 "url": "https://api.github.com/users/octocat" 3553 }, 3554 "org": { 3555 "login": "octocat", 3556 "id": 1, 3557 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 3558 "gravatar_id": "somehexcode", 3559 "url": "https://api.github.com/users/octocat" 3560 }, 3561 "created_at": "2011-09-06T17:26:27Z", 3562 "id": "12345" 3563 } 3564 ] 3565 # Issues 3566 /issues: 3567 type: collection 3568 get: 3569 is: [ filterable ] 3570 description: | 3571 List issues. 3572 List all issues for a given organization for the authenticated user. 3573 responses: 3574 200: 3575 body: 3576 schema: | 3577 { 3578 "$schema": "http://json-schema.org/draft-03/schema", 3579 "type": "array", 3580 "issues": [ 3581 { 3582 "properties": { 3583 "url": { 3584 "type": "string" 3585 }, 3586 "html_url": { 3587 "type": "string" 3588 }, 3589 "number": { 3590 "type": "integer" 3591 }, 3592 "state": { 3593 "enum": [ 3594 "open", 3595 "closed" 3596 ] 3597 }, 3598 "title": { 3599 "type": "string" 3600 }, 3601 "body": { 3602 "type": "string" 3603 }, 3604 "user": { 3605 "properties": { 3606 "login": { 3607 "type": "string" 3608 }, 3609 "id": { 3610 "type": "integer" 3611 }, 3612 "avatar_url": { 3613 "type": "string" 3614 }, 3615 "gravatar_id": { 3616 "type": "string" 3617 }, 3618 "url": { 3619 "type": "string" 3620 } 3621 }, 3622 "type": "object" 3623 }, 3624 "labels": [ 3625 { 3626 "properties": { 3627 "url": { 3628 "type": "string" 3629 }, 3630 "name": { 3631 "type": "string" 3632 }, 3633 "color": { 3634 "type": "string" 3635 } 3636 }, 3637 "type": "object" 3638 } 3639 ], 3640 "type": "array", 3641 "assignee": { 3642 "properties": { 3643 "login": { 3644 "type": "string" 3645 }, 3646 "id": { 3647 "type": "integer" 3648 }, 3649 "avatar_url": { 3650 "type": "string" 3651 }, 3652 "gravatar_id": { 3653 "type": "string" 3654 }, 3655 "url": { 3656 "type": "string" 3657 } 3658 }, 3659 "type": "object" 3660 }, 3661 "milestone": { 3662 "properties": { 3663 "url": { 3664 "type": "string" 3665 }, 3666 "number": { 3667 "type": "integer" 3668 }, 3669 "state": { 3670 "enum": [ 3671 "open", 3672 "closed" 3673 ] 3674 }, 3675 "title": { 3676 "type": "string" 3677 }, 3678 "description": { 3679 "type": "string" 3680 }, 3681 "creator": { 3682 "properties": { 3683 "login": { 3684 "type": "string" 3685 }, 3686 "id": { 3687 "type": "integer" 3688 }, 3689 "avatar_url": { 3690 "type": "string" 3691 }, 3692 "gravatar_id": { 3693 "type": "string" 3694 }, 3695 "url": { 3696 "type": "string" 3697 } 3698 }, 3699 "type": "object" 3700 }, 3701 "open_issues": { 3702 "type": "integer" 3703 }, 3704 "closed_issues": { 3705 "type": "integer" 3706 }, 3707 "created_at": { 3708 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 3709 "type": "string" 3710 }, 3711 "due_on": { 3712 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 3713 "type": "string" 3714 } 3715 }, 3716 "type": "object" 3717 }, 3718 "comments": { 3719 "type": "integer" 3720 }, 3721 "pull_request": { 3722 "properties": { 3723 "html_url": { 3724 "type": "string" 3725 }, 3726 "diff_url": { 3727 "type": "string" 3728 }, 3729 "patch_url": { 3730 "type": "string" 3731 } 3732 }, 3733 "type": "object" 3734 }, 3735 "closed_at": { 3736 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 3737 "type": "string" 3738 }, 3739 "created_at": { 3740 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 3741 "type": "string" 3742 }, 3743 "updated_at": { 3744 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 3745 "type": "string" 3746 } 3747 }, 3748 "type": "object" 3749 } 3750 ] 3751 } 3752 example: | 3753 [ 3754 { 3755 "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", 3756 "html_url": "https://github.com/octocat/Hello-World/issues/1347", 3757 "number": 1347, 3758 "state": "open", 3759 "title": "Found a bug", 3760 "body": "I'm having a problem with this.", 3761 "user": { 3762 "login": "octocat", 3763 "id": 1, 3764 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 3765 "gravatar_id": "somehexcode", 3766 "url": "https://api.github.com/users/octocat" 3767 }, 3768 "labels": [ 3769 { 3770 "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", 3771 "name": "bug", 3772 "color": "f29513" 3773 } 3774 ], 3775 "assignee": { 3776 "login": "octocat", 3777 "id": 1, 3778 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 3779 "gravatar_id": "somehexcode", 3780 "url": "https://api.github.com/users/octocat" 3781 }, 3782 "milestone": { 3783 "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", 3784 "number": 1, 3785 "state": "open", 3786 "title": "v1.0", 3787 "description": "", 3788 "creator": { 3789 "login": "octocat", 3790 "id": 1, 3791 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 3792 "gravatar_id": "somehexcode", 3793 "url": "https://api.github.com/users/octocat" 3794 }, 3795 "open_issues": 4, 3796 "closed_issues": 8, 3797 "created_at": "2011-04-10T20:09:31Z", 3798 "due_on": null 3799 }, 3800 "comments": 0, 3801 "pull_request": { 3802 "html_url": "https://github.com/octocat/Hello-World/issues/1347", 3803 "diff_url": "https://github.com/octocat/Hello-World/issues/1347.diff", 3804 "patch_url": "https://github.com/octocat/Hello-World/issues/1347.patch" 3805 }, 3806 "closed_at": null, 3807 "created_at": "2011-04-22T13:33:48Z", 3808 "updated_at": "2011-04-22T13:33:48Z" 3809 } 3810 ] 3811 /members: 3812 type: collection 3813 get: 3814 description: | 3815 Members list. 3816 List all users who are members of an organization. A member is a user that 3817 belongs to at least 1 team in the organization. If the authenticated user 3818 is also an owner of this organization then both concealed and public members 3819 will be returned. If the requester is not an owner of the organization the 3820 query will be redirected to the public members list. 3821 responses: 3822 200: 3823 body: 3824 schema: | 3825 { 3826 "$schema": "http://json-schema.org/draft-03/schema", 3827 "type": "object", 3828 "list": [ 3829 { 3830 "properties": { 3831 "login": { 3832 "type": "string" 3833 }, 3834 "id": { 3835 "type": "integer" 3836 }, 3837 "avatar_url": { 3838 "type": "string" 3839 }, 3840 "gravatar_id": { 3841 "type": "string" 3842 }, 3843 "url": { 3844 "type": "string" 3845 } 3846 }, 3847 "type": "object" 3848 } 3849 ] 3850 } 3851 example: | 3852 [ 3853 { 3854 "login": "octocat", 3855 "id": 1, 3856 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 3857 "gravatar_id": "somehexcode", 3858 "url": "https://api.github.com/users/octocat" 3859 } 3860 ] 3861 302: 3862 description: Response if requester is not an organization member. 3863 /{userId}: 3864 type: item 3865 uriParameters: 3866 userId: 3867 description: Id of the user. 3868 type: integer 3869 delete: 3870 description: | 3871 Remove a member. 3872 Removing a user from this list will remove them from all teams and they 3873 will no longer have any access to the organization's repositories. 3874 /public_members: 3875 type: collection 3876 get: 3877 description: | 3878 Public members list. 3879 Members of an organization can choose to have their membership publicized 3880 or not. 3881 responses: 3882 200: 3883 body: 3884 schema: | 3885 { 3886 "$schema": "http://json-schema.org/draft-03/schema", 3887 "type": "array", 3888 "list": [ 3889 { 3890 "properties": { 3891 "login": { 3892 "type": "string" 3893 }, 3894 "id": { 3895 "type": "integer" 3896 }, 3897 "avatar_url": { 3898 "type": "string" 3899 }, 3900 "gravatar_id": { 3901 "type": "string" 3902 }, 3903 "url": { 3904 "type": "string" 3905 } 3906 }, 3907 "type": "object" 3908 } 3909 ] 3910 } 3911 example: | 3912 [ 3913 { 3914 "login": "octocat", 3915 "id": 1, 3916 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 3917 "gravatar_id": "somehexcode", 3918 "url": "https://api.github.com/users/octocat" 3919 } 3920 ] 3921 /{userId}: 3922 uriParameters: 3923 userId: 3924 description: Id of the user. 3925 type: integer 3926 type: base 3927 get: 3928 description: Check public membership. 3929 responses: 3930 204: 3931 description: User is a public member. 3932 404: 3933 description: User is not a public member. 3934 put: 3935 description: Publicize a user's membership. 3936 responses: 3937 204: 3938 description: Publicized. 3939 delete: 3940 description: Conceal a user's membership. 3941 responses: 3942 204: 3943 description: Concealed. 3944 /teams: 3945 type: collection 3946 get: 3947 description: List teams. 3948 responses: 3949 200: 3950 body: 3951 schema: | 3952 { 3953 "$schema": "http://json-schema.org/draft-03/schema", 3954 "type": "array", 3955 "list": [ 3956 { 3957 "properties": { 3958 "url": { 3959 "type": "string" 3960 }, 3961 "name": { 3962 "type": "string" 3963 }, 3964 "id": { 3965 "type": "integer" 3966 } 3967 }, 3968 "type": "object" 3969 } 3970 ] 3971 } 3972 example: | 3973 [ 3974 { 3975 "url": "https://api.github.com/teams/1", 3976 "name": "Owners", 3977 "id": 1 3978 } 3979 ] 3980 post: 3981 description: | 3982 Create team. 3983 In order to create a team, the authenticated user must be an owner of orgId. 3984 body: 3985 application/json: 3986 schema: | 3987 { 3988 "$schema": "http://json-schema.org/draft-03/schema", 3989 "type": "object", 3990 "properties": { 3991 "name": { 3992 "type": "string" 3993 }, 3994 "repo_names": [ 3995 { 3996 "type": "string" 3997 } 3998 ], 3999 "type": "array", 4000 "permission": { 4001 "enum": [ 4002 "pull", 4003 "push", 4004 "admin" 4005 ] 4006 } 4007 }, 4008 "required": [ 4009 "name" 4010 ] 4011 } 4012 responses: 4013 201: 4014 body: 4015 schema: | 4016 { 4017 "$schema": "http://json-schema.org/draft-03/schema", 4018 "type": "object", 4019 "properties": { 4020 "url": { 4021 "type": "string" 4022 }, 4023 "name": { 4024 "type": "string" 4025 }, 4026 "id": { 4027 "type": "integer" 4028 }, 4029 "permission": { 4030 "type": "string" 4031 }, 4032 "members_count": { 4033 "type": "integer" 4034 }, 4035 "repos_count": { 4036 "type": "integer" 4037 } 4038 } 4039 } 4040 example: | 4041 [ 4042 { 4043 "url": "https://api.github.com/teams/1", 4044 "name": "Owners", 4045 "id": 1 4046 } 4047 ] 4048 /repos: 4049 type: collection 4050 get: 4051 description: List repositories for the specified org. 4052 queryParameters: 4053 type: 4054 enum: 4055 - all 4056 - public 4057 - private 4058 - forks 4059 - sources 4060 - member 4061 default: all 4062 responses: 4063 200: 4064 body: 4065 schema: | 4066 { 4067 "$schema": "http://json-schema.org/draft-03/schema", 4068 "type": "object", 4069 "properties": { 4070 "": [ 4071 { 4072 "properties": { 4073 "id": { 4074 "type": "integer" 4075 }, 4076 "owner": { 4077 "properties": { 4078 "login": { 4079 "type": "string" 4080 }, 4081 "id": { 4082 "type": "integer" 4083 }, 4084 "avatar_url": { 4085 "type": "string" 4086 }, 4087 "gravatar_id": { 4088 "type": "string" 4089 }, 4090 "url": { 4091 "type": "string" 4092 } 4093 }, 4094 "type": "object" 4095 }, 4096 "name": { 4097 "type": "string" 4098 }, 4099 "full_name": { 4100 "type": "string" 4101 }, 4102 "description": { 4103 "type": "string" 4104 }, 4105 "private": { 4106 "type": "boolean" 4107 }, 4108 "fork": { 4109 "type": "boolean" 4110 }, 4111 "url": { 4112 "type": "string" 4113 }, 4114 "html_url": { 4115 "type": "string" 4116 }, 4117 "clone_url": { 4118 "type": "string" 4119 }, 4120 "git_url": { 4121 "type": "string" 4122 }, 4123 "ssh_url": { 4124 "type": "string" 4125 }, 4126 "svn_url": { 4127 "type": "string" 4128 }, 4129 "mirror_url": { 4130 "type": "string" 4131 }, 4132 "homepage": { 4133 "type": "string" 4134 }, 4135 "language": { 4136 "type": "string" 4137 }, 4138 "forks": { 4139 "type": "integer" 4140 }, 4141 "forks_count": { 4142 "type": "integer" 4143 }, 4144 "watchers": { 4145 "type": "integer" 4146 }, 4147 "watchers_count": { 4148 "type": "integer" 4149 }, 4150 "size": { 4151 "type": "integer" 4152 }, 4153 "master_branch": { 4154 "type": "string" 4155 }, 4156 "open_issues": { 4157 "type": "integer" 4158 }, 4159 "open_issues_count": { 4160 "type": "integer" 4161 }, 4162 "pushed_at": { 4163 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 4164 "type": "string" 4165 }, 4166 "created_at": { 4167 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 4168 "type": "string" 4169 }, 4170 "updated_at": { 4171 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 4172 "type": "string" 4173 } 4174 }, 4175 "type": "object" 4176 } 4177 ] 4178 } 4179 } 4180 example: | 4181 [ 4182 { 4183 "id": 1296269, 4184 "owner": { 4185 "login": "octocat", 4186 "id": 1, 4187 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 4188 "gravatar_id": "somehexcode", 4189 "url": "https://api.github.com/users/octocat" 4190 }, 4191 "name": "Hello-World", 4192 "full_name": "octocat/Hello-World", 4193 "description": "This your first repo!", 4194 "private": false, 4195 "fork": true, 4196 "url": "https://api.github.com/repos/octocat/Hello-World", 4197 "html_url": "https://github.com/octocat/Hello-World", 4198 "clone_url": "https://github.com/octocat/Hello-World.git", 4199 "git_url": "git://github.com/octocat/Hello-World.git", 4200 "ssh_url": "git@github.com:octocat/Hello-World.git", 4201 "svn_url": "https://svn.github.com/octocat/Hello-World", 4202 "mirror_url": "git://git.example.com/octocat/Hello-World", 4203 "homepage": "https://github.com", 4204 "language": null, 4205 "forks": 9, 4206 "forks_count": 9, 4207 "watchers": 80, 4208 "watchers_count": 80, 4209 "size": 108, 4210 "master_branch": "master", 4211 "open_issues": 0, 4212 "open_issues_count": 0, 4213 "pushed_at": "2011-01-26T19:06:43Z", 4214 "created_at": "2011-01-26T19:01:12Z", 4215 "updated_at": "2011-01-26T19:14:43Z" 4216 } 4217 ] 4218 post: 4219 description: | 4220 Create a new repository for the authenticated user. OAuth users must supply 4221 repo scope. 4222 body: 4223 application/json: 4224 schema: | 4225 { 4226 "$schema": "http://json-schema.org/draft-03/schema", 4227 "type": "object", 4228 "properties": { 4229 "name": { 4230 "type": "string" 4231 }, 4232 "description": { 4233 "type": "string" 4234 }, 4235 "homepage": { 4236 "type": "string" 4237 }, 4238 "private": { 4239 "description": "True to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account.", 4240 "type": "boolean" 4241 }, 4242 "has_issues": { 4243 "description": "True to enable issues for this repository, false to disable them. Default is true.", 4244 "type": "boolean" 4245 }, 4246 "has_wiki": { 4247 "description": "True to enable the wiki for this repository, false to disable it. Default is true.", 4248 "type": "boolean" 4249 }, 4250 "has_downloads": { 4251 "description": "True to enable downloads for this repository, false to disable them. Default is true.", 4252 "type": "boolean" 4253 }, 4254 "team_id": { 4255 "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repo in an organization.", 4256 "type": "integer" 4257 }, 4258 "auto_init": { 4259 "description": "True to create an initial commit with empty README. Default is false.", 4260 "type": "boolean" 4261 }, 4262 "gitignore_template": { 4263 "description": "Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\" Ignored if auto_init parameter is not provided. ", 4264 "type": "string" 4265 } 4266 }, 4267 "required": [ "name" ] 4268 } 4269 responses: 4270 201: 4271 body: 4272 schema: | 4273 { 4274 "$schema": "http://json-schema.org/draft-03/schema", 4275 "type": "object", 4276 "properties": { 4277 "": [ 4278 { 4279 "properties": { 4280 "id": { 4281 "type": "integer" 4282 }, 4283 "owner": { 4284 "properties": { 4285 "login": { 4286 "type": "string" 4287 }, 4288 "id": { 4289 "type": "integer" 4290 }, 4291 "avatar_url": { 4292 "type": "string" 4293 }, 4294 "gravatar_id": { 4295 "type": "string" 4296 }, 4297 "url": { 4298 "type": "string" 4299 } 4300 }, 4301 "type": "object" 4302 }, 4303 "name": { 4304 "type": "string" 4305 }, 4306 "full_name": { 4307 "type": "string" 4308 }, 4309 "description": { 4310 "type": "string" 4311 }, 4312 "private": { 4313 "type": "boolean" 4314 }, 4315 "fork": { 4316 "type": "boolean" 4317 }, 4318 "url": { 4319 "type": "string" 4320 }, 4321 "html_url": { 4322 "type": "string" 4323 }, 4324 "clone_url": { 4325 "type": "string" 4326 }, 4327 "git_url": { 4328 "type": "string" 4329 }, 4330 "ssh_url": { 4331 "type": "string" 4332 }, 4333 "svn_url": { 4334 "type": "string" 4335 }, 4336 "mirror_url": { 4337 "type": "string" 4338 }, 4339 "homepage": { 4340 "type": "string" 4341 }, 4342 "language": { 4343 "type": "string" 4344 }, 4345 "forks": { 4346 "type": "integer" 4347 }, 4348 "forks_count": { 4349 "type": "integer" 4350 }, 4351 "watchers": { 4352 "type": "integer" 4353 }, 4354 "watchers_count": { 4355 "type": "integer" 4356 }, 4357 "size": { 4358 "type": "integer" 4359 }, 4360 "master_branch": { 4361 "type": "string" 4362 }, 4363 "open_issues": { 4364 "type": "integer" 4365 }, 4366 "open_issues_count": { 4367 "type": "integer" 4368 }, 4369 "pushed_at": { 4370 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 4371 "type": "string" 4372 }, 4373 "created_at": { 4374 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 4375 "type": "string" 4376 }, 4377 "updated_at": { 4378 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 4379 "type": "string" 4380 } 4381 }, 4382 "type": "object" 4383 } 4384 ] 4385 } 4386 } 4387 example: | 4388 [ 4389 { 4390 "id": 1296269, 4391 "owner": { 4392 "login": "octocat", 4393 "id": 1, 4394 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 4395 "gravatar_id": "somehexcode", 4396 "url": "https://api.github.com/users/octocat" 4397 }, 4398 "name": "Hello-World", 4399 "full_name": "octocat/Hello-World", 4400 "description": "This your first repo!", 4401 "private": false, 4402 "fork": true, 4403 "url": "https://api.github.com/repos/octocat/Hello-World", 4404 "html_url": "https://github.com/octocat/Hello-World", 4405 "clone_url": "https://github.com/octocat/Hello-World.git", 4406 "git_url": "git://github.com/octocat/Hello-World.git", 4407 "ssh_url": "git@github.com:octocat/Hello-World.git", 4408 "svn_url": "https://svn.github.com/octocat/Hello-World", 4409 "mirror_url": "git://git.example.com/octocat/Hello-World", 4410 "homepage": "https://github.com", 4411 "language": null, 4412 "forks": 9, 4413 "forks_count": 9, 4414 "watchers": 80, 4415 "watchers_count": 80, 4416 "size": 108, 4417 "master_branch": "master", 4418 "open_issues": 0, 4419 "open_issues_count": 0, 4420 "pushed_at": "2011-01-26T19:06:43Z", 4421 "created_at": "2011-01-26T19:01:12Z", 4422 "updated_at": "2011-01-26T19:14:43Z" 4423 } 4424 ] 4425/teams/{teamsId}: 4426 uriParameters: 4427 teamsId: 4428 description: Id of a team. 4429 type: integer 4430 type: item 4431 get: 4432 description: Get team. 4433 responses: 4434 200: 4435 body: 4436 schema: | 4437 { 4438 "$schema": "http://json-schema.org/draft-03/schema", 4439 "type": "object", 4440 "properties": { 4441 "url": { 4442 "type": "string" 4443 }, 4444 "name": { 4445 "type": "string" 4446 }, 4447 "id": { 4448 "type": "integer" 4449 }, 4450 "permission": { 4451 "type": "string" 4452 }, 4453 "members_count": { 4454 "type": "integer" 4455 }, 4456 "repos_count": { 4457 "type": "integer" 4458 } 4459 } 4460 } 4461 example: | 4462 [ 4463 { 4464 "url": "https://api.github.com/teams/1", 4465 "name": "Owners", 4466 "id": 1 4467 } 4468 ] 4469 patch: 4470 description: | 4471 Edit team. 4472 In order to edit a team, the authenticated user must be an owner of the org 4473 that the team is associated with. 4474 body: 4475 application/json: 4476 schema: | 4477 { 4478 "$schema": "http://json-schema.org/draft-03/schema", 4479 "type": "object", 4480 "properties": { 4481 "name": { 4482 "type": "string" 4483 }, 4484 "permission": { 4485 "values": [ 4486 "pull", 4487 "push", 4488 "admin" 4489 ] 4490 } 4491 }, 4492 "required": [ "name" ] 4493 } 4494 responses: 4495 200: 4496 body: 4497 schema: | 4498 { 4499 "$schema": "http://json-schema.org/draft-03/schema", 4500 "type": "object", 4501 "properties": { 4502 "url": { 4503 "type": "string" 4504 }, 4505 "name": { 4506 "type": "string" 4507 }, 4508 "id": { 4509 "type": "integer" 4510 }, 4511 "permission": { 4512 "type": "string" 4513 }, 4514 "members_count": { 4515 "type": "integer" 4516 }, 4517 "repos_count": { 4518 "type": "integer" 4519 } 4520 } 4521 } 4522 example: | 4523 [ 4524 { 4525 "url": "https://api.github.com/teams/1", 4526 "name": "Owners", 4527 "id": 1 4528 } 4529 ] 4530 delete: 4531 description: | 4532 Delete team. 4533 In order to delete a team, the authenticated user must be an owner of the 4534 org that the team is associated with. 4535 /members: 4536 type: collection 4537 get: 4538 description: | 4539 List team members. 4540 In order to list members in a team, the authenticated user must be a member 4541 of the team. 4542 responses: 4543 200: 4544 body: 4545 schema: | 4546 { 4547 "$schema": "http://json-schema.org/draft-03/schema", 4548 "type": "array", 4549 "list": [ 4550 { 4551 "properties": { 4552 "login": { 4553 "type": "string" 4554 }, 4555 "id": { 4556 "type": "integer" 4557 }, 4558 "avatar_url": { 4559 "type": "string" 4560 }, 4561 "gravatar_id": { 4562 "type": "string" 4563 }, 4564 "url": { 4565 "type": "string" 4566 } 4567 }, 4568 "type": "object" 4569 } 4570 ] 4571 } 4572 example: | 4573 [ 4574 { 4575 "login": "octocat", 4576 "id": 1, 4577 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 4578 "gravatar_id": "somehexcode", 4579 "url": "https://api.github.com/users/octocat" 4580 } 4581 ] 4582 /{userId}: 4583 uriParameters: 4584 userId: 4585 description: Id of a member. 4586 type: integer 4587 type: base 4588 get: 4589 description: | 4590 Get team member. 4591 In order to get if a user is a member of a team, the authenticated user must 4592 be a member of the team. 4593 responses: 4594 204: 4595 description: User is a member. 4596 404: 4597 description: User is not a member. 4598 put: 4599 description: | 4600 Add team member. 4601 In order to add a user to a team, the authenticated user must have 'admin' 4602 permissions to the team or be an owner of the org that the team is associated 4603 with. 4604 responses: 4605 204: 4606 description: Team member added. 4607 422: 4608 description: If you attempt to add an organization to a team, you will get this. 4609 body: 4610 application/json: 4611 schema: | 4612 { 4613 "$schema": "http://json-schema.org/draft-03/schema", 4614 "type": "object", 4615 "properties": { 4616 "message": { 4617 "type": "string" 4618 }, 4619 "errors": [ 4620 { 4621 "properties": { 4622 "code": { 4623 "type": "string" 4624 }, 4625 "field": { 4626 "type": "string" 4627 }, 4628 "resource": { 4629 "type": "string" 4630 } 4631 }, 4632 "type": "object" 4633 } 4634 ], 4635 "type": "object" 4636 } 4637 } 4638 example: | 4639 { 4640 "message": "Validation Failed", 4641 "errors": [ 4642 { 4643 "code": "org", 4644 "field": "user", 4645 "resource": "TeamMember" 4646 } 4647 ] 4648 } 4649 delete: 4650 description: | 4651 Remove team member. 4652 In order to remove a user from a team, the authenticated user must have 'admin' 4653 permissions to the team or be an owner of the org that the team is associated 4654 with. 4655 NOTE This does not delete the user, it just remove them from the team. 4656 responses: 4657 204: 4658 description: Team member removed. 4659/repositories: 4660 type: collection 4661 get: 4662 securedBy: [ null, oauth_2_0 ] 4663 description: | 4664 List all public repositories. 4665 This provides a dump of every public repository, in the order that they 4666 were created. 4667 Note: Pagination is powered exclusively by the since parameter. is the 4668 Link header to get the URL for the next page of repositories. 4669 queryParameters: 4670 since: 4671 description: | 4672 The integer ID of the last Repository that you've seen. 4673 responses: 4674 200: 4675 body: 4676 schema: | 4677 { 4678 "$schema": "http://json-schema.org/draft-03/schema", 4679 "type": "array", 4680 "list": [ 4681 { 4682 "properties": { 4683 "id": { 4684 "type": "integer" 4685 }, 4686 "owner": { 4687 "properties": { 4688 "login": { 4689 "type": "string" 4690 }, 4691 "id": { 4692 "type": "integer" 4693 }, 4694 "avatar_url": { 4695 "type": "string" 4696 }, 4697 "gravatar_id": { 4698 "type": "string" 4699 }, 4700 "url": { 4701 "type": "string" 4702 } 4703 }, 4704 "type": "object" 4705 }, 4706 "name": { 4707 "type": "string" 4708 }, 4709 "full_name": { 4710 "type": "string" 4711 }, 4712 "description": { 4713 "type": "string" 4714 }, 4715 "private": { 4716 "type": "boolean" 4717 }, 4718 "fork": { 4719 "type": "boolean" 4720 }, 4721 "url": { 4722 "type": "string" 4723 }, 4724 "html_url": { 4725 "type": "string" 4726 } 4727 }, 4728 "type": "object" 4729 } 4730 ] 4731 } 4732 example: | 4733 [ 4734 { 4735 "id": 1296269, 4736 "owner": { 4737 "login": "octocat", 4738 "id": 1, 4739 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 4740 "gravatar_id": "somehexcode", 4741 "url": "https://api.github.com/users/octocat" 4742 }, 4743 "name": "Hello-World", 4744 "full_name": "octocat/Hello-World", 4745 "description": "This your first repo!", 4746 "private": false, 4747 "fork": false, 4748 "url": "https://api.github.com/repos/octocat/Hello-World", 4749 "html_url": "https://github.com/octocat/Hello-World" 4750 } 4751 ] 4752/repos/{ownerId}/{repoId}: 4753 uriParameters: 4754 ownerId: 4755 description: Id of the owner. 4756 type: integer 4757 repoId: 4758 description: Id of repository. 4759 type: integer 4760 type: item 4761 get: 4762 description: Get repository. 4763 responses: 4764 200: 4765 body: 4766 schema: | 4767 { 4768 "$schema": "http://json-schema.org/draft-03/schema", 4769 "type": "object", 4770 "properties": { 4771 "id": { 4772 "type": "integer" 4773 }, 4774 "owner": { 4775 "properties": { 4776 "login": { 4777 "type": "string" 4778 }, 4779 "id": { 4780 "type": "integer" 4781 }, 4782 "avatar_url": { 4783 "type": "string" 4784 }, 4785 "gravatar_id": { 4786 "type": "string" 4787 }, 4788 "url": { 4789 "type": "string" 4790 } 4791 }, 4792 "type": "object" 4793 }, 4794 "name": { 4795 "type": "string" 4796 }, 4797 "full_name": { 4798 "type": "string" 4799 }, 4800 "description": { 4801 "type": "string" 4802 }, 4803 "private": { 4804 "type": "boolean" 4805 }, 4806 "fork": { 4807 "type": "boolean" 4808 }, 4809 "url": { 4810 "type": "string" 4811 }, 4812 "html_url": { 4813 "type": "string" 4814 }, 4815 "clone_url": { 4816 "type": "string" 4817 }, 4818 "git_url": { 4819 "type": "string" 4820 }, 4821 "ssh_url": { 4822 "type": "string" 4823 }, 4824 "svn_url": { 4825 "type": "string" 4826 }, 4827 "mirror_url": { 4828 "type": "string" 4829 }, 4830 "homepage": { 4831 "type": "string" 4832 }, 4833 "language": { 4834 "type": "string" 4835 }, 4836 "forks": { 4837 "type": "integer" 4838 }, 4839 "forks_count": { 4840 "type": "integer" 4841 }, 4842 "watchers": { 4843 "type": "integer" 4844 }, 4845 "watchers_count": { 4846 "type": "integer" 4847 }, 4848 "size": { 4849 "type": "integer" 4850 }, 4851 "master_branch": { 4852 "type": "string" 4853 }, 4854 "open_issues": { 4855 "type": "integer" 4856 }, 4857 "open_issues_count": { 4858 "type": "integer" 4859 }, 4860 "pushed_at": { 4861 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 4862 "type": "string" 4863 }, 4864 "created_at": { 4865 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 4866 "type": "string" 4867 }, 4868 "updated_at": { 4869 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 4870 "type": "string" 4871 }, 4872 "organization": { 4873 "properties": { 4874 "login": { 4875 "type": "string" 4876 }, 4877 "id": { 4878 "type": "integer" 4879 }, 4880 "avatar_url": { 4881 "type": "string" 4882 }, 4883 "gravatar_id": { 4884 "type": "string" 4885 }, 4886 "url": { 4887 "type": "string" 4888 }, 4889 "type": { 4890 "type": "string" 4891 } 4892 }, 4893 "type": "object" 4894 }, 4895 "parent": { 4896 "description": "Is present when the repo is a fork. Parent is the repo this repo was forked from.", 4897 "properties": { 4898 "id": { 4899 "type": "integer" 4900 }, 4901 "owner": { 4902 "properties": { 4903 "login": { 4904 "type": "string" 4905 }, 4906 "id": { 4907 "type": "integer" 4908 }, 4909 "avatar_url": { 4910 "type": "string" 4911 }, 4912 "gravatar_id": { 4913 "type": "string" 4914 }, 4915 "url": { 4916 "type": "string" 4917 } 4918 }, 4919 "type": "object" 4920 }, 4921 "name": { 4922 "type": "string" 4923 }, 4924 "full_name": { 4925 "type": "string" 4926 }, 4927 "description": { 4928 "type": "string" 4929 }, 4930 "private": { 4931 "type": "boolean" 4932 }, 4933 "fork": { 4934 "type": "boolean" 4935 }, 4936 "url": { 4937 "type": "string" 4938 }, 4939 "html_url": { 4940 "type": "string" 4941 }, 4942 "clone_url": { 4943 "type": "string" 4944 }, 4945 "git_url": { 4946 "type": "string" 4947 }, 4948 "ssh_url": { 4949 "type": "string" 4950 }, 4951 "svn_url": { 4952 "type": "string" 4953 }, 4954 "mirror_url": { 4955 "type": "string" 4956 }, 4957 "homepage": { 4958 "type": "string" 4959 }, 4960 "language": { 4961 "type": "string" 4962 }, 4963 "forks": { 4964 "type": "integer" 4965 }, 4966 "forks_count": { 4967 "type": "integer" 4968 }, 4969 "watchers": { 4970 "type": "integer" 4971 }, 4972 "watchers_count": { 4973 "type": "integer" 4974 }, 4975 "size": { 4976 "type": "integer" 4977 }, 4978 "master_branch": { 4979 "type": "string" 4980 }, 4981 "open_issues": { 4982 "type": "integer" 4983 }, 4984 "open_issues_count": { 4985 "type": "integer" 4986 }, 4987 "pushed_at": { 4988 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 4989 "type": "string" 4990 }, 4991 "created_at": { 4992 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 4993 "type": "string" 4994 }, 4995 "updated_at": { 4996 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 4997 "type": "string" 4998 } 4999 }, 5000 "type": "object" 5001 }, 5002 "source": { 5003 "description": "Is present when the repo is a fork. Source is the ultimate source for the network.", 5004 "properties": { 5005 "id": { 5006 "type": "integer" 5007 }, 5008 "owner": { 5009 "properties": { 5010 "login": { 5011 "type": "string" 5012 }, 5013 "id": { 5014 "type": "integer" 5015 }, 5016 "avatar_url": { 5017 "type": "string" 5018 }, 5019 "gravatar_id": { 5020 "type": "string" 5021 }, 5022 "url": { 5023 "type": "string" 5024 } 5025 }, 5026 "type": "object" 5027 }, 5028 "type": "object" 5029 }, 5030 "name": { 5031 "type": "string" 5032 }, 5033 "full_name": { 5034 "type": "string" 5035 }, 5036 "description": { 5037 "type": "string" 5038 }, 5039 "private": { 5040 "type": "boolean" 5041 }, 5042 "fork": { 5043 "type": "boolean" 5044 }, 5045 "url": { 5046 "type": "string" 5047 }, 5048 "html_url": { 5049 "type": "string" 5050 }, 5051 "clone_url": { 5052 "type": "string" 5053 }, 5054 "git_url": { 5055 "type": "string" 5056 }, 5057 "ssh_url": { 5058 "type": "string" 5059 }, 5060 "svn_url": { 5061 "type": "string" 5062 }, 5063 "mirror_url": { 5064 "type": "string" 5065 }, 5066 "homepage": { 5067 "type": "string" 5068 }, 5069 "language": { 5070 "type": "string" 5071 }, 5072 "forks": { 5073 "type": "integer" 5074 }, 5075 "forks_count": { 5076 "type": "integer" 5077 }, 5078 "watchers": { 5079 "type": "integer" 5080 }, 5081 "watchers_count": { 5082 "type": "integer" 5083 }, 5084 "size": { 5085 "type": "integer" 5086 }, 5087 "master_branch": { 5088 "type": "string" 5089 }, 5090 "open_issues": { 5091 "type": "integer" 5092 }, 5093 "open_issues_count": { 5094 "type": "integer" 5095 }, 5096 "pushed_at": { 5097 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 5098 "type": "string" 5099 }, 5100 "created_at": { 5101 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 5102 "type": "string" 5103 }, 5104 "updated_at": { 5105 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 5106 "type": "string" 5107 } 5108 }, 5109 "has_issues": { 5110 "type": "boolean" 5111 }, 5112 "has_wiki": { 5113 "type": "boolean" 5114 }, 5115 "has_downloads": { 5116 "type": "boolean" 5117 } 5118 } 5119 } 5120 example: | 5121 { 5122 "id": 1296269, 5123 "owner": { 5124 "login": "octocat", 5125 "id": 1, 5126 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 5127 "gravatar_id": "somehexcode", 5128 "url": "https://api.github.com/users/octocat" 5129 }, 5130 "name": "Hello-World", 5131 "full_name": "octocat/Hello-World", 5132 "description": "This your first repo!", 5133 "private": false, 5134 "fork": false, 5135 "url": "https://api.github.com/repos/octocat/Hello-World", 5136 "html_url": "https://github.com/octocat/Hello-World", 5137 "clone_url": "https://github.com/octocat/Hello-World.git", 5138 "git_url": "git://github.com/octocat/Hello-World.git", 5139 "ssh_url": "git@github.com:octocat/Hello-World.git", 5140 "svn_url": "https://svn.github.com/octocat/Hello-World", 5141 "mirror_url": "git://git.example.com/octocat/Hello-World", 5142 "homepage": "https://github.com", 5143 "language": null, 5144 "forks": 9, 5145 "forks_count": 9, 5146 "watchers": 80, 5147 "watchers_count": 80, 5148 "size": 108, 5149 "master_branch": "master", 5150 "open_issues": 0, 5151 "open_issues_count": 0, 5152 "pushed_at": "2011-01-26T19:06:43Z", 5153 "created_at": "2011-01-26T19:01:12Z", 5154 "updated_at": "2011-01-26T19:14:43Z", 5155 "organization": { 5156 "login": "octocat", 5157 "id": 1, 5158 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 5159 "gravatar_id": "somehexcode", 5160 "url": "https://api.github.com/users/octocat", 5161 "type": "Organization" 5162 }, 5163 "parent": { 5164 "id": 1296269, 5165 "owner": { 5166 "login": "octocat", 5167 "id": 1, 5168 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 5169 "gravatar_id": "somehexcode", 5170 "url": "https://api.github.com/users/octocat" 5171 }, 5172 "name": "Hello-World", 5173 "full_name": "octocat/Hello-World", 5174 "description": "This your first repo!", 5175 "private": false, 5176 "fork": true, 5177 "url": "https://api.github.com/repos/octocat/Hello-World", 5178 "html_url": "https://github.com/octocat/Hello-World", 5179 "clone_url": "https://github.com/octocat/Hello-World.git", 5180 "git_url": "git://github.com/octocat/Hello-World.git", 5181 "ssh_url": "git@github.com:octocat/Hello-World.git", 5182 "svn_url": "https://svn.github.com/octocat/Hello-World", 5183 "mirror_url": "git://git.example.com/octocat/Hello-World", 5184 "homepage": "https://github.com", 5185 "language": null, 5186 "forks": 9, 5187 "forks_count": 9, 5188 "watchers": 80, 5189 "watchers_count": 80, 5190 "size": 108, 5191 "master_branch": "master", 5192 "open_issues": 0, 5193 "open_issues_count": 0, 5194 "pushed_at": "2011-01-26T19:06:43Z", 5195 "created_at": "2011-01-26T19:01:12Z", 5196 "updated_at": "2011-01-26T19:14:43Z" 5197 }, 5198 "source": { 5199 "id": 1296269, 5200 "owner": { 5201 "login": "octocat", 5202 "id": 1, 5203 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 5204 "gravatar_id": "somehexcode", 5205 "url": "https://api.github.com/users/octocat" 5206 }, 5207 "name": "Hello-World", 5208 "full_name": "octocat/Hello-World", 5209 "description": "This your first repo!", 5210 "private": false, 5211 "fork": true, 5212 "url": "https://api.github.com/repos/octocat/Hello-World", 5213 "html_url": "https://github.com/octocat/Hello-World", 5214 "clone_url": "https://github.com/octocat/Hello-World.git", 5215 "git_url": "git://github.com/octocat/Hello-World.git", 5216 "ssh_url": "git@github.com:octocat/Hello-World.git", 5217 "svn_url": "https://svn.github.com/octocat/Hello-World", 5218 "mirror_url": "git://git.example.com/octocat/Hello-World", 5219 "homepage": "https://github.com", 5220 "language": null, 5221 "forks": 9, 5222 "forks_count": 9, 5223 "watchers": 80, 5224 "watchers_count": 80, 5225 "size": 108, 5226 "master_branch": "master", 5227 "open_issues": 0, 5228 "open_issues_count": 0, 5229 "pushed_at": "2011-01-26T19:06:43Z", 5230 "created_at": "2011-01-26T19:01:12Z", 5231 "updated_at": "2011-01-26T19:14:43Z" 5232 }, 5233 "has_issues": true, 5234 "has_wiki": true, 5235 "has_downloads": true 5236 } 5237 patch: 5238 description: Edit repository. 5239 body: 5240 application/json: 5241 schema: | 5242 { 5243 "$schema": "http://json-schema.org/draft-03/schema", 5244 "type": "object", 5245 "properties": { 5246 "name": { 5247 "type": "string" 5248 }, 5249 "description": { 5250 "type": "string" 5251 }, 5252 "homepage": { 5253 "type": "string" 5254 }, 5255 "private": { 5256 "description": "True makes the repository private, and false makes it public.", 5257 "type": "boolean" 5258 }, 5259 "has_issues": { 5260 "description": "True to enable issues for this repository, false to disable them. Default is true.", 5261 "type": "boolean" 5262 }, 5263 "has_wiki": { 5264 "description": "True to enable the wiki for this repository, false to disable it. Default is true.", 5265 "type": "boolean" 5266 }, 5267 "has_downloads": { 5268 "description": "True to enable downloads for this repository, false to disable them. Default is true.", 5269 "type": "boolean" 5270 }, 5271 "default_branch": { 5272 "description": "Update the default branch for this repository.", 5273 "type": "string" 5274 } 5275 }, 5276 "required": [ "name" ] 5277 } 5278 responses: 5279 200: 5280 body: 5281 schema: | 5282 { 5283 "$schema": "http://json-schema.org/draft-03/schema", 5284 "type": "object", 5285 "properties": { 5286 "id": { 5287 "type": "integer" 5288 }, 5289 "owner": { 5290 "properties": { 5291 "login": { 5292 "type": "string" 5293 }, 5294 "id": { 5295 "type": "integer" 5296 }, 5297 "avatar_url": { 5298 "type": "string" 5299 }, 5300 "gravatar_id": { 5301 "type": "string" 5302 }, 5303 "url": { 5304 "type": "string" 5305 } 5306 }, 5307 "type": "object" 5308 }, 5309 "name": { 5310 "type": "string" 5311 }, 5312 "full_name": { 5313 "type": "string" 5314 }, 5315 "description": { 5316 "type": "string" 5317 }, 5318 "private": { 5319 "type": "boolean" 5320 }, 5321 "fork": { 5322 "type": "boolean" 5323 }, 5324 "url": { 5325 "type": "string" 5326 }, 5327 "html_url": { 5328 "type": "string" 5329 }, 5330 "clone_url": { 5331 "type": "string" 5332 }, 5333 "git_url": { 5334 "type": "string" 5335 }, 5336 "ssh_url": { 5337 "type": "string" 5338 }, 5339 "svn_url": { 5340 "type": "string" 5341 }, 5342 "mirror_url": { 5343 "type": "string" 5344 }, 5345 "homepage": { 5346 "type": "string" 5347 }, 5348 "language": { 5349 "type": "string" 5350 }, 5351 "forks": { 5352 "type": "integer" 5353 }, 5354 "forks_count": { 5355 "type": "integer" 5356 }, 5357 "watchers": { 5358 "type": "integer" 5359 }, 5360 "watchers_count": { 5361 "type": "integer" 5362 }, 5363 "size": { 5364 "type": "integer" 5365 }, 5366 "master_branch": { 5367 "type": "string" 5368 }, 5369 "open_issues": { 5370 "type": "integer" 5371 }, 5372 "open_issues_count": { 5373 "type": "integer" 5374 }, 5375 "pushed_at": { 5376 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 5377 "type": "string" 5378 }, 5379 "created_at": { 5380 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 5381 "type": "string" 5382 }, 5383 "updated_at": { 5384 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 5385 "type": "string" 5386 }, 5387 "organization": { 5388 "properties": { 5389 "login": { 5390 "type": "string" 5391 }, 5392 "id": { 5393 "type": "integer" 5394 }, 5395 "avatar_url": { 5396 "type": "string" 5397 }, 5398 "gravatar_id": { 5399 "type": "string" 5400 }, 5401 "url": { 5402 "type": "string" 5403 }, 5404 "type": { 5405 "type": "string" 5406 } 5407 }, 5408 "type": "object" 5409 }, 5410 "parent": { 5411 "description": "Is present when the repo is a fork. Parent is the repo this repo was forked from.", 5412 "properties": { 5413 "id": { 5414 "type": "integer" 5415 }, 5416 "owner": { 5417 "properties": { 5418 "login": { 5419 "type": "string" 5420 }, 5421 "id": { 5422 "type": "integer" 5423 }, 5424 "avatar_url": { 5425 "type": "string" 5426 }, 5427 "gravatar_id": { 5428 "type": "string" 5429 }, 5430 "url": { 5431 "type": "string" 5432 } 5433 }, 5434 "type": "object" 5435 }, 5436 "name": { 5437 "type": "string" 5438 }, 5439 "full_name": { 5440 "type": "string" 5441 }, 5442 "description": { 5443 "type": "string" 5444 }, 5445 "private": { 5446 "type": "boolean" 5447 }, 5448 "fork": { 5449 "type": "boolean" 5450 }, 5451 "url": { 5452 "type": "string" 5453 }, 5454 "html_url": { 5455 "type": "string" 5456 }, 5457 "clone_url": { 5458 "type": "string" 5459 }, 5460 "git_url": { 5461 "type": "string" 5462 }, 5463 "ssh_url": { 5464 "type": "string" 5465 }, 5466 "svn_url": { 5467 "type": "string" 5468 }, 5469 "mirror_url": { 5470 "type": "string" 5471 }, 5472 "homepage": { 5473 "type": "string" 5474 }, 5475 "language": { 5476 "type": "string" 5477 }, 5478 "forks": { 5479 "type": "integer" 5480 }, 5481 "forks_count": { 5482 "type": "integer" 5483 }, 5484 "watchers": { 5485 "type": "integer" 5486 }, 5487 "watchers_count": { 5488 "type": "integer" 5489 }, 5490 "size": { 5491 "type": "integer" 5492 }, 5493 "master_branch": { 5494 "type": "string" 5495 }, 5496 "open_issues": { 5497 "type": "integer" 5498 }, 5499 "open_issues_count": { 5500 "type": "integer" 5501 }, 5502 "pushed_at": { 5503 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 5504 "type": "string" 5505 }, 5506 "created_at": { 5507 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 5508 "type": "string" 5509 }, 5510 "updated_at": { 5511 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 5512 "type": "string" 5513 } 5514 }, 5515 "type": "object" 5516 }, 5517 "source": { 5518 "description": "Is present when the repo is a fork. Source is the ultimate source for the network.", 5519 "properties": { 5520 "id": { 5521 "type": "integer" 5522 }, 5523 "owner": { 5524 "properties": { 5525 "login": { 5526 "type": "string" 5527 }, 5528 "id": { 5529 "type": "integer" 5530 }, 5531 "avatar_url": { 5532 "type": "string" 5533 }, 5534 "gravatar_id": { 5535 "type": "string" 5536 }, 5537 "url": { 5538 "type": "string" 5539 } 5540 }, 5541 "type": "object" 5542 }, 5543 "type": "object" 5544 }, 5545 "name": { 5546 "type": "string" 5547 }, 5548 "full_name": { 5549 "type": "string" 5550 }, 5551 "description": { 5552 "type": "string" 5553 }, 5554 "private": { 5555 "type": "boolean" 5556 }, 5557 "fork": { 5558 "type": "boolean" 5559 }, 5560 "url": { 5561 "type": "string" 5562 }, 5563 "html_url": { 5564 "type": "string" 5565 }, 5566 "clone_url": { 5567 "type": "string" 5568 }, 5569 "git_url": { 5570 "type": "string" 5571 }, 5572 "ssh_url": { 5573 "type": "string" 5574 }, 5575 "svn_url": { 5576 "type": "string" 5577 }, 5578 "mirror_url": { 5579 "type": "string" 5580 }, 5581 "homepage": { 5582 "type": "string" 5583 }, 5584 "language": { 5585 "type": "string" 5586 }, 5587 "forks": { 5588 "type": "integer" 5589 }, 5590 "forks_count": { 5591 "type": "integer" 5592 }, 5593 "watchers": { 5594 "type": "integer" 5595 }, 5596 "watchers_count": { 5597 "type": "integer" 5598 }, 5599 "size": { 5600 "type": "integer" 5601 }, 5602 "master_branch": { 5603 "type": "string" 5604 }, 5605 "open_issues": { 5606 "type": "integer" 5607 }, 5608 "open_issues_count": { 5609 "type": "integer" 5610 }, 5611 "pushed_at": { 5612 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 5613 "type": "string" 5614 }, 5615 "created_at": { 5616 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 5617 "type": "string" 5618 }, 5619 "updated_at": { 5620 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 5621 "type": "string" 5622 } 5623 }, 5624 "has_issues": { 5625 "type": "boolean" 5626 }, 5627 "has_wiki": { 5628 "type": "boolean" 5629 }, 5630 "has_downloads": { 5631 "type": "boolean" 5632 } 5633 } 5634 } 5635 example: | 5636 { 5637 "id": 1296269, 5638 "owner": { 5639 "login": "octocat", 5640 "id": 1, 5641 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 5642 "gravatar_id": "somehexcode", 5643 "url": "https://api.github.com/users/octocat" 5644 }, 5645 "name": "Hello-World", 5646 "full_name": "octocat/Hello-World", 5647 "description": "This your first repo!", 5648 "private": false, 5649 "fork": false, 5650 "url": "https://api.github.com/repos/octocat/Hello-World", 5651 "html_url": "https://github.com/octocat/Hello-World", 5652 "clone_url": "https://github.com/octocat/Hello-World.git", 5653 "git_url": "git://github.com/octocat/Hello-World.git", 5654 "ssh_url": "git@github.com:octocat/Hello-World.git", 5655 "svn_url": "https://svn.github.com/octocat/Hello-World", 5656 "mirror_url": "git://git.example.com/octocat/Hello-World", 5657 "homepage": "https://github.com", 5658 "language": null, 5659 "forks": 9, 5660 "forks_count": 9, 5661 "watchers": 80, 5662 "watchers_count": 80, 5663 "size": 108, 5664 "master_branch": "master", 5665 "open_issues": 0, 5666 "open_issues_count": 0, 5667 "pushed_at": "2011-01-26T19:06:43Z", 5668 "created_at": "2011-01-26T19:01:12Z", 5669 "updated_at": "2011-01-26T19:14:43Z", 5670 "organization": { 5671 "login": "octocat", 5672 "id": 1, 5673 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 5674 "gravatar_id": "somehexcode", 5675 "url": "https://api.github.com/users/octocat", 5676 "type": "Organization" 5677 }, 5678 "parent": { 5679 "id": 1296269, 5680 "owner": { 5681 "login": "octocat", 5682 "id": 1, 5683 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 5684 "gravatar_id": "somehexcode", 5685 "url": "https://api.github.com/users/octocat" 5686 }, 5687 "name": "Hello-World", 5688 "full_name": "octocat/Hello-World", 5689 "description": "This your first repo!", 5690 "private": false, 5691 "fork": true, 5692 "url": "https://api.github.com/repos/octocat/Hello-World", 5693 "html_url": "https://github.com/octocat/Hello-World", 5694 "clone_url": "https://github.com/octocat/Hello-World.git", 5695 "git_url": "git://github.com/octocat/Hello-World.git", 5696 "ssh_url": "git@github.com:octocat/Hello-World.git", 5697 "svn_url": "https://svn.github.com/octocat/Hello-World", 5698 "mirror_url": "git://git.example.com/octocat/Hello-World", 5699 "homepage": "https://github.com", 5700 "language": null, 5701 "forks": 9, 5702 "forks_count": 9, 5703 "watchers": 80, 5704 "watchers_count": 80, 5705 "size": 108, 5706 "master_branch": "master", 5707 "open_issues": 0, 5708 "open_issues_count": 0, 5709 "pushed_at": "2011-01-26T19:06:43Z", 5710 "created_at": "2011-01-26T19:01:12Z", 5711 "updated_at": "2011-01-26T19:14:43Z" 5712 }, 5713 "source": { 5714 "id": 1296269, 5715 "owner": { 5716 "login": "octocat", 5717 "id": 1, 5718 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 5719 "gravatar_id": "somehexcode", 5720 "url": "https://api.github.com/users/octocat" 5721 }, 5722 "name": "Hello-World", 5723 "full_name": "octocat/Hello-World", 5724 "description": "This your first repo!", 5725 "private": false, 5726 "fork": true, 5727 "url": "https://api.github.com/repos/octocat/Hello-World", 5728 "html_url": "https://github.com/octocat/Hello-World", 5729 "clone_url": "https://github.com/octocat/Hello-World.git", 5730 "git_url": "git://github.com/octocat/Hello-World.git", 5731 "ssh_url": "git@github.com:octocat/Hello-World.git", 5732 "svn_url": "https://svn.github.com/octocat/Hello-World", 5733 "mirror_url": "git://git.example.com/octocat/Hello-World", 5734 "homepage": "https://github.com", 5735 "language": null, 5736 "forks": 9, 5737 "forks_count": 9, 5738 "watchers": 80, 5739 "watchers_count": 80, 5740 "size": 108, 5741 "master_branch": "master", 5742 "open_issues": 0, 5743 "open_issues_count": 0, 5744 "pushed_at": "2011-01-26T19:06:43Z", 5745 "created_at": "2011-01-26T19:01:12Z", 5746 "updated_at": "2011-01-26T19:14:43Z" 5747 }, 5748 "has_issues": true, 5749 "has_wiki": true, 5750 "has_downloads": true 5751 } 5752 delete: 5753 description: | 5754 Delete a Repository. 5755 Deleting a repository requires admin access. If OAuth is used, the delete_repo 5756 scope is required. 5757 # Events 5758 /events: 5759 type: collection 5760 get: 5761 description: Get list of repository events. 5762 responses: 5763 200: 5764 body: 5765 schema: | 5766 { 5767 "$schema": "http://json-schema.org/draft-03/schema", 5768 "type": "array", 5769 "properties": [ 5770 { 5771 "properties": { 5772 "type": { 5773 "type": "string" 5774 }, 5775 "public": { 5776 "type": "boolean" 5777 }, 5778 "payload": { 5779 "properties": {}, 5780 "type": "object" 5781 }, 5782 "repo": { 5783 "properties": { 5784 "id": { 5785 "type": "integer" 5786 }, 5787 "name": { 5788 "type": "string" 5789 }, 5790 "url": { 5791 "type": "string" 5792 } 5793 }, 5794 "type": "object" 5795 }, 5796 "actor": { 5797 "properties": { 5798 "login": { 5799 "type": "string" 5800 }, 5801 "id": { 5802 "type": "integer" 5803 }, 5804 "avatar_url": { 5805 "type": "string" 5806 }, 5807 "gravatar_id": { 5808 "type": "string" 5809 }, 5810 "url": { 5811 "type": "string" 5812 } 5813 }, 5814 "type": "object" 5815 }, 5816 "org": { 5817 "properties": { 5818 "login": { 5819 "type": "string" 5820 }, 5821 "id": { 5822 "type": "integer" 5823 }, 5824 "avatar_url": { 5825 "type": "string" 5826 }, 5827 "gravatar_id": { 5828 "type": "string" 5829 }, 5830 "url": { 5831 "type": "string" 5832 } 5833 }, 5834 "type": "object" 5835 }, 5836 "created_at": { 5837 "type": "timestamp" 5838 }, 5839 "id": { 5840 "type": "integer" 5841 } 5842 }, 5843 "type": "object" 5844 } 5845 ] 5846 } 5847 example: | 5848 [ 5849 { 5850 "type": "Event", 5851 "public": true, 5852 "payload": { 5853 5854 }, 5855 "repo": { 5856 "id": 3, 5857 "name": "octocat/Hello-World", 5858 "url": "https://api.github.com/repos/octocat/Hello-World" 5859 }, 5860 "actor": { 5861 "login": "octocat", 5862 "id": 1, 5863 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 5864 "gravatar_id": "somehexcode", 5865 "url": "https://api.github.com/users/octocat" 5866 }, 5867 "org": { 5868 "login": "octocat", 5869 "id": 1, 5870 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 5871 "gravatar_id": "somehexcode", 5872 "url": "https://api.github.com/users/octocat" 5873 }, 5874 "created_at": "2011-09-06T17:26:27Z", 5875 "id": "12345" 5876 } 5877 ] 5878 # Languages 5879 /languages: 5880 type: collection 5881 get: 5882 description: | 5883 List languages. 5884 List languages for the specified repository. The value on the right of a 5885 language is the number of bytes of code written in that language. 5886 responses: 5887 200: 5888 body: 5889 schema: | 5890 { 5891 "$schema": "http://json-schema.org/draft-03/schema", 5892 "type": "object", 5893 "properties": { 5894 "language": { 5895 "type": "string" 5896 }, 5897 "count": { 5898 "type": "string" 5899 } 5900 } 5901 } 5902 example: | 5903 { 5904 "C": 78769, 5905 "Python": 7769 5906 } 5907 # GIT 5908 /git: 5909 /blobs: 5910 type: collection 5911 post: 5912 description: Create a Blob. 5913 body: 5914 application/json: 5915 schema: | 5916 { 5917 "$schema": "http://json-schema.org/draft-03/schema", 5918 "type": "object", 5919 "properties": { 5920 "content": { 5921 "type": "string" 5922 }, 5923 "encoding": { 5924 "enum": [ 5925 "utf-8", 5926 "base64" 5927 ] 5928 }, 5929 "sha": { 5930 "type": "string" 5931 }, 5932 "size": { 5933 "type": "integer" 5934 } 5935 } 5936 } 5937 responses: 5938 201: 5939 body: 5940 schema: | 5941 { 5942 "$schema": "http://json-schema.org/draft-03/schema", 5943 "type": "object", 5944 "properties": { 5945 "sha": { 5946 "type": "string" 5947 } 5948 } 5949 } 5950 example: | 5951 { 5952 "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15" 5953 } 5954 /{shaCode}: 5955 uriParameters: 5956 shaCode: 5957 description: SHA-1 code. 5958 type: string 5959 type: item 5960 get: 5961 description: | 5962 Get a Blob. 5963 Since blobs can be any arbitrary binary data, the input and responses for 5964 the blob API takes an encoding parameter that can be either utf-8 or 5965 base64. If your data cannot be losslessly sent as a UTF-8 string, you can 5966 base64 encode it. 5967 responses: 5968 200: 5969 body: 5970 schema: | 5971 { 5972 "$schema": "http://json-schema.org/draft-03/schema", 5973 "type": "object", 5974 "properties": { 5975 "content": { 5976 "type": "string" 5977 }, 5978 "encoding": { 5979 "enum": [ 5980 "utf-8", 5981 "base64" 5982 ] 5983 }, 5984 "sha": { 5985 "type": "string" 5986 }, 5987 "size": { 5988 "type": "integer" 5989 } 5990 } 5991 } 5992 example: | 5993 { 5994 "content": "Content of the blob", 5995 "encoding": "utf-8", 5996 "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", 5997 "size": 100 5998 } 5999 /commits: 6000 type: item 6001 post: 6002 description: Create a Commit. 6003 body: 6004 application/json: 6005 schema: | 6006 { 6007 "$schema": "http://json-schema.org/draft-03/schema", 6008 "type": "object", 6009 "properties": { 6010 "message": { 6011 "description": "String of the commit message", 6012 "type": "string" 6013 }, 6014 "tree": { 6015 "description": "String of the SHA of the tree object this commit points to.", 6016 "type": "string" 6017 }, 6018 "parents": [ 6019 { 6020 "description": "Array of the SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided, for a merge commit, an array of more than one should be provided.", 6021 "type": "string" 6022 } 6023 ], 6024 "type": "array", 6025 "author": { 6026 "properties": { 6027 "name": { 6028 "description": "String of the name of the author of the commit.", 6029 "type": "string" 6030 }, 6031 "email": { 6032 "description": "String of the email of the author of the commit.", 6033 "type": "string" 6034 }, 6035 "date": { 6036 "description": "Timestamp of when this commit was authored.", 6037 "type": "timestamp" 6038 } 6039 }, 6040 "type": "object" 6041 }, 6042 "committer": { 6043 "properties": { 6044 "name": { 6045 "description": "String of the name of the committer of the commit.", 6046 "type": "string" 6047 }, 6048 "email": { 6049 "description": "String of the email of the committer of the commit.", 6050 "type": "string" 6051 }, 6052 "date": { 6053 "description": "Timestamp of when this commit was committed.", 6054 "type": "timestamp" 6055 } 6056 }, 6057 "type": "object" 6058 } 6059 }, 6060 "required": [ 6061 "message", 6062 "tree", 6063 "parents" 6064 ] 6065 } 6066 responses: 6067 201: 6068 body: 6069 schema: | 6070 { 6071 "": "http://json-schema.org/draft-03/schema", 6072 "type": "object", 6073 "properties": { 6074 "message": { 6075 "type": "string" 6076 }, 6077 "author": { 6078 "properties": { 6079 "name": { 6080 "type": "string" 6081 }, 6082 "email": { 6083 "type": "string" 6084 }, 6085 "date": { 6086 "type": "string" 6087 } 6088 }, 6089 "type": "object" 6090 }, 6091 "parents": [ 6092 { 6093 "type": "string" 6094 } 6095 ], 6096 "tree": { 6097 "type": "string" 6098 } 6099 } 6100 } 6101 example: | 6102 { 6103 "message": "my commit message", 6104 "author": { 6105 "name": "Scott Chacon", 6106 "email": "schacon@gmail.com", 6107 "date": "2008-07-09T16:13:30+12:00" 6108 }, 6109 "parents": [ 6110 "7d1b31e74ee336d15cbd21741bc88a537ed063a0" 6111 ], 6112 "tree": "827efc6d56897b048c772eb4087f854f46256132" 6113 } 6114 /{shaCode}: 6115 uriParameters: 6116 shaCode: 6117 description: SHA-1 code. 6118 type: string 6119 type: item 6120 get: 6121 description: Get a Commit. 6122 responses: 6123 200: 6124 body: 6125 schema: | 6126 { 6127 "$schema": "http://json-schema.org/draft-03/schema", 6128 "type": "object", 6129 "properties": { 6130 "sha": { 6131 "type": "string" 6132 }, 6133 "url": { 6134 "type": "string" 6135 }, 6136 "author": { 6137 "properties": { 6138 "date": { 6139 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 6140 "type": "string" 6141 }, 6142 "name": { 6143 "type": "string" 6144 }, 6145 "email": { 6146 "type": "string" 6147 } 6148 }, 6149 "type": "object" 6150 }, 6151 "committer": { 6152 "properties": { 6153 "date": { 6154 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 6155 "type": "string" 6156 }, 6157 "name": { 6158 "type": "string" 6159 }, 6160 "email": { 6161 "type": "string" 6162 } 6163 }, 6164 "type": "object" 6165 }, 6166 "message": { 6167 "type": "string" 6168 }, 6169 "tree": { 6170 "properties": { 6171 "url": { 6172 "type": "string" 6173 }, 6174 "sha": { 6175 "type": "string" 6176 } 6177 }, 6178 "type": "object" 6179 }, 6180 "parents": [ 6181 { 6182 "properties": { 6183 "url": { 6184 "type": "string" 6185 }, 6186 "sha": { 6187 "type": "string" 6188 } 6189 }, 6190 "type": "object" 6191 } 6192 ], 6193 "type": "array" 6194 } 6195 } 6196 example: | 6197 { 6198 "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", 6199 "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", 6200 "author": { 6201 "date": "2010-04-10T14:10:01-07:00", 6202 "name": "Scott Chacon", 6203 "email": "schacon@gmail.com" 6204 }, 6205 "committer": { 6206 "date": "2010-04-10T14:10:01-07:00", 6207 "name": "Scott Chacon", 6208 "email": "schacon@gmail.com" 6209 }, 6210 "message": "added readme, because im a good github citizen\n", 6211 "tree": { 6212 "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", 6213 "sha": "691272480426f78a0138979dd3ce63b77f706feb" 6214 }, 6215 "parents": [ 6216 { 6217 "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", 6218 "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5" 6219 } 6220 ] 6221 } 6222 /refs: 6223 type: collection 6224 get: 6225 description: Get all References 6226 responses: 6227 200: 6228 body: 6229 schema: | 6230 { 6231 "$schema": "http://json-schema.org/draft-03/schema", 6232 "type": "array", 6233 "references": [ 6234 { 6235 "properties": { 6236 "ref": { 6237 "type": "string" 6238 }, 6239 "url": { 6240 "type": "string" 6241 }, 6242 "object": { 6243 "properties": { 6244 "type": { 6245 "type": "string" 6246 }, 6247 "sha": { 6248 "type": "string" 6249 }, 6250 "url": { 6251 "type": "string" 6252 } 6253 }, 6254 "type": "object" 6255 } 6256 }, 6257 "type": "object" 6258 } 6259 ] 6260 } 6261 example: | 6262 [ 6263 { 6264 "ref": "refs/heads/master", 6265 "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/master", 6266 "object": { 6267 "type": "commit", 6268 "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", 6269 "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" 6270 } 6271 }, 6272 { 6273 "ref": "refs/heads/gh-pages", 6274 "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/gh-pages", 6275 "object": { 6276 "type": "commit", 6277 "sha": "612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac", 6278 "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac" 6279 } 6280 }, 6281 { 6282 "ref": "refs/tags/v0.0.1", 6283 "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/tags/v0.0.1", 6284 "object": { 6285 "type": "tag", 6286 "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", 6287 "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac" 6288 } 6289 } 6290 ] 6291 post: 6292 description: Create a Reference 6293 body: 6294 application/json: 6295 schema: | 6296 { 6297 "$schema": "http://json-schema.org/draft-03/schema", 6298 "type": "object", 6299 "properties": { 6300 "ref": { 6301 "description": "String of the name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with ?refs' and have at least two slashes, it will be rejected.", 6302 "type": "string" 6303 }, 6304 "sha": { 6305 "description": "String of the SHA1 value to set this reference to.", 6306 "type": "string" 6307 } 6308 }, 6309 "required": [ 6310 "ref", 6311 "sha" 6312 ] 6313 } 6314 responses: 6315 201: 6316 body: 6317 schema: | 6318 { 6319 "$schema": "http://json-schema.org/draft-03/schema", 6320 "type": "object", 6321 "properties": { 6322 "ref": { 6323 "type": "string" 6324 }, 6325 "url": { 6326 "type": "string" 6327 }, 6328 "object": { 6329 "properties": { 6330 "type": { 6331 "type": "string" 6332 }, 6333 "sha": { 6334 "type": "string" 6335 }, 6336 "url": { 6337 "type": "string" 6338 } 6339 }, 6340 "type": "object" 6341 } 6342 } 6343 } 6344 example: | 6345 { 6346 "ref": "refs/heads/sc/featureA", 6347 "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/sc/featureA", 6348 "object": { 6349 "type": "commit", 6350 "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", 6351 "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" 6352 } 6353 } 6354 /{heads}: 6355 uriParameters: 6356 heads: 6357 description: Subfolder of path to the branch. 6358 type: string 6359 type: collection 6360 get: 6361 description: Get list of subdirectories. 6362 responses: 6363 200: 6364 body: 6365 schema: | 6366 { 6367 "$schema": "http://json-schema.org/draft-03/schema", 6368 "type": "array", 6369 "list": [ 6370 { 6371 "properties": { 6372 "name": { 6373 "type": "string" 6374 }, 6375 "commit": { 6376 "properties": { 6377 "sha": { 6378 "type": "string" 6379 }, 6380 "url": { 6381 "type": "string" 6382 } 6383 }, 6384 "type": "object" 6385 }, 6386 "zipball_url": { 6387 "type": "string" 6388 }, 6389 "tarball_url": { 6390 "type": "string" 6391 } 6392 }, 6393 "type": "object" 6394 } 6395 ] 6396 } 6397 example: | 6398 [ 6399 { 6400 "name": "v0.1", 6401 "commit": { 6402 "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", 6403 "url": "https://api.github.com/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" 6404 }, 6405 "zipball_url": "https://github.com/octocat/Hello-World/zipball/v0.1", 6406 "tarball_url": "https://github.com/octocat/Hello-World/tarball/v0.1" 6407 } 6408 ] 6409 /{branch}: 6410 type: item 6411 uriParameters: 6412 branch: 6413 description: Path to the branch. 6414 type: string 6415 get: 6416 description: Get a Reference. 6417 responses: 6418 200: 6419 body: 6420 schema: | 6421 { 6422 "$schema": "http://json-schema.org/draft-03/schema", 6423 "type": "object", 6424 "properties": { 6425 "ref": { 6426 "type": "string" 6427 }, 6428 "url": { 6429 "type": "string" 6430 }, 6431 "object": { 6432 "properties": { 6433 "type": { 6434 "type": "string" 6435 }, 6436 "sha": { 6437 "type": "string" 6438 }, 6439 "url": { 6440 "type": "string" 6441 } 6442 }, 6443 "type": "object" 6444 } 6445 } 6446 } 6447 example: | 6448 { 6449 "ref": "refs/heads/sc/featureA", 6450 "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/sc/featureA", 6451 "object": { 6452 "type": "commit", 6453 "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", 6454 "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" 6455 } 6456 } 6457 patch: 6458 description: Update a Reference 6459 body: 6460 application/json: 6461 schema: | 6462 { 6463 "$schema": "http://json-schema.org/draft-03/schema", 6464 "type": "object", 6465 "properties": { 6466 "sha": { 6467 "description": "String of the SHA1 value to set this reference to.", 6468 "type": "string" 6469 }, 6470 "force": { 6471 "description": "Boolean indicating whether to force the update or to make sure the update is a fast-forward update. The default is false, so leaving this out or setting it to false will make sure you're not overwriting work.", 6472 "type": "boolean" 6473 } 6474 }, 6475 "required": [ 6476 "sha", 6477 "force" 6478 ] 6479 } 6480 responses: 6481 200: 6482 body: 6483 schema: | 6484 { 6485 "$schema": "http://json-schema.org/draft-03/schema", 6486 "type": "object", 6487 "properties": { 6488 "ref": { 6489 "type": "string" 6490 }, 6491 "url": { 6492 "type": "string" 6493 }, 6494 "object": { 6495 "properties": { 6496 "type": { 6497 "type": "string" 6498 }, 6499 "sha": { 6500 "type": "string" 6501 }, 6502 "url": { 6503 "type": "string" 6504 } 6505 }, 6506 "type": "object" 6507 } 6508 } 6509 } 6510 example: | 6511 { 6512 "ref": "refs/heads/sc/featureA", 6513 "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/sc/featureA", 6514 "object": { 6515 "type": "commit", 6516 "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", 6517 "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" 6518 } 6519 } 6520 delete: 6521 description: Delete a Reference. 6522 /tags: 6523 type: collection 6524 post: 6525 description: | 6526 Create a Tag Object. 6527 Note that creating a tag object does not create the reference that makes a 6528 tag in Git. If you want to create an annotated tag in Git, you have to do 6529 this call to create the tag object, and then create the refs/tags/[tag] 6530 reference. If you want to create a lightweight tag, you only have to create 6531 the tag reference - this call would be unnecessary. 6532 body: 6533 application/json: 6534 schema: | 6535 { 6536 "$schema": "http://json-schema.org/draft-03/schema", 6537 "type": "object", 6538 "properties": { 6539 "tag": { 6540 "type": "string" 6541 }, 6542 "sha": { 6543 "type": "string" 6544 }, 6545 "url": { 6546 "type": "string" 6547 }, 6548 "message": { 6549 "type": "string" 6550 }, 6551 "tagger": { 6552 "properties": { 6553 "name": { 6554 "type": "string" 6555 }, 6556 "email": { 6557 "type": "string" 6558 }, 6559 "date": { 6560 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 6561 "type": "string" 6562 } 6563 }, 6564 "type": "object" 6565 }, 6566 "object": { 6567 "properties": { 6568 "type": { 6569 "type": "string" 6570 }, 6571 "sha": { 6572 "type": "string" 6573 }, 6574 "url": { 6575 "type": "string" 6576 } 6577 }, 6578 "type": "object" 6579 } 6580 } 6581 } 6582 responses: 6583 201: 6584 body: 6585 schema: | 6586 { 6587 "$schema": "http://json-schema.org/draft-03/schema", 6588 "type": "object", 6589 "properties": { 6590 "tag": { 6591 "type": "string" 6592 }, 6593 "message": { 6594 "description": "String of the tag message.", 6595 "type": "string" 6596 }, 6597 "object": { 6598 "description": "String of the SHA of the git object this is tagging.", 6599 "type": "string" 6600 }, 6601 "type": { 6602 "description": "String of the type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.", 6603 "type": "string" 6604 }, 6605 "tagger": { 6606 "properties": { 6607 "name": { 6608 "description": "String of the name of the author of the tag.", 6609 "type": "string" 6610 }, 6611 "email": { 6612 "description": "String of the email of the author of the tag.", 6613 "type": "string" 6614 }, 6615 "date": { 6616 "description": "Timestamp of when this object was tagged.", 6617 "type": "timestamp" 6618 } 6619 }, 6620 "type": "object" 6621 } 6622 }, 6623 "required": [ 6624 "tag", 6625 "message", 6626 "object", 6627 "type", 6628 "tagger" 6629 ] 6630 } 6631 example: | 6632 { 6633 "tag": "v0.0.1", 6634 "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", 6635 "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", 6636 "message": "initial version\n", 6637 "tagger": { 6638 "name": "Scott Chacon", 6639 "email": "schacon@gmail.com", 6640 "date": "2011-06-17T14:53:35-07:00" 6641 }, 6642 "object": { 6643 "type": "commit", 6644 "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", 6645 "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" 6646 } 6647 } 6648 /{shaCode}: 6649 type: item 6650 get: 6651 description: Get a Tag. 6652 responses: 6653 200: 6654 body: 6655 schema: | 6656 { 6657 "$schema": "http://json-schema.org/draft-03/schema", 6658 "type": "object", 6659 "properties": { 6660 "tag": { 6661 "type": "string" 6662 }, 6663 "sha": { 6664 "type": "string" 6665 }, 6666 "url": { 6667 "type": "string" 6668 }, 6669 "message": { 6670 "type": "string" 6671 }, 6672 "tagger": { 6673 "properties": { 6674 "name": { 6675 "type": "string" 6676 }, 6677 "email": { 6678 "type": "string" 6679 }, 6680 "date": { 6681 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 6682 "type": "string" 6683 } 6684 }, 6685 "type": "object" 6686 }, 6687 "object": { 6688 "properties": { 6689 "type": { 6690 "type": "string" 6691 }, 6692 "sha": { 6693 "type": "string" 6694 }, 6695 "url": { 6696 "type": "string" 6697 } 6698 }, 6699 "type": "object" 6700 } 6701 } 6702 } 6703 example: | 6704 { 6705 "tag": "v0.0.1", 6706 "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", 6707 "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", 6708 "message": "initial version\n", 6709 "tagger": { 6710 "name": "Scott Chacon", 6711 "email": "schacon@gmail.com", 6712 "date": "2011-06-17T14:53:35-07:00" 6713 }, 6714 "object": { 6715 "type": "commit", 6716 "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", 6717 "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" 6718 } 6719 } 6720 /trees: 6721 type: collection 6722 post: 6723 description: | 6724 Create a Tree. 6725 The tree creation API will take nested entries as well. If both a tree and 6726 a nested path modifying that tree are specified, it will overwrite the 6727 contents of that tree with the new path contents and write a new tree out. 6728 body: 6729 application/json: 6730 schema: | 6731 { 6732 "$schema": "http://json-schema.org/draft-03/schema", 6733 "type": "object", 6734 "properties": { 6735 "sha": { 6736 "type": "string" 6737 }, 6738 "url": { 6739 "type": "string" 6740 }, 6741 "tree": [ 6742 { 6743 "path": { 6744 "type": "string" 6745 }, 6746 "mode": { 6747 "type": "string" 6748 }, 6749 "type": { 6750 "type": "string" 6751 }, 6752 "size": { 6753 "type": "integer" 6754 }, 6755 "sha": { 6756 "type": "string" 6757 }, 6758 "url": { 6759 "type": "string" 6760 } 6761 } 6762 ], 6763 "type": "array" 6764 } 6765 } 6766 responses: 6767 201: 6768 body: 6769 schema: | 6770 { 6771 "$schema": "http://json-schema.org/draft-03/schema", 6772 "type": "object", 6773 "properties": { 6774 "base_tree": { 6775 "type": "string" 6776 }, 6777 "tree": [ 6778 { 6779 "properties": { 6780 "path": { 6781 "type": "string" 6782 }, 6783 "mode": { 6784 "description": "One of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit) or 120000 for a blob that specifies the path of a symlink.", 6785 "type": "string", 6786 "enum": [ 6787 "100644", 6788 "100755", 6789 "040000", 6790 "160000", 6791 "120000" 6792 ] 6793 }, 6794 "type": { 6795 "type": "string", 6796 "enum": [ 6797 "blob", 6798 "tree", 6799 "commit" 6800 ] 6801 }, 6802 "oneOf": [ 6803 { 6804 "sha": { 6805 "description": "SHA1 checksum ID of the object in the tree.", 6806 "type": "string" 6807 } 6808 }, 6809 { 6810 "content": { 6811 "description": "content you want this file to have - GitHub will write this blob out and use that SHA for this entry.", 6812 "type": "string" 6813 } 6814 } 6815 ] 6816 }, 6817 "type": "object" 6818 } 6819 ], 6820 "type": "array" 6821 }, 6822 "required": [ 6823 "tree" 6824 ] 6825 } 6826 example: | 6827 { 6828 "sha": "cd8274d15fa3ae2ab983129fb037999f264ba9a7", 6829 "url": "https://api.github.com/repo/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", 6830 "tree": [ 6831 { 6832 "path": "file.rb", 6833 "mode": "100644", 6834 "type": "blob", 6835 "size": 132, 6836 "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b", 6837 "url": "https://api.github.com/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b" 6838 } 6839 ] 6840 } 6841 /{shaCode}: 6842 uriParameters: 6843 shaCode: 6844 description: Id of the owner. 6845 type: integer 6846 type: item 6847 get: 6848 description: Get a Tree. 6849 queryParameters: 6850 recursive: 6851 description: Get a Tree Recursively. (0 or 1) 6852 type: integer 6853 responses: 6854 200: 6855 body: 6856 schema: | 6857 { 6858 "$schema": "http://json-schema.org/draft-03/schema", 6859 "type": "object", 6860 "properties": { 6861 "sha": { 6862 "type": "string" 6863 }, 6864 "url": { 6865 "type": "string" 6866 }, 6867 "tree": [ 6868 { 6869 "path": { 6870 "type": "string" 6871 }, 6872 "mode": { 6873 "type": "string" 6874 }, 6875 "type": { 6876 "type": "string" 6877 }, 6878 "size": { 6879 "type": "integer" 6880 }, 6881 "sha": { 6882 "type": "string" 6883 }, 6884 "url": { 6885 "type": "string" 6886 } 6887 } 6888 ], 6889 "type": "array" 6890 } 6891 } 6892 example: | 6893 { 6894 "sha": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", 6895 "url": "https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312", 6896 "tree": [ 6897 { 6898 "path": "file.rb", 6899 "mode": "100644", 6900 "type": "blob", 6901 "size": 30, 6902 "sha": "44b4fc6d56897b048c772eb4087f854f46256132", 6903 "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" 6904 }, 6905 { 6906 "path": "subdir", 6907 "mode": "040000", 6908 "type": "tree", 6909 "sha": "f484d249c660418515fb01c2b9662073663c242e", 6910 "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e" 6911 }, 6912 { 6913 "path": "exec_file", 6914 "mode": "100755", 6915 "type": "blob", 6916 "size": 75, 6917 "sha": "45b983be36b73c0788dc9cbcb76cbb80fc7bb057", 6918 "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057" 6919 } 6920 ] 6921 } 6922 # Readme 6923 /readme: 6924 type: item 6925 get: 6926 description: | 6927 Get the README. 6928 This method returns the preferred README for a repository. 6929 queryParameters: 6930 ref: 6931 description: The String name of the Commit/Branch/Tag. Defaults to master. 6932 type: string 6933 responses: 6934 200: 6935 body: 6936 schema: | 6937 { 6938 "$schema": "http://json-schema.org/draft-03/schema", 6939 "type": "object", 6940 "properties": { 6941 "type": { 6942 "type": "string" 6943 }, 6944 "encoding": { 6945 "type": "string" 6946 }, 6947 "size": { 6948 "type": "integer" 6949 }, 6950 "name": { 6951 "type": "string" 6952 }, 6953 "path": { 6954 "type": "string" 6955 }, 6956 "content": { 6957 "type": "string" 6958 }, 6959 "sha": { 6960 "type": "string" 6961 }, 6962 "url": { 6963 "type": "string" 6964 }, 6965 "git_url": { 6966 "type": "string" 6967 }, 6968 "html_url": { 6969 "type": "string" 6970 }, 6971 "_links": { 6972 "properties": { 6973 "git": { 6974 "type": "string" 6975 }, 6976 "self": { 6977 "type": "string" 6978 }, 6979 "html": { 6980 "type": "string" 6981 } 6982 }, 6983 "type": "object" 6984 } 6985 } 6986 } 6987 example: | 6988 { 6989 "type": "file", 6990 "encoding": "base64", 6991 "size": 5362, 6992 "name": "README.md", 6993 "path": "README.md", 6994 "content": "encoded content ...", 6995 "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", 6996 "url": "https://api.github.com/repos/pengwynn/octokit/contents/README.md", 6997 "git_url": "https://api.github.com/repos/pengwynn/octokit/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", 6998 "html_url": "https://github.com/pengwynn/octokit/blob/master/README.md", 6999 "_links": { 7000 "git": "https://api.github.com/repos/pengwynn/octokit/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", 7001 "self": "https://api.github.com/repos/pengwynn/octokit/contents/README.md", 7002 "html": "https://github.com/pengwynn/octokit/blob/master/README.md" 7003 } 7004 } 7005 # Stargazers 7006 /stargazers: 7007 type: collection 7008 get: 7009 description: List Stargazers. 7010 responses: 7011 200: 7012 body: 7013 schema: | 7014 { 7015 "$schema": "http://json-schema.org/draft-03/schema", 7016 "type": "array", 7017 "list": [ 7018 { 7019 "properties": { 7020 "login": { 7021 "type": "string" 7022 }, 7023 "id": { 7024 "type": "integer" 7025 }, 7026 "avatar_url": { 7027 "type": "string" 7028 }, 7029 "gravatar_id": { 7030 "type": "string" 7031 }, 7032 "url": { 7033 "type": "string" 7034 } 7035 }, 7036 "type": "object" 7037 } 7038 ] 7039 } 7040 example: | 7041 [ 7042 { 7043 "login": "octocat", 7044 "id": 1, 7045 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 7046 "gravatar_id": "somehexcode", 7047 "url": "https://api.github.com/users/octocat" 7048 } 7049 ] 7050 # Subscribers 7051 /subscribers: 7052 type: collection 7053 get: 7054 description: List watchers. 7055 responses: 7056 200: 7057 body: 7058 schema: | 7059 { 7060 "$schema": "http://json-schema.org/draft-03/schema", 7061 "type": "array", 7062 "list": [ 7063 { 7064 "properties": { 7065 "login": { 7066 "type": "string" 7067 }, 7068 "id": { 7069 "type": "integer" 7070 }, 7071 "avatar_url": { 7072 "type": "string" 7073 }, 7074 "gravatar_id": { 7075 "type": "string" 7076 }, 7077 "url": { 7078 "type": "string" 7079 } 7080 }, 7081 "type": "object" 7082 } 7083 ] 7084 } 7085 example: | 7086 [ 7087 { 7088 "login": "octocat", 7089 "id": 1, 7090 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 7091 "gravatar_id": "somehexcode", 7092 "url": "https://api.github.com/users/octocat" 7093 } 7094 ] 7095 # Tags 7096 /tags: 7097 type: collection 7098 get: 7099 description: Get list of tags. 7100 responses: 7101 200: 7102 body: 7103 schema: | 7104 { 7105 "$schema": "http://json-schema.org/draft-03/schema", 7106 "type": "object", 7107 "properties": { 7108 "tag": { 7109 "type": "string" 7110 }, 7111 "message": { 7112 "description": "String of the tag message.", 7113 "type": "string" 7114 }, 7115 "object": { 7116 "description": "String of the SHA of the git object this is tagging.", 7117 "type": "string" 7118 }, 7119 "type": { 7120 "description": "String of the type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.", 7121 "type": "string" 7122 }, 7123 "tagger": { 7124 "properties": { 7125 "name": { 7126 "description": "String of the name of the author of the tag.", 7127 "type": "string" 7128 }, 7129 "email": { 7130 "description": "String of the email of the author of the tag.", 7131 "type": "string" 7132 }, 7133 "date": { 7134 "description": "Timestamp of when this object was tagged.", 7135 "type": "timestamp" 7136 } 7137 }, 7138 "type": "object" 7139 } 7140 }, 7141 "required": [ 7142 "tag", 7143 "message", 7144 "object", 7145 "type", 7146 "tagger" 7147 ] 7148 } 7149 example: | 7150 { 7151 "tag": "v0.0.1", 7152 "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", 7153 "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", 7154 "message": "initial version\n", 7155 "tagger": { 7156 "name": "Scott Chacon", 7157 "email": "schacon@gmail.com", 7158 "date": "2011-06-17T14:53:35-07:00" 7159 }, 7160 "object": { 7161 "type": "commit", 7162 "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", 7163 "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" 7164 } 7165 } 7166 # Teams 7167 /teams: 7168 type: collection 7169 get: 7170 description: Get list of teams 7171 responses: 7172 200: 7173 body: 7174 schema: | 7175 { 7176 "$schema": "http://json-schema.org/draft-03/schema", 7177 "type": "array", 7178 "list": [ 7179 { 7180 "properties": { 7181 "url": { 7182 "type": "string" 7183 }, 7184 "name": { 7185 "type": "string" 7186 }, 7187 "id": { 7188 "type": "integer" 7189 } 7190 }, 7191 "type": "object" 7192 } 7193 ] 7194 } 7195 example: | 7196 [ 7197 { 7198 "url": "https://api.github.com/teams/1", 7199 "name": "Owners", 7200 "id": 1 7201 } 7202 ] 7203 # Watchers 7204 /watchers: 7205 type: collection 7206 get: 7207 description: List Stargazers. New implementation. 7208 responses: 7209 200: 7210 body: 7211 schema: | 7212 { 7213 "$schema": "http://json-schema.org/draft-03/schema", 7214 "type": "array", 7215 "list": [ 7216 { 7217 "properties": { 7218 "login": { 7219 "type": "string" 7220 }, 7221 "id": { 7222 "type": "integer" 7223 }, 7224 "avatar_url": { 7225 "type": "string" 7226 }, 7227 "gravatar_id": { 7228 "type": "string" 7229 }, 7230 "url": { 7231 "type": "string" 7232 } 7233 }, 7234 "type": "object" 7235 } 7236 ] 7237 } 7238 example: | 7239 [ 7240 { 7241 "login": "octocat", 7242 "id": 1, 7243 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 7244 "gravatar_id": "somehexcode", 7245 "url": "https://api.github.com/users/octocat" 7246 } 7247 ] 7248 # Other links 7249 /contributors: 7250 type: collection 7251 get: 7252 description: Get list of contributors. 7253 queryParameters: 7254 anon: 7255 description: Set to 1 or true to include anonymous contributors in results. 7256 type: string 7257 required: true 7258 responses: 7259 200: 7260 body: 7261 schema: | 7262 { 7263 "$schema": "http://json-schema.org/draft-03/schema", 7264 "type": "array", 7265 "list": [ 7266 { 7267 "properties": { 7268 "login": { 7269 "type": "string" 7270 }, 7271 "id": { 7272 "type": "integer" 7273 }, 7274 "avatar_url": { 7275 "type": "string" 7276 }, 7277 "gravatar_id": { 7278 "type": "string" 7279 }, 7280 "url": { 7281 "type": "string" 7282 }, 7283 "contributions": { 7284 "type": "integer" 7285 } 7286 }, 7287 "type": "object" 7288 } 7289 ] 7290 } 7291 example: | 7292 [ 7293 { 7294 "login": "octocat", 7295 "id": 1, 7296 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 7297 "gravatar_id": "somehexcode", 7298 "url": "https://api.github.com/users/octocat", 7299 "contributions": 32 7300 } 7301 ] 7302 /branches: 7303 type: collection 7304 get: 7305 description: Get list of branches 7306 responses: 7307 200: 7308 body: 7309 schema: | 7310 { 7311 "$schema": "http://json-schema.org/draft-03/schema", 7312 "type": "array", 7313 "list": [ 7314 { 7315 "properties": { 7316 "name": { 7317 "type": "string" 7318 }, 7319 "commit": { 7320 "properties": { 7321 "sha": { 7322 "type": "string" 7323 }, 7324 "url": { 7325 "type": "string" 7326 } 7327 }, 7328 "type": "object" 7329 } 7330 }, 7331 "type": "object" 7332 } 7333 ] 7334 } 7335 example: | 7336 [ 7337 { 7338 "name": "master", 7339 "commit": { 7340 "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 7341 "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" 7342 } 7343 } 7344 ] 7345 /{branchId}: 7346 uriParameters: 7347 branchId: 7348 description: Id of the branch. 7349 type: integer 7350 type: item 7351 get: 7352 description: Get Branch 7353 responses: 7354 200: 7355 body: 7356 schema: | 7357 { 7358 "$schema": "http://json-schema.org/draft-03/schema", 7359 "type": "object", 7360 "properties": { 7361 "name": { 7362 "type": "string" 7363 }, 7364 "commit": { 7365 "properties": { 7366 "sha": { 7367 "type": "string" 7368 }, 7369 "commit": { 7370 "author": { 7371 "name": { 7372 "type": "string" 7373 }, 7374 "date": { 7375 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 7376 "type": "string" 7377 }, 7378 "email": { 7379 "type": "string" 7380 } 7381 }, 7382 "url": { 7383 "type": "string" 7384 }, 7385 "message": { 7386 "type": "string" 7387 }, 7388 "tree": { 7389 "properties": { 7390 "sha": { 7391 "type": "string" 7392 }, 7393 "url": { 7394 "type": "string" 7395 } 7396 }, 7397 "type": "object" 7398 }, 7399 "committer": { 7400 "properties": { 7401 "name": { 7402 "type": "string" 7403 }, 7404 "date": { 7405 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 7406 "type": "string" 7407 }, 7408 "email": { 7409 "type": "string" 7410 } 7411 }, 7412 "type": "object" 7413 } 7414 }, 7415 "type": "object" 7416 }, 7417 "author": { 7418 "properties": { 7419 "gravatar_id": { 7420 "type": "string" 7421 }, 7422 "avatar_url": { 7423 "type": "string" 7424 }, 7425 "url": { 7426 "type": "string" 7427 }, 7428 "id": { 7429 "type": "integer" 7430 }, 7431 "login": { 7432 "type": "string" 7433 } 7434 }, 7435 "type": "object" 7436 }, 7437 "parents": [ 7438 { 7439 "properties": { 7440 "sha": { 7441 "type": "string" 7442 }, 7443 "url": { 7444 "type": "string" 7445 } 7446 }, 7447 "type": "object" 7448 } 7449 ], 7450 "type": "array", 7451 "url": { 7452 "type": "string" 7453 }, 7454 "committer": { 7455 "properties": { 7456 "gravatar_id": { 7457 "type": "string" 7458 }, 7459 "avatar_url": { 7460 "type": "string" 7461 }, 7462 "url": { 7463 "type": "string" 7464 }, 7465 "id": { 7466 "type": "integer" 7467 }, 7468 "login": { 7469 "type": "string" 7470 } 7471 }, 7472 "type": "object" 7473 } 7474 }, 7475 "_links": { 7476 "properties": { 7477 "html": { 7478 "type": "string" 7479 }, 7480 "self": { 7481 "type": "string" 7482 } 7483 }, 7484 "type": "object" 7485 } 7486 } 7487 } 7488 example: | 7489 { 7490 "name": "master", 7491 "commit": { 7492 "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", 7493 "commit": { 7494 "author": { 7495 "name": "The Octocat", 7496 "date": "2012-03-06T15:06:50-08:00", 7497 "email": "octocat@nowhere.com" 7498 }, 7499 "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", 7500 "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", 7501 "tree": { 7502 "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", 7503 "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" 7504 }, 7505 "committer": { 7506 "name": "The Octocat", 7507 "date": "2012-03-06T15:06:50-08:00", 7508 "email": "octocat@nowhere.com" 7509 } 7510 }, 7511 "author": { 7512 "gravatar_id": "7ad39074b0584bc555d0417ae3e7d974", 7513 "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", 7514 "url": "https://api.github.com/users/octocat", 7515 "id": 583231, 7516 "login": "octocat" 7517 }, 7518 "parents": [ 7519 { 7520 "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", 7521 "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" 7522 }, 7523 { 7524 "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", 7525 "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303" 7526 } 7527 ], 7528 "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", 7529 "committer": { 7530 "gravatar_id": "7ad39074b0584bc555d0417ae3e7d974", 7531 "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", 7532 "url": "https://api.github.com/users/octocat", 7533 "id": 583231, 7534 "login": "octocat" 7535 } 7536 }, 7537 "_links": { 7538 "html": "https://github.com/octocat/Hello-World/tree/master", 7539 "self": "https://api.github.com/repos/octocat/Hello-World/branches/master" 7540 } 7541 } 7542 /issues: 7543 type: collection 7544 get: 7545 is: [ filterable ] 7546 description: List issues for a repository. 7547 responses: 7548 200: 7549 body: 7550 schema: | 7551 { 7552 "$schema": "http://json-schema.org/draft-03/schema", 7553 "type": "array", 7554 "issues": [ 7555 { 7556 "properties": { 7557 "url": { 7558 "type": "string" 7559 }, 7560 "html_url": { 7561 "type": "string" 7562 }, 7563 "number": { 7564 "type": "integer" 7565 }, 7566 "state": { 7567 "enum": [ 7568 "open", 7569 "closed" 7570 ] 7571 }, 7572 "title": { 7573 "type": "string" 7574 }, 7575 "body": { 7576 "type": "string" 7577 }, 7578 "user": { 7579 "properties": { 7580 "login": { 7581 "type": "string" 7582 }, 7583 "id": { 7584 "type": "integer" 7585 }, 7586 "avatar_url": { 7587 "type": "string" 7588 }, 7589 "gravatar_id": { 7590 "type": "string" 7591 }, 7592 "url": { 7593 "type": "string" 7594 } 7595 }, 7596 "type": "object" 7597 }, 7598 "labels": [ 7599 { 7600 "properties": { 7601 "url": { 7602 "type": "string" 7603 }, 7604 "name": { 7605 "type": "string" 7606 }, 7607 "color": { 7608 "type": "string" 7609 } 7610 }, 7611 "type": "object" 7612 } 7613 ], 7614 "type": "array", 7615 "assignee": { 7616 "properties": { 7617 "login": { 7618 "type": "string" 7619 }, 7620 "id": { 7621 "type": "integer" 7622 }, 7623 "avatar_url": { 7624 "type": "string" 7625 }, 7626 "gravatar_id": { 7627 "type": "string" 7628 }, 7629 "url": { 7630 "type": "string" 7631 } 7632 }, 7633 "type": "object" 7634 }, 7635 "milestone": { 7636 "properties": { 7637 "url": { 7638 "type": "string" 7639 }, 7640 "number": { 7641 "type": "integer" 7642 }, 7643 "state": { 7644 "enum": [ 7645 "open", 7646 "closed" 7647 ] 7648 }, 7649 "title": { 7650 "type": "string" 7651 }, 7652 "description": { 7653 "type": "string" 7654 }, 7655 "creator": { 7656 "properties": { 7657 "login": { 7658 "type": "string" 7659 }, 7660 "id": { 7661 "type": "integer" 7662 }, 7663 "avatar_url": { 7664 "type": "string" 7665 }, 7666 "gravatar_id": { 7667 "type": "string" 7668 }, 7669 "url": { 7670 "type": "string" 7671 } 7672 }, 7673 "type": "object" 7674 }, 7675 "open_issues": { 7676 "type": "integer" 7677 }, 7678 "closed_issues": { 7679 "type": "integer" 7680 }, 7681 "created_at": { 7682 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 7683 "type": "string" 7684 }, 7685 "due_on": { 7686 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 7687 "type": "string" 7688 } 7689 }, 7690 "type": "object" 7691 }, 7692 "comments": { 7693 "type": "integer" 7694 }, 7695 "pull_request": { 7696 "properties": { 7697 "html_url": { 7698 "type": "string" 7699 }, 7700 "diff_url": { 7701 "type": "string" 7702 }, 7703 "patch_url": { 7704 "type": "string" 7705 } 7706 }, 7707 "type": "object" 7708 }, 7709 "closed_at": { 7710 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 7711 "type": "string" 7712 }, 7713 "created_at": { 7714 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 7715 "type": "string" 7716 }, 7717 "updated_at": { 7718 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 7719 "type": "string" 7720 } 7721 }, 7722 "type": "object" 7723 } 7724 ] 7725 } 7726 example: | 7727 [ 7728 { 7729 "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", 7730 "html_url": "https://github.com/octocat/Hello-World/issues/1347", 7731 "number": 1347, 7732 "state": "open", 7733 "title": "Found a bug", 7734 "body": "I'm having a problem with this.", 7735 "user": { 7736 "login": "octocat", 7737 "id": 1, 7738 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 7739 "gravatar_id": "somehexcode", 7740 "url": "https://api.github.com/users/octocat" 7741 }, 7742 "labels": [ 7743 { 7744 "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", 7745 "name": "bug", 7746 "color": "f29513" 7747 } 7748 ], 7749 "assignee": { 7750 "login": "octocat", 7751 "id": 1, 7752 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 7753 "gravatar_id": "somehexcode", 7754 "url": "https://api.github.com/users/octocat" 7755 }, 7756 "milestone": { 7757 "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", 7758 "number": 1, 7759 "state": "open", 7760 "title": "v1.0", 7761 "description": "", 7762 "creator": { 7763 "login": "octocat", 7764 "id": 1, 7765 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 7766 "gravatar_id": "somehexcode", 7767 "url": "https://api.github.com/users/octocat" 7768 }, 7769 "open_issues": 4, 7770 "closed_issues": 8, 7771 "created_at": "2011-04-10T20:09:31Z", 7772 "due_on": null 7773 }, 7774 "comments": 0, 7775 "pull_request": { 7776 "html_url": "https://github.com/octocat/Hello-World/issues/1347", 7777 "diff_url": "https://github.com/octocat/Hello-World/issues/1347.diff", 7778 "patch_url": "https://github.com/octocat/Hello-World/issues/1347.patch" 7779 }, 7780 "closed_at": null, 7781 "created_at": "2011-04-22T13:33:48Z", 7782 "updated_at": "2011-04-22T13:33:48Z" 7783 } 7784 ] 7785 post: 7786 description: | 7787 Create an issue. 7788 Any user with pull access to a repository can create an issue. 7789 body: 7790 application/json: 7791 schema: | 7792 { 7793 "$schema": "http://json-schema.org/draft-03/schema", 7794 "type": "object", 7795 "properties": { 7796 "title": { 7797 "type": "string" 7798 }, 7799 "body": { 7800 "type": "string" 7801 }, 7802 "assignee": { 7803 "description": "Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise.", 7804 "type": "string" 7805 }, 7806 "milestone": { 7807 "description": "Milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.", 7808 "type": "integer" 7809 }, 7810 "labels": [ 7811 { 7812 "description": "Array of strings - Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.", 7813 "type": "string" 7814 } 7815 ], 7816 "type": "array" 7817 }, 7818 "required": [ "title" ] 7819 } 7820 responses: 7821 201: 7822 body: 7823 schema: | 7824 { 7825 "$schema": "http://json-schema.org/draft-03/schema", 7826 "type": "object", 7827 "properties": { 7828 "url": { 7829 "type": "string" 7830 }, 7831 "html_url": { 7832 "type": "string" 7833 }, 7834 "number": { 7835 "type": "integer" 7836 }, 7837 "state": { 7838 "enum": [ 7839 "open", 7840 "closed" 7841 ] 7842 }, 7843 "title": { 7844 "type": "string" 7845 }, 7846 "body": { 7847 "type": "string" 7848 }, 7849 "user": { 7850 "properties": { 7851 "login": { 7852 "type": "string" 7853 }, 7854 "id": { 7855 "type": "integer" 7856 }, 7857 "avatar_url": { 7858 "type": "string" 7859 }, 7860 "gravatar_id": { 7861 "type": "string" 7862 }, 7863 "url": { 7864 "type": "string" 7865 } 7866 }, 7867 "type": "object" 7868 }, 7869 "labels": [ 7870 { 7871 "properties": { 7872 "url": { 7873 "type": "string" 7874 }, 7875 "name": { 7876 "type": "string" 7877 }, 7878 "color": { 7879 "type": "string" 7880 } 7881 }, 7882 "type": "object" 7883 } 7884 ], 7885 "type": "array", 7886 "assignee": { 7887 "properties": { 7888 "login": { 7889 "type": "string" 7890 }, 7891 "id": { 7892 "type": "integer" 7893 }, 7894 "avatar_url": { 7895 "type": "string" 7896 }, 7897 "gravatar_id": { 7898 "type": "string" 7899 }, 7900 "url": { 7901 "type": "string" 7902 } 7903 }, 7904 "type": "object" 7905 }, 7906 "milestone": { 7907 "properties": { 7908 "url": { 7909 "type": "string" 7910 }, 7911 "number": { 7912 "type": "integer" 7913 }, 7914 "state": { 7915 "enum": [ 7916 "open", 7917 "closed" 7918 ] 7919 }, 7920 "title": { 7921 "type": "string" 7922 }, 7923 "description": { 7924 "type": "string" 7925 }, 7926 "creator": { 7927 "properties": { 7928 "login": { 7929 "type": "string" 7930 }, 7931 "id": { 7932 "type": "integer" 7933 }, 7934 "avatar_url": { 7935 "type": "string" 7936 }, 7937 "gravatar_id": { 7938 "type": "string" 7939 }, 7940 "url": { 7941 "type": "string" 7942 } 7943 }, 7944 "type": "object" 7945 }, 7946 "open_issues": { 7947 "type": "integer" 7948 }, 7949 "closed_issues": { 7950 "type": "integer" 7951 }, 7952 "created_at": { 7953 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 7954 "type": "string" 7955 }, 7956 "due_on": { 7957 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 7958 "type": "string" 7959 } 7960 }, 7961 "type": "object" 7962 }, 7963 "comments": { 7964 "type": "integer" 7965 }, 7966 "pull_request": { 7967 "properties": { 7968 "html_url": { 7969 "type": "string" 7970 }, 7971 "diff_url": { 7972 "type": "string" 7973 }, 7974 "patch_url": { 7975 "type": "string" 7976 } 7977 }, 7978 "type": "object" 7979 }, 7980 "closed_at": { 7981 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 7982 "type": "string" 7983 }, 7984 "created_at": { 7985 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 7986 "type": "string" 7987 }, 7988 "updated_at": { 7989 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 7990 "type": "string" 7991 } 7992 } 7993 } 7994 example: | 7995 { 7996 "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", 7997 "html_url": "https://github.com/octocat/Hello-World/issues/1347", 7998 "number": 1347, 7999 "state": "open", 8000 "title": "Found a bug", 8001 "body": "I'm having a problem with this.", 8002 "user": { 8003 "login": "octocat", 8004 "id": 1, 8005 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 8006 "gravatar_id": "somehexcode", 8007 "url": "https://api.github.com/users/octocat" 8008 }, 8009 "labels": [ 8010 { 8011 "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", 8012 "name": "bug", 8013 "color": "f29513" 8014 } 8015 ], 8016 "assignee": { 8017 "login": "octocat", 8018 "id": 1, 8019 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 8020 "gravatar_id": "somehexcode", 8021 "url": "https://api.github.com/users/octocat" 8022 }, 8023 "milestone": { 8024 "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", 8025 "number": 1, 8026 "state": "open", 8027 "title": "v1.0", 8028 "description": "", 8029 "creator": { 8030 "login": "octocat", 8031 "id": 1, 8032 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 8033 "gravatar_id": "somehexcode", 8034 "url": "https://api.github.com/users/octocat" 8035 }, 8036 "open_issues": 4, 8037 "closed_issues": 8, 8038 "created_at": "2011-04-10T20:09:31Z", 8039 "due_on": null 8040 }, 8041 "comments": 0, 8042 "pull_request": { 8043 "html_url": "https://github.com/octocat/Hello-World/issues/1347", 8044 "diff_url": "https://github.com/octocat/Hello-World/issues/1347.diff", 8045 "patch_url": "https://github.com/octocat/Hello-World/issues/1347.patch" 8046 }, 8047 "closed_at": null, 8048 "created_at": "2011-04-22T13:33:48Z", 8049 "updated_at": "2011-04-22T13:33:48Z" 8050 } 8051 /events: 8052 type: collection 8053 get: 8054 description: List issue events for a repository. 8055 responses: 8056 200: 8057 body: 8058 schema: | 8059 { 8060 "$schema": "http://json-schema.org/draft-03/schema", 8061 "type": "array", 8062 "properties": [ 8063 { 8064 "properties": { 8065 "type": { 8066 "type": "string" 8067 }, 8068 "public": { 8069 "type": "boolean" 8070 }, 8071 "payload": { 8072 "properties": {}, 8073 "type": "object" 8074 }, 8075 "repo": { 8076 "properties": { 8077 "id": { 8078 "type": "integer" 8079 }, 8080 "name": { 8081 "type": "string" 8082 }, 8083 "url": { 8084 "type": "string" 8085 } 8086 }, 8087 "type": "object" 8088 }, 8089 "actor": { 8090 "properties": { 8091 "login": { 8092 "type": "string" 8093 }, 8094 "id": { 8095 "type": "integer" 8096 }, 8097 "avatar_url": { 8098 "type": "string" 8099 }, 8100 "gravatar_id": { 8101 "type": "string" 8102 }, 8103 "url": { 8104 "type": "string" 8105 } 8106 }, 8107 "type": "object" 8108 }, 8109 "org": { 8110 "properties": { 8111 "login": { 8112 "type": "string" 8113 }, 8114 "id": { 8115 "type": "integer" 8116 }, 8117 "avatar_url": { 8118 "type": "string" 8119 }, 8120 "gravatar_id": { 8121 "type": "string" 8122 }, 8123 "url": { 8124 "type": "string" 8125 } 8126 }, 8127 "type": "object" 8128 }, 8129 "created_at": { 8130 "type": "timestamp" 8131 }, 8132 "id": { 8133 "type": "integer" 8134 } 8135 }, 8136 "type": "object" 8137 } 8138 ] 8139 } 8140 example: | 8141 [ 8142 { 8143 "type": "Event", 8144 "public": true, 8145 "payload": { 8146 8147 }, 8148 "repo": { 8149 "id": 3, 8150 "name": "octocat/Hello-World", 8151 "url": "https://api.github.com/repos/octocat/Hello-World" 8152 }, 8153 "actor": { 8154 "login": "octocat", 8155 "id": 1, 8156 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 8157 "gravatar_id": "somehexcode", 8158 "url": "https://api.github.com/users/octocat" 8159 }, 8160 "org": { 8161 "login": "octocat", 8162 "id": 1, 8163 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 8164 "gravatar_id": "somehexcode", 8165 "url": "https://api.github.com/users/octocat" 8166 }, 8167 "created_at": "2011-09-06T17:26:27Z", 8168 "id": "12345" 8169 } 8170 ] 8171 /{eventId}: 8172 uriParameters: 8173 eventId: 8174 description: Id of the event. 8175 type: integer 8176 type: item 8177 get: 8178 description: Get a single event. 8179 responses: 8180 200: 8181 body: 8182 schema: | 8183 { 8184 "$schema": "http://json-schema.org/draft-03/schema", 8185 "type": "object", 8186 "properties": { 8187 "url": { 8188 "type": "string" 8189 }, 8190 "actor": { 8191 "properties": { 8192 "login": { 8193 "type": "string" 8194 }, 8195 "id": { 8196 "type": "integer" 8197 }, 8198 "avatar_url": { 8199 "type": "string" 8200 }, 8201 "gravatar_id": { 8202 "type": "string" 8203 }, 8204 "url": { 8205 "type": "string" 8206 }, 8207 "type": "object" 8208 }, 8209 "event": { 8210 "type": "string" 8211 }, 8212 "commit_id": { 8213 "type": "string" 8214 }, 8215 "created_at": { 8216 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 8217 "type": "string" 8218 }, 8219 "issue": { 8220 "properties": { 8221 "url": { 8222 "type": "string" 8223 }, 8224 "html_url": { 8225 "type": "string" 8226 }, 8227 "number": { 8228 "type": "integer" 8229 }, 8230 "state": { 8231 "enum": [ 8232 "open", 8233 "closed" 8234 ] 8235 }, 8236 "title": { 8237 "type": "string" 8238 }, 8239 "body": { 8240 "type": "string" 8241 }, 8242 "user": { 8243 "properties": { 8244 "login": { 8245 "type": "string" 8246 }, 8247 "id": { 8248 "type": "integer" 8249 }, 8250 "avatar_url": { 8251 "type": "string" 8252 }, 8253 "gravatar_id": { 8254 "type": "string" 8255 }, 8256 "url": { 8257 "type": "string" 8258 } 8259 }, 8260 "type": "object" 8261 }, 8262 "labels": [ 8263 { 8264 "properties": { 8265 "url": { 8266 "type": "string" 8267 }, 8268 "name": { 8269 "type": "string" 8270 }, 8271 "color": { 8272 "type": "string" 8273 } 8274 }, 8275 "type": "object" 8276 } 8277 ], 8278 "type": "array", 8279 "assignee": { 8280 "login": { 8281 "type": "string" 8282 }, 8283 "id": { 8284 "type": "integer" 8285 }, 8286 "avatar_url": { 8287 "type": "string" 8288 }, 8289 "gravatar_id": { 8290 "type": "string" 8291 }, 8292 "url": { 8293 "type": "string" 8294 } 8295 }, 8296 "milestone": { 8297 "properties": { 8298 "url": { 8299 "type": "string" 8300 }, 8301 "number": { 8302 "type": "integer" 8303 }, 8304 "state": { 8305 "enum": [ 8306 "open", 8307 "closed" 8308 ] 8309 }, 8310 "title": { 8311 "type": "string" 8312 }, 8313 "description": { 8314 "type": "string" 8315 }, 8316 "creator": { 8317 "properties": { 8318 "login": { 8319 "type": "string" 8320 }, 8321 "id": { 8322 "type": "integer" 8323 }, 8324 "avatar_url": { 8325 "type": "string" 8326 }, 8327 "gravatar_id": { 8328 "type": "string" 8329 }, 8330 "url": { 8331 "type": "string" 8332 } 8333 }, 8334 "type": "object" 8335 }, 8336 "open_issues": { 8337 "type": "integer" 8338 }, 8339 "closed_issues": { 8340 "type": "integer" 8341 }, 8342 "created_at": { 8343 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 8344 "type": "string" 8345 }, 8346 "due_on": { 8347 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 8348 "type": "string" 8349 } 8350 }, 8351 "type": "object" 8352 }, 8353 "comments": { 8354 "type": "integer" 8355 }, 8356 "pull_request": { 8357 "properties": { 8358 "html_url": { 8359 "type": "string" 8360 }, 8361 "diff_url": { 8362 "type": "string" 8363 }, 8364 "patch_url": { 8365 "type": "string" 8366 } 8367 }, 8368 "type": "object" 8369 }, 8370 "closed_at": { 8371 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 8372 "type": "string" 8373 }, 8374 "created_at": { 8375 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 8376 "type": "string" 8377 }, 8378 "updated_at": { 8379 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 8380 "type": "string" 8381 } 8382 }, 8383 "type": "object" 8384 } 8385 }, 8386 "type": "object" 8387 } 8388 } 8389 example: | 8390 { 8391 "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", 8392 "actor": { 8393 "login": "octocat", 8394 "id": 1, 8395 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 8396 "gravatar_id": "somehexcode", 8397 "url": "https://api.github.com/users/octocat" 8398 }, 8399 "event": "closed", 8400 "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 8401 "created_at": "2011-04-14T16:00:49Z", 8402 "issue": { 8403 "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", 8404 "html_url": "https://github.com/octocat/Hello-World/issues/1347", 8405 "number": 1347, 8406 "state": "open", 8407 "title": "Found a bug", 8408 "body": "I'm having a problem with this.", 8409 "user": { 8410 "login": "octocat", 8411 "id": 1, 8412 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 8413 "gravatar_id": "somehexcode", 8414 "url": "https://api.github.com/users/octocat" 8415 }, 8416 "labels": [ 8417 { 8418 "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", 8419 "name": "bug", 8420 "color": "f29513" 8421 } 8422 ], 8423 "assignee": { 8424 "login": "octocat", 8425 "id": 1, 8426 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 8427 "gravatar_id": "somehexcode", 8428 "url": "https://api.github.com/users/octocat" 8429 }, 8430 "milestone": { 8431 "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", 8432 "number": 1, 8433 "state": "open", 8434 "title": "v1.0", 8435 "description": "", 8436 "creator": { 8437 "login": "octocat", 8438 "id": 1, 8439 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 8440 "gravatar_id": "somehexcode", 8441 "url": "https://api.github.com/users/octocat" 8442 }, 8443 "open_issues": 4, 8444 "closed_issues": 8, 8445 "created_at": "2011-04-10T20:09:31Z", 8446 "due_on": null 8447 }, 8448 "comments": 0, 8449 "pull_request": { 8450 "html_url": "https://github.com/octocat/Hello-World/issues/1347", 8451 "diff_url": "https://github.com/octocat/Hello-World/issues/1347.diff", 8452 "patch_url": "https://github.com/octocat/Hello-World/issues/1347.patch" 8453 }, 8454 "closed_at": null, 8455 "created_at": "2011-04-22T13:33:48Z", 8456 "updated_at": "2011-04-22T13:33:48Z" 8457 } 8458 } 8459 /{number}: 8460 uriParameters: 8461 number: 8462 description: Id of the issue. 8463 type: integer 8464 type: item 8465 get: 8466 description: Get a single issue 8467 responses: 8468 200: 8469 body: 8470 schema: | 8471 { 8472 "$schema": "http://json-schema.org/draft-03/schema", 8473 "type": "object", 8474 "properties": { 8475 "url": { 8476 "type": "string" 8477 }, 8478 "html_url": { 8479 "type": "string" 8480 }, 8481 "number": { 8482 "type": "integer" 8483 }, 8484 "state": { 8485 "enum": [ 8486 "open", 8487 "closed" 8488 ] 8489 }, 8490 "title": { 8491 "type": "string" 8492 }, 8493 "body": { 8494 "type": "string" 8495 }, 8496 "user": { 8497 "properties": { 8498 "login": { 8499 "type": "string" 8500 }, 8501 "id": { 8502 "type": "integer" 8503 }, 8504 "avatar_url": { 8505 "type": "string" 8506 }, 8507 "gravatar_id": { 8508 "type": "string" 8509 }, 8510 "url": { 8511 "type": "string" 8512 } 8513 }, 8514 "type": "object" 8515 }, 8516 "labels": [ 8517 { 8518 "properties": { 8519 "url": { 8520 "type": "string" 8521 }, 8522 "name": { 8523 "type": "string" 8524 }, 8525 "color": { 8526 "type": "string" 8527 } 8528 }, 8529 "type": "object" 8530 } 8531 ], 8532 "type": "array", 8533 "assignee": { 8534 "properties": { 8535 "login": { 8536 "type": "string" 8537 }, 8538 "id": { 8539 "type": "integer" 8540 }, 8541 "avatar_url": { 8542 "type": "string" 8543 }, 8544 "gravatar_id": { 8545 "type": "string" 8546 }, 8547 "url": { 8548 "type": "string" 8549 } 8550 }, 8551 "type": "object" 8552 }, 8553 "milestone": { 8554 "properties": { 8555 "url": { 8556 "type": "string" 8557 }, 8558 "number": { 8559 "type": "integer" 8560 }, 8561 "state": { 8562 "enum": [ 8563 "open", 8564 "closed" 8565 ] 8566 }, 8567 "title": { 8568 "type": "string" 8569 }, 8570 "description": { 8571 "type": "string" 8572 }, 8573 "creator": { 8574 "properties": { 8575 "login": { 8576 "type": "string" 8577 }, 8578 "id": { 8579 "type": "integer" 8580 }, 8581 "avatar_url": { 8582 "type": "string" 8583 }, 8584 "gravatar_id": { 8585 "type": "string" 8586 }, 8587 "url": { 8588 "type": "string" 8589 } 8590 }, 8591 "type": "object" 8592 }, 8593 "open_issues": { 8594 "type": "integer" 8595 }, 8596 "closed_issues": { 8597 "type": "integer" 8598 }, 8599 "created_at": { 8600 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 8601 "type": "string" 8602 }, 8603 "due_on": { 8604 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 8605 "type": "string" 8606 } 8607 }, 8608 "type": "object" 8609 }, 8610 "comments": { 8611 "type": "integer" 8612 }, 8613 "pull_request": { 8614 "properties": { 8615 "html_url": { 8616 "type": "string" 8617 }, 8618 "diff_url": { 8619 "type": "string" 8620 }, 8621 "patch_url": { 8622 "type": "string" 8623 } 8624 }, 8625 "type": "object" 8626 }, 8627 "closed_at": { 8628 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 8629 "type": "string" 8630 }, 8631 "created_at": { 8632 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 8633 "type": "string" 8634 }, 8635 "updated_at": { 8636 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 8637 "type": "string" 8638 } 8639 } 8640 } 8641 example: | 8642 { 8643 "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", 8644 "html_url": "https://github.com/octocat/Hello-World/issues/1347", 8645 "number": 1347, 8646 "state": "open", 8647 "title": "Found a bug", 8648 "body": "I'm having a problem with this.", 8649 "user": { 8650 "login": "octocat", 8651 "id": 1, 8652 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 8653 "gravatar_id": "somehexcode", 8654 "url": "https://api.github.com/users/octocat" 8655 }, 8656 "labels": [ 8657 { 8658 "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", 8659 "name": "bug", 8660 "color": "f29513" 8661 } 8662 ], 8663 "assignee": { 8664 "login": "octocat", 8665 "id": 1, 8666 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 8667 "gravatar_id": "somehexcode", 8668 "url": "https://api.github.com/users/octocat" 8669 }, 8670 "milestone": { 8671 "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", 8672 "number": 1, 8673 "state": "open", 8674 "title": "v1.0", 8675 "description": "", 8676 "creator": { 8677 "login": "octocat", 8678 "id": 1, 8679 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 8680 "gravatar_id": "somehexcode", 8681 "url": "https://api.github.com/users/octocat" 8682 }, 8683 "open_issues": 4, 8684 "closed_issues": 8, 8685 "created_at": "2011-04-10T20:09:31Z", 8686 "due_on": null 8687 }, 8688 "comments": 0, 8689 "pull_request": { 8690 "html_url": "https://github.com/octocat/Hello-World/issues/1347", 8691 "diff_url": "https://github.com/octocat/Hello-World/issues/1347.diff", 8692 "patch_url": "https://github.com/octocat/Hello-World/issues/1347.patch" 8693 }, 8694 "closed_at": null, 8695 "created_at": "2011-04-22T13:33:48Z", 8696 "updated_at": "2011-04-22T13:33:48Z" 8697 } 8698 patch: 8699 description: | 8700 Edit an issue. 8701 Issue owners and users with push access can edit an issue. 8702 body: 8703 application/json: 8704 schema: | 8705 { 8706 "$schema": "http://json-schema.org/draft-03/schema", 8707 "type": "object", 8708 "properties": { 8709 "url": { 8710 "type": "string" 8711 }, 8712 "html_url": { 8713 "type": "string" 8714 }, 8715 "number": { 8716 "type": "integer" 8717 }, 8718 "state": { 8719 "enum": [ 8720 "open", 8721 "closed" 8722 ] 8723 }, 8724 "title": { 8725 "type": "string" 8726 }, 8727 "body": { 8728 "type": "string" 8729 }, 8730 "user": { 8731 "properties": { 8732 "login": { 8733 "type": "string" 8734 }, 8735 "id": { 8736 "type": "integer" 8737 }, 8738 "avatar_url": { 8739 "type": "string" 8740 }, 8741 "gravatar_id": { 8742 "type": "string" 8743 }, 8744 "url": { 8745 "type": "string" 8746 } 8747 }, 8748 "type": "object" 8749 }, 8750 "labels": [ 8751 { 8752 "properties": { 8753 "url": { 8754 "type": "string" 8755 }, 8756 "name": { 8757 "type": "string" 8758 }, 8759 "color": { 8760 "type": "string" 8761 } 8762 }, 8763 "type": "object" 8764 } 8765 ], 8766 "type": "array", 8767 "assignee": { 8768 "properties": { 8769 "login": { 8770 "type": "string" 8771 }, 8772 "id": { 8773 "type": "integer" 8774 }, 8775 "avatar_url": { 8776 "type": "string" 8777 }, 8778 "gravatar_id": { 8779 "type": "string" 8780 }, 8781 "url": { 8782 "type": "string" 8783 } 8784 }, 8785 "type": "object" 8786 }, 8787 "milestone": { 8788 "properties": { 8789 "url": { 8790 "type": "string" 8791 }, 8792 "number": { 8793 "type": "integer" 8794 }, 8795 "state": { 8796 "enum": [ 8797 "open", 8798 "closed" 8799 ] 8800 }, 8801 "title": { 8802 "type": "string" 8803 }, 8804 "description": { 8805 "type": "string" 8806 }, 8807 "creator": { 8808 "properties": { 8809 "login": { 8810 "type": "string" 8811 }, 8812 "id": { 8813 "type": "integer" 8814 }, 8815 "avatar_url": { 8816 "type": "string" 8817 }, 8818 "gravatar_id": { 8819 "type": "string" 8820 }, 8821 "url": { 8822 "type": "string" 8823 } 8824 }, 8825 "type": "object" 8826 }, 8827 "open_issues": { 8828 "type": "integer" 8829 }, 8830 "closed_issues": { 8831 "type": "integer" 8832 }, 8833 "created_at": { 8834 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 8835 "type": "string" 8836 }, 8837 "due_on": { 8838 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 8839 "type": "string" 8840 } 8841 }, 8842 "type": "object" 8843 }, 8844 "comments": { 8845 "type": "integer" 8846 }, 8847 "pull_request": { 8848 "properties": { 8849 "html_url": { 8850 "type": "string" 8851 }, 8852 "diff_url": { 8853 "type": "string" 8854 }, 8855 "patch_url": { 8856 "type": "string" 8857 } 8858 }, 8859 "type": "object" 8860 }, 8861 "closed_at": { 8862 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 8863 "type": "string" 8864 }, 8865 "created_at": { 8866 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 8867 "type": "string" 8868 }, 8869 "updated_at": { 8870 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 8871 "type": "string" 8872 } 8873 } 8874 } 8875 responses: 8876 200: 8877 body: 8878 schema: | 8879 { 8880 "$schema": "http://json-schema.org/draft-03/schema", 8881 "type": "object", 8882 "properties": { 8883 "url": { 8884 "type": "string" 8885 }, 8886 "html_url": { 8887 "type": "string" 8888 }, 8889 "number": { 8890 "type": "integer" 8891 }, 8892 "state": { 8893 "enum": [ 8894 "open", 8895 "closed" 8896 ] 8897 }, 8898 "title": { 8899 "type": "string" 8900 }, 8901 "body": { 8902 "type": "string" 8903 }, 8904 "user": { 8905 "properties": { 8906 "login": { 8907 "type": "string" 8908 }, 8909 "id": { 8910 "type": "integer" 8911 }, 8912 "avatar_url": { 8913 "type": "string" 8914 }, 8915 "gravatar_id": { 8916 "type": "string" 8917 }, 8918 "url": { 8919 "type": "string" 8920 } 8921 }, 8922 "type": "object" 8923 }, 8924 "labels": [ 8925 { 8926 "properties": { 8927 "url": { 8928 "type": "string" 8929 }, 8930 "name": { 8931 "type": "string" 8932 }, 8933 "color": { 8934 "type": "string" 8935 } 8936 }, 8937 "type": "object" 8938 } 8939 ], 8940 "type": "array", 8941 "assignee": { 8942 "properties": { 8943 "login": { 8944 "type": "string" 8945 }, 8946 "id": { 8947 "type": "integer" 8948 }, 8949 "avatar_url": { 8950 "type": "string" 8951 }, 8952 "gravatar_id": { 8953 "type": "string" 8954 }, 8955 "url": { 8956 "type": "string" 8957 } 8958 }, 8959 "type": "object" 8960 }, 8961 "milestone": { 8962 "properties": { 8963 "url": { 8964 "type": "string" 8965 }, 8966 "number": { 8967 "type": "integer" 8968 }, 8969 "state": { 8970 "enum": [ 8971 "open", 8972 "closed" 8973 ] 8974 }, 8975 "title": { 8976 "type": "string" 8977 }, 8978 "description": { 8979 "type": "string" 8980 }, 8981 "creator": { 8982 "properties": { 8983 "login": { 8984 "type": "string" 8985 }, 8986 "id": { 8987 "type": "integer" 8988 }, 8989 "avatar_url": { 8990 "type": "string" 8991 }, 8992 "gravatar_id": { 8993 "type": "string" 8994 }, 8995 "url": { 8996 "type": "string" 8997 } 8998 }, 8999 "type": "object" 9000 }, 9001 "open_issues": { 9002 "type": "integer" 9003 }, 9004 "closed_issues": { 9005 "type": "integer" 9006 }, 9007 "created_at": { 9008 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 9009 "type": "string" 9010 }, 9011 "due_on": { 9012 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 9013 "type": "string" 9014 } 9015 }, 9016 "type": "object" 9017 }, 9018 "comments": { 9019 "type": "integer" 9020 }, 9021 "pull_request": { 9022 "properties": { 9023 "html_url": { 9024 "type": "string" 9025 }, 9026 "diff_url": { 9027 "type": "string" 9028 }, 9029 "patch_url": { 9030 "type": "string" 9031 } 9032 }, 9033 "type": "object" 9034 }, 9035 "closed_at": { 9036 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 9037 "type": "string" 9038 }, 9039 "created_at": { 9040 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 9041 "type": "string" 9042 }, 9043 "updated_at": { 9044 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 9045 "type": "string" 9046 } 9047 } 9048 } 9049 example: | 9050 { 9051 "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", 9052 "html_url": "https://github.com/octocat/Hello-World/issues/1347", 9053 "number": 1347, 9054 "state": "open", 9055 "title": "Found a bug", 9056 "body": "I'm having a problem with this.", 9057 "user": { 9058 "login": "octocat", 9059 "id": 1, 9060 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 9061 "gravatar_id": "somehexcode", 9062 "url": "https://api.github.com/users/octocat" 9063 }, 9064 "labels": [ 9065 { 9066 "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", 9067 "name": "bug", 9068 "color": "f29513" 9069 } 9070 ], 9071 "assignee": { 9072 "login": "octocat", 9073 "id": 1, 9074 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 9075 "gravatar_id": "somehexcode", 9076 "url": "https://api.github.com/users/octocat" 9077 }, 9078 "milestone": { 9079 "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", 9080 "number": 1, 9081 "state": "open", 9082 "title": "v1.0", 9083 "description": "", 9084 "creator": { 9085 "login": "octocat", 9086 "id": 1, 9087 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 9088 "gravatar_id": "somehexcode", 9089 "url": "https://api.github.com/users/octocat" 9090 }, 9091 "open_issues": 4, 9092 "closed_issues": 8, 9093 "created_at": "2011-04-10T20:09:31Z", 9094 "due_on": null 9095 }, 9096 "comments": 0, 9097 "pull_request": { 9098 "html_url": "https://github.com/octocat/Hello-World/issues/1347", 9099 "diff_url": "https://github.com/octocat/Hello-World/issues/1347.diff", 9100 "patch_url": "https://github.com/octocat/Hello-World/issues/1347.patch" 9101 }, 9102 "closed_at": null, 9103 "created_at": "2011-04-22T13:33:48Z", 9104 "updated_at": "2011-04-22T13:33:48Z" 9105 } 9106 # Comments 9107 /comments: 9108 type: collection 9109 get: 9110 description: List comments on an issue. 9111 responses: 9112 200: 9113 body: 9114 schema: | 9115 { 9116 "$schema": "http://json-schema.org/draft-03/schema", 9117 "type": "array", 9118 "list": [ 9119 { 9120 "properties": { 9121 "url": { 9122 "type": "string" 9123 }, 9124 "id": { 9125 "type": "integer" 9126 }, 9127 "body": { 9128 "type": "string" 9129 }, 9130 "path": { 9131 "type": "string" 9132 }, 9133 "position": { 9134 "type": "integer" 9135 }, 9136 "commit_id": { 9137 "type": "string" 9138 }, 9139 "user": { 9140 "properties": { 9141 "login": { 9142 "type": "string" 9143 }, 9144 "id": { 9145 "type": "integer" 9146 }, 9147 "avatar_url": { 9148 "type": "string" 9149 }, 9150 "gravatar_id": { 9151 "type": "string" 9152 }, 9153 "url": { 9154 "type": "string" 9155 } 9156 }, 9157 "type": "object" 9158 }, 9159 "created_at": { 9160 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 9161 "type": "string" 9162 }, 9163 "updated_at": { 9164 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 9165 "type": "string" 9166 }, 9167 "_links": { 9168 "properties": { 9169 "self": { 9170 "properties": { 9171 "href": { 9172 "type": "string" 9173 } 9174 }, 9175 "type": "object" 9176 }, 9177 "html": { 9178 "properties": { 9179 "href": { 9180 "type": "string" 9181 } 9182 }, 9183 "type": "object" 9184 }, 9185 "pull_request": { 9186 "properties": { 9187 "href": { 9188 "type": "string" 9189 } 9190 }, 9191 "type": "object" 9192 } 9193 }, 9194 "type": "object" 9195 } 9196 }, 9197 "type": "object" 9198 } 9199 ] 9200 } 9201 example: | 9202 [ 9203 { 9204 "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", 9205 "id": 1, 9206 "body": "Great stuff", 9207 "path": "file1.txt", 9208 "position": 4, 9209 "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 9210 "user": { 9211 "login": "octocat", 9212 "id": 1, 9213 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 9214 "gravatar_id": "somehexcode", 9215 "url": "https://api.github.com/users/octocat" 9216 }, 9217 "created_at": "2011-04-14T16:00:49Z", 9218 "updated_at": "2011-04-14T16:00:49Z", 9219 "_links": { 9220 "self": { 9221 "href": "https://api.github.com/octocat/Hello-World/pulls/comments/1" 9222 }, 9223 "html": { 9224 "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" 9225 }, 9226 "pull_request": { 9227 "href": "https://api.github.com/octocat/Hello-World/pulls/1" 9228 } 9229 } 9230 } 9231 ] 9232 post: 9233 description: Create a comment. 9234 body: 9235 application/json: 9236 schema: | 9237 { 9238 "$schema": "http://json-schema.org/draft-03/schema", 9239 "type": "object", 9240 "properties": { 9241 "body": { 9242 "type": "string" 9243 } 9244 }, 9245 "required": [ "body" ] 9246 } 9247 responses: 9248 201: 9249 body: 9250 schema: | 9251 { 9252 "$schema": "http://json-schema.org/draft-03/schema", 9253 "type": "object", 9254 "properties": { 9255 "id": { 9256 "type": "integer" 9257 }, 9258 "url": { 9259 "type": "string" 9260 }, 9261 "html_url": { 9262 "type": "string" 9263 }, 9264 "body": { 9265 "type": "string" 9266 }, 9267 "user": { 9268 "properties": { 9269 "login": { 9270 "type": "string" 9271 }, 9272 "id": { 9273 "type": "integer" 9274 }, 9275 "avatar_url": { 9276 "type": "string" 9277 }, 9278 "gravatar_id": { 9279 "type": "string" 9280 }, 9281 "url": { 9282 "type": "string" 9283 } 9284 }, 9285 "type": "object" 9286 }, 9287 "created_at": { 9288 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 9289 "type": "string" 9290 }, 9291 "updated_at": { 9292 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 9293 "type": "string" 9294 } 9295 } 9296 } 9297 example: | 9298 { 9299 "id": 1, 9300 "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", 9301 "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", 9302 "body": "Me too", 9303 "user": { 9304 "login": "octocat", 9305 "id": 1, 9306 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 9307 "gravatar_id": "somehexcode", 9308 "url": "https://api.github.com/users/octocat" 9309 }, 9310 "created_at": "2011-04-14T16:00:49Z", 9311 "updated_at": "2011-04-14T16:00:49Z" 9312 } 9313 # Events 9314 /events: 9315 type: collection 9316 get: 9317 description: List issue events for a repository. 9318 responses: 9319 200: 9320 body: 9321 schema: | 9322 { 9323 "$schema": "http://json-schema.org/draft-03/schema", 9324 "type": "array", 9325 "properties": [ 9326 { 9327 "properties": { 9328 "type": { 9329 "type": "string" 9330 }, 9331 "public": { 9332 "type": "boolean" 9333 }, 9334 "payload": { 9335 "properties": {}, 9336 "type": "object" 9337 }, 9338 "repo": { 9339 "properties": { 9340 "id": { 9341 "type": "integer" 9342 }, 9343 "name": { 9344 "type": "string" 9345 }, 9346 "url": { 9347 "type": "string" 9348 } 9349 }, 9350 "type": "object" 9351 }, 9352 "actor": { 9353 "properties": { 9354 "login": { 9355 "type": "string" 9356 }, 9357 "id": { 9358 "type": "integer" 9359 }, 9360 "avatar_url": { 9361 "type": "string" 9362 }, 9363 "gravatar_id": { 9364 "type": "string" 9365 }, 9366 "url": { 9367 "type": "string" 9368 } 9369 }, 9370 "type": "object" 9371 }, 9372 "org": { 9373 "properties": { 9374 "login": { 9375 "type": "string" 9376 }, 9377 "id": { 9378 "type": "integer" 9379 }, 9380 "avatar_url": { 9381 "type": "string" 9382 }, 9383 "gravatar_id": { 9384 "type": "string" 9385 }, 9386 "url": { 9387 "type": "string" 9388 } 9389 }, 9390 "type": "object" 9391 }, 9392 "created_at": { 9393 "type": "timestamp" 9394 }, 9395 "id": { 9396 "type": "integer" 9397 } 9398 }, 9399 "type": "object" 9400 } 9401 ] 9402 } 9403 example: | 9404 [ 9405 { 9406 "type": "Event", 9407 "public": true, 9408 "payload": { 9409 9410 }, 9411 "repo": { 9412 "id": 3, 9413 "name": "octocat/Hello-World", 9414 "url": "https://api.github.com/repos/octocat/Hello-World" 9415 }, 9416 "actor": { 9417 "login": "octocat", 9418 "id": 1, 9419 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 9420 "gravatar_id": "somehexcode", 9421 "url": "https://api.github.com/users/octocat" 9422 }, 9423 "org": { 9424 "login": "octocat", 9425 "id": 1, 9426 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 9427 "gravatar_id": "somehexcode", 9428 "url": "https://api.github.com/users/octocat" 9429 }, 9430 "created_at": "2011-09-06T17:26:27Z", 9431 "id": "12345" 9432 } 9433 ] 9434 /{eventId}: 9435 uriParameters: 9436 eventId: 9437 description: Id of the event. 9438 type: integer 9439 type: item 9440 get: 9441 description: Get a single event. 9442 responses: 9443 200: 9444 body: 9445 schema: | 9446 { 9447 "$schema": "http://json-schema.org/draft-03/schema", 9448 "type": "object", 9449 "properties": { 9450 "url": { 9451 "type": "string" 9452 }, 9453 "actor": { 9454 "properties": { 9455 "login": { 9456 "type": "string" 9457 }, 9458 "id": { 9459 "type": "integer" 9460 }, 9461 "avatar_url": { 9462 "type": "string" 9463 }, 9464 "gravatar_id": { 9465 "type": "string" 9466 }, 9467 "url": { 9468 "type": "string" 9469 }, 9470 "type": "object" 9471 }, 9472 "event": { 9473 "type": "string" 9474 }, 9475 "commit_id": { 9476 "type": "string" 9477 }, 9478 "created_at": { 9479 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 9480 "type": "string" 9481 }, 9482 "issue": { 9483 "properties": { 9484 "url": { 9485 "type": "string" 9486 }, 9487 "html_url": { 9488 "type": "string" 9489 }, 9490 "number": { 9491 "type": "integer" 9492 }, 9493 "state": { 9494 "enum": [ 9495 "open", 9496 "closed" 9497 ] 9498 }, 9499 "title": { 9500 "type": "string" 9501 }, 9502 "body": { 9503 "type": "string" 9504 }, 9505 "user": { 9506 "properties": { 9507 "login": { 9508 "type": "string" 9509 }, 9510 "id": { 9511 "type": "integer" 9512 }, 9513 "avatar_url": { 9514 "type": "string" 9515 }, 9516 "gravatar_id": { 9517 "type": "string" 9518 }, 9519 "url": { 9520 "type": "string" 9521 } 9522 }, 9523 "type": "object" 9524 }, 9525 "labels": [ 9526 { 9527 "properties": { 9528 "url": { 9529 "type": "string" 9530 }, 9531 "name": { 9532 "type": "string" 9533 }, 9534 "color": { 9535 "type": "string" 9536 } 9537 }, 9538 "type": "object" 9539 } 9540 ], 9541 "type": "array", 9542 "assignee": { 9543 "login": { 9544 "type": "string" 9545 }, 9546 "id": { 9547 "type": "integer" 9548 }, 9549 "avatar_url": { 9550 "type": "string" 9551 }, 9552 "gravatar_id": { 9553 "type": "string" 9554 }, 9555 "url": { 9556 "type": "string" 9557 } 9558 }, 9559 "milestone": { 9560 "properties": { 9561 "url": { 9562 "type": "string" 9563 }, 9564 "number": { 9565 "type": "integer" 9566 }, 9567 "state": { 9568 "enum": [ 9569 "open", 9570 "closed" 9571 ] 9572 }, 9573 "title": { 9574 "type": "string" 9575 }, 9576 "description": { 9577 "type": "string" 9578 }, 9579 "creator": { 9580 "properties": { 9581 "login": { 9582 "type": "string" 9583 }, 9584 "id": { 9585 "type": "integer" 9586 }, 9587 "avatar_url": { 9588 "type": "string" 9589 }, 9590 "gravatar_id": { 9591 "type": "string" 9592 }, 9593 "url": { 9594 "type": "string" 9595 } 9596 }, 9597 "type": "object" 9598 }, 9599 "open_issues": { 9600 "type": "integer" 9601 }, 9602 "closed_issues": { 9603 "type": "integer" 9604 }, 9605 "created_at": { 9606 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 9607 "type": "string" 9608 }, 9609 "due_on": { 9610 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 9611 "type": "string" 9612 } 9613 }, 9614 "type": "object" 9615 }, 9616 "comments": { 9617 "type": "integer" 9618 }, 9619 "pull_request": { 9620 "properties": { 9621 "html_url": { 9622 "type": "string" 9623 }, 9624 "diff_url": { 9625 "type": "string" 9626 }, 9627 "patch_url": { 9628 "type": "string" 9629 } 9630 }, 9631 "type": "object" 9632 }, 9633 "closed_at": { 9634 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 9635 "type": "string" 9636 }, 9637 "created_at": { 9638 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 9639 "type": "string" 9640 }, 9641 "updated_at": { 9642 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 9643 "type": "string" 9644 } 9645 }, 9646 "type": "object" 9647 } 9648 }, 9649 "type": "object" 9650 } 9651 } 9652 example: | 9653 { 9654 "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", 9655 "actor": { 9656 "login": "octocat", 9657 "id": 1, 9658 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 9659 "gravatar_id": "somehexcode", 9660 "url": "https://api.github.com/users/octocat" 9661 }, 9662 "event": "closed", 9663 "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 9664 "created_at": "2011-04-14T16:00:49Z", 9665 "issue": { 9666 "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", 9667 "html_url": "https://github.com/octocat/Hello-World/issues/1347", 9668 "number": 1347, 9669 "state": "open", 9670 "title": "Found a bug", 9671 "body": "I'm having a problem with this.", 9672 "user": { 9673 "login": "octocat", 9674 "id": 1, 9675 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 9676 "gravatar_id": "somehexcode", 9677 "url": "https://api.github.com/users/octocat" 9678 }, 9679 "labels": [ 9680 { 9681 "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", 9682 "name": "bug", 9683 "color": "f29513" 9684 } 9685 ], 9686 "assignee": { 9687 "login": "octocat", 9688 "id": 1, 9689 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 9690 "gravatar_id": "somehexcode", 9691 "url": "https://api.github.com/users/octocat" 9692 }, 9693 "milestone": { 9694 "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", 9695 "number": 1, 9696 "state": "open", 9697 "title": "v1.0", 9698 "description": "", 9699 "creator": { 9700 "login": "octocat", 9701 "id": 1, 9702 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 9703 "gravatar_id": "somehexcode", 9704 "url": "https://api.github.com/users/octocat" 9705 }, 9706 "open_issues": 4, 9707 "closed_issues": 8, 9708 "created_at": "2011-04-10T20:09:31Z", 9709 "due_on": null 9710 }, 9711 "comments": 0, 9712 "pull_request": { 9713 "html_url": "https://github.com/octocat/Hello-World/issues/1347", 9714 "diff_url": "https://github.com/octocat/Hello-World/issues/1347.diff", 9715 "patch_url": "https://github.com/octocat/Hello-World/issues/1347.patch" 9716 }, 9717 "closed_at": null, 9718 "created_at": "2011-04-22T13:33:48Z", 9719 "updated_at": "2011-04-22T13:33:48Z" 9720 } 9721 } 9722 # Labels 9723 /labels: 9724 type: collection 9725 get: 9726 description: List labels on an issue. 9727 responses: 9728 200: 9729 body: 9730 schema: | 9731 { 9732 "$schema": "http://json-schema.org/draft-03/schema", 9733 "type": "array", 9734 "list": [ 9735 { 9736 "properties": { 9737 "url": { 9738 "type": "string" 9739 }, 9740 "name": { 9741 "type": "string" 9742 }, 9743 "color": { 9744 "type": "string", 9745 "maxLength": 6, 9746 "minLength": 6 9747 } 9748 }, 9749 "type": "object" 9750 } 9751 ] 9752 } 9753 example: | 9754 [ 9755 { 9756 "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", 9757 "name": "bug", 9758 "color": "f29513" 9759 } 9760 ] 9761 post: 9762 description: Add labels to an issue. 9763 body: 9764 application/json: 9765 schema: | 9766 { 9767 "$schema": "http://json-schema.org/draft-03/schema", 9768 "type": "object", 9769 "properties": { 9770 "name": { 9771 "type": "string" 9772 }, 9773 "color": { 9774 "description": "6 character hex code, without a leading #.", 9775 "type": "string", 9776 "minLength": 6, 9777 "maxLength": 6 9778 } 9779 }, 9780 "required": [ "name", "color" ] 9781 } 9782 responses: 9783 201: 9784 body: 9785 schema: | 9786 { 9787 "$schema": "http://json-schema.org/draft-03/schema", 9788 "type": "object", 9789 "properties": { 9790 "url": { 9791 "type": "string" 9792 }, 9793 "name": { 9794 "type": "string" 9795 }, 9796 "color": { 9797 "type": "string", 9798 "maxLength": 6, 9799 "minLength": 6 9800 } 9801 } 9802 } 9803 example: | 9804 { 9805 "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", 9806 "name": "bug", 9807 "color": "f29513" 9808 } 9809 put: 9810 description: | 9811 Replace all labels for an issue. 9812 Sending an empty array ([]) will remove all Labels from the Issue. 9813 body: 9814 application/json: 9815 schema: | 9816 { 9817 "$schema": "http://json-schema.org/draft-03/schema", 9818 "type": "object", 9819 "properties": { 9820 "name": { 9821 "type": "string" 9822 }, 9823 "color": { 9824 "description": "6 character hex code, without a leading #.", 9825 "type": "string", 9826 "minLength": 6, 9827 "maxLength": 6 9828 } 9829 }, 9830 "required": [ "name", "color" ] 9831 } 9832 responses: 9833 201: 9834 body: 9835 schema: | 9836 { 9837 "$schema": "http://json-schema.org/draft-03/schema", 9838 "type": "object", 9839 "properties": { 9840 "url": { 9841 "type": "string" 9842 }, 9843 "name": { 9844 "type": "string" 9845 }, 9846 "color": { 9847 "type": "string", 9848 "maxLength": 6, 9849 "minLength": 6 9850 } 9851 } 9852 } 9853 example: | 9854 { 9855 "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", 9856 "name": "bug", 9857 "color": "f29513" 9858 } 9859 delete: 9860 description: Remove all labels from an issue. 9861 /{name}: 9862 uriParameters: 9863 name: 9864 description: Name of the label. 9865 type: string 9866 type: base 9867 delete: 9868 description: Remove a label from an issue. 9869 responses: 9870 204: 9871 description: Item removed. 9872 /comments: 9873 type: collection 9874 get: 9875 description: List comments in a repository. 9876 queryParameters: 9877 sort: 9878 enum: 9879 - created 9880 - updated 9881 direction: 9882 description: Ignored without sort parameter. 9883 enum: 9884 - asc 9885 - desc 9886 since: 9887 description: Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ. 9888 type: string 9889 responses: 9890 200: 9891 body: 9892 schema: | 9893 { 9894 "$schema": "http://json-schema.org/draft-03/schema", 9895 "type": "array", 9896 "list": [ 9897 { 9898 "properties": { 9899 "url": { 9900 "type": "string" 9901 }, 9902 "id": { 9903 "type": "integer" 9904 }, 9905 "body": { 9906 "type": "string" 9907 }, 9908 "path": { 9909 "type": "string" 9910 }, 9911 "position": { 9912 "type": "integer" 9913 }, 9914 "commit_id": { 9915 "type": "string" 9916 }, 9917 "user": { 9918 "properties": { 9919 "login": { 9920 "type": "string" 9921 }, 9922 "id": { 9923 "type": "integer" 9924 }, 9925 "avatar_url": { 9926 "type": "string" 9927 }, 9928 "gravatar_id": { 9929 "type": "string" 9930 }, 9931 "url": { 9932 "type": "string" 9933 } 9934 }, 9935 "type": "object" 9936 }, 9937 "created_at": { 9938 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 9939 "type": "string" 9940 }, 9941 "updated_at": { 9942 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 9943 "type": "string" 9944 }, 9945 "_links": { 9946 "properties": { 9947 "self": { 9948 "properties": { 9949 "href": { 9950 "type": "string" 9951 } 9952 }, 9953 "type": "object" 9954 }, 9955 "html": { 9956 "properties": { 9957 "href": { 9958 "type": "string" 9959 } 9960 }, 9961 "type": "object" 9962 }, 9963 "pull_request": { 9964 "properties": { 9965 "href": { 9966 "type": "string" 9967 } 9968 }, 9969 "type": "object" 9970 } 9971 }, 9972 "type": "object" 9973 } 9974 }, 9975 "type": "object" 9976 } 9977 ] 9978 } 9979 example: | 9980 [ 9981 { 9982 "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", 9983 "id": 1, 9984 "body": "Great stuff", 9985 "path": "file1.txt", 9986 "position": 4, 9987 "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 9988 "user": { 9989 "login": "octocat", 9990 "id": 1, 9991 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 9992 "gravatar_id": "somehexcode", 9993 "url": "https://api.github.com/users/octocat" 9994 }, 9995 "created_at": "2011-04-14T16:00:49Z", 9996 "updated_at": "2011-04-14T16:00:49Z", 9997 "_links": { 9998 "self": { 9999 "href": "https://api.github.com/octocat/Hello-World/pulls/comments/1" 10000 }, 10001 "html": { 10002 "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" 10003 }, 10004 "pull_request": { 10005 "href": "https://api.github.com/octocat/Hello-World/pulls/1" 10006 } 10007 } 10008 } 10009 ] 10010 /{commentId}: 10011 uriParameters: 10012 commentId: 10013 description: Id of the comment. 10014 type: integer 10015 type: item 10016 get: 10017 description: Get a single comment. 10018 responses: 10019 200: 10020 body: 10021 schema: | 10022 { 10023 "$schema": "http://json-schema.org/draft-03/schema", 10024 "type": "object", 10025 "properties": { 10026 "id": { 10027 "type": "integer" 10028 }, 10029 "url": { 10030 "type": "string" 10031 }, 10032 "html_url": { 10033 "type": "string" 10034 }, 10035 "body": { 10036 "type": "string" 10037 }, 10038 "user": { 10039 "properties": { 10040 "login": { 10041 "type": "string" 10042 }, 10043 "id": { 10044 "type": "integer" 10045 }, 10046 "avatar_url": { 10047 "type": "string" 10048 }, 10049 "gravatar_id": { 10050 "type": "string" 10051 }, 10052 "url": { 10053 "type": "string" 10054 } 10055 }, 10056 "type": "object" 10057 }, 10058 "created_at": { 10059 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 10060 "type": "string" 10061 }, 10062 "updated_at": { 10063 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 10064 "type": "string" 10065 } 10066 } 10067 } 10068 example: | 10069 { 10070 "id": 1, 10071 "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", 10072 "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", 10073 "body": "Me too", 10074 "user": { 10075 "login": "octocat", 10076 "id": 1, 10077 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 10078 "gravatar_id": "somehexcode", 10079 "url": "https://api.github.com/users/octocat" 10080 }, 10081 "created_at": "2011-04-14T16:00:49Z", 10082 "updated_at": "2011-04-14T16:00:49Z" 10083 } 10084 patch: 10085 description: Edit a comment. 10086 body: 10087 application/json: 10088 schema: | 10089 { 10090 "$schema": "http://json-schema.org/draft-03/schema", 10091 "type": "object", 10092 "properties": { 10093 "body": { 10094 "type": "string" 10095 } 10096 }, 10097 "required": [ "body" ] 10098 } 10099 responses: 10100 200: 10101 body: 10102 schema: | 10103 { 10104 "$schema": "http://json-schema.org/draft-03/schema", 10105 "type": "object", 10106 "properties": { 10107 "id": { 10108 "type": "integer" 10109 }, 10110 "url": { 10111 "type": "string" 10112 }, 10113 "html_url": { 10114 "type": "string" 10115 }, 10116 "body": { 10117 "type": "string" 10118 }, 10119 "user": { 10120 "properties": { 10121 "login": { 10122 "type": "string" 10123 }, 10124 "id": { 10125 "type": "integer" 10126 }, 10127 "avatar_url": { 10128 "type": "string" 10129 }, 10130 "gravatar_id": { 10131 "type": "string" 10132 }, 10133 "url": { 10134 "type": "string" 10135 } 10136 }, 10137 "type": "object" 10138 }, 10139 "created_at": { 10140 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 10141 "type": "string" 10142 }, 10143 "updated_at": { 10144 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 10145 "type": "string" 10146 } 10147 } 10148 } 10149 example: | 10150 { 10151 "id": 1, 10152 "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", 10153 "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", 10154 "body": "Me too", 10155 "user": { 10156 "login": "octocat", 10157 "id": 1, 10158 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 10159 "gravatar_id": "somehexcode", 10160 "url": "https://api.github.com/users/octocat" 10161 }, 10162 "created_at": "2011-04-14T16:00:49Z", 10163 "updated_at": "2011-04-14T16:00:49Z" 10164 } 10165 delete: 10166 description: Delete a comment. 10167 /notifications: 10168 type: collection 10169 get: 10170 description: | 10171 List your notifications in a repository 10172 List all notifications for the current user. 10173 queryParameters: 10174 all: 10175 description: True to show notifications marked as read. 10176 type: string 10177 participating: 10178 description: | 10179 True to show only notifications in which the user is directly participating 10180 or mentioned. 10181 type: string 10182 since: 10183 description: | 10184 Time filters out any notifications updated before the given time. The 10185 time should be passed in as UTC in the ISO 8601 format YYYY-MM-DDTHH:MM:SSZ. 10186 Example: "2012-10-09T23:39:01Z". 10187 type: string 10188 responses: 10189 200: 10190 body: 10191 schema: | 10192 { 10193 "$schema": "http://json-schema.org/draft-03/schema", 10194 "type": "array", 10195 "properties": [ 10196 { 10197 "properties": { 10198 "id": { 10199 "type": "integer" 10200 }, 10201 "repository": { 10202 "properties": { 10203 "id": { 10204 "type": "integer" 10205 }, 10206 "owner": { 10207 "properties": { 10208 "login": { 10209 "type": "string" 10210 }, 10211 "id": { 10212 "type": "integer" 10213 }, 10214 "avatar_url": { 10215 "type": "string" 10216 }, 10217 "gravatar_id": { 10218 "type": "string" 10219 }, 10220 "url": { 10221 "type": "string" 10222 } 10223 }, 10224 "type": "object" 10225 }, 10226 "name": { 10227 "type": "string" 10228 }, 10229 "full_name": { 10230 "type": "string" 10231 }, 10232 "description": { 10233 "type": "string" 10234 }, 10235 "private": { 10236 "type": "boolean" 10237 }, 10238 "fork": { 10239 "type": "boolean" 10240 }, 10241 "url": { 10242 "type": "string" 10243 }, 10244 "html_url": { 10245 "type": "string" 10246 } 10247 }, 10248 "type": "object" 10249 }, 10250 "subject": { 10251 "properties": { 10252 "title": { 10253 "type": "string" 10254 }, 10255 "url": { 10256 "type": "string" 10257 }, 10258 "latest_comment_url": { 10259 "type": "string" 10260 }, 10261 "type": { 10262 "type": "string" 10263 } 10264 }, 10265 "type": "object" 10266 }, 10267 "reason": { 10268 "type": "string" 10269 }, 10270 "unread": { 10271 "type": "boolean" 10272 }, 10273 "updated_at": { 10274 "type": "string" 10275 }, 10276 "last_read_at": { 10277 "type": "string" 10278 }, 10279 "url": { 10280 "type": "string" 10281 } 10282 }, 10283 "type": "object" 10284 } 10285 ] 10286 } 10287 example: | 10288 [ 10289 { 10290 "id": 1, 10291 "repository": { 10292 "id": 1296269, 10293 "owner": { 10294 "login": "octocat", 10295 "id": 1, 10296 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 10297 "gravatar_id": "somehexcode", 10298 "url": "https://api.github.com/users/octocat" 10299 }, 10300 "name": "Hello-World", 10301 "full_name": "octocat/Hello-World", 10302 "description": "This your first repo!", 10303 "private": false, 10304 "fork": false, 10305 "url": "https://api.github.com/repos/octocat/Hello-World", 10306 "html_url": "https://github.com/octocat/Hello-World" 10307 }, 10308 "subject": { 10309 "title": "Greetings", 10310 "url": "https://api.github.com/repos/pengwynn/octokit/issues/123", 10311 "latest_comment_url": "https://api.github.com/repos/pengwynn/octokit/issues/comments/123", 10312 "type": "Issue" 10313 }, 10314 "reason": "subscribed", 10315 "unread": true, 10316 "updated_at": "2012-09-25T07:54:41-07:00", 10317 "last_read_at": "2012-09-25T07:54:41-07:00", 10318 "url": "https://api.github.com/notifications/threads/1" 10319 } 10320 ] 10321 put: 10322 body: 10323 application/json: 10324 schema: | 10325 { 10326 "$schema": "http://json-schema.org/draft-03/schema", 10327 "type": "object", 10328 "properties": { 10329 "last_read_at": { 10330 "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated. Default: Now.", 10331 "type": "string" 10332 } 10333 } 10334 } 10335 description: | 10336 Mark notifications as read in a repository. 10337 Marking all notifications in a repository as "read" removes them from the 10338 default view on GitHub.com. 10339 responses: 10340 205: 10341 description: Marked as read. 10342 /subscription: 10343 type: collection 10344 get: 10345 description: Get a Repository Subscription. 10346 responses: 10347 200: 10348 body: 10349 schema: | 10350 { 10351 "$schema": "http://json-schema.org/draft-03/schema", 10352 "type": "object", 10353 "properties": { 10354 "subscribed": { 10355 "type": "boolean" 10356 }, 10357 "ignored": { 10358 "type": "boolean" 10359 }, 10360 "reason": { 10361 "type": "string" 10362 }, 10363 "created_at": { 10364 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 10365 "type": "string" 10366 }, 10367 "url": { 10368 "type": "string" 10369 }, 10370 "repository_url": { 10371 "type": "string" 10372 } 10373 } 10374 } 10375 example: | 10376 { 10377 "subscribed": true, 10378 "ignored": false, 10379 "reason": null, 10380 "created_at": "2012-10-06T21:34:12Z", 10381 "url": "https://api.github.com/repos/octocat/example/subscription", 10382 "repository_url": "https://api.github.com/repos/octocat/example" 10383 } 10384 put: 10385 description: Set a Repository Subscription 10386 body: 10387 application/json: 10388 schema: | 10389 { 10390 "$schema": "http://json-schema.org/draft-03/schema", 10391 "type": "object", 10392 "properties": { 10393 "subscribed": { 10394 "description": "Determines if notifications should be received from this repository.", 10395 "type": "boolean" 10396 }, 10397 "ignored": { 10398 "description": "Determines if all notifications should be blocked from this repository.", 10399 "type": "boolean" 10400 } 10401 }, 10402 "required": [ "subscribed", "ignored" ] 10403 } 10404 responses: 10405 200: 10406 body: 10407 schema: | 10408 { 10409 "$schema": "http://json-schema.org/draft-03/schema", 10410 "type": "object", 10411 "properties": { 10412 "subscribed": { 10413 "type": "boolean" 10414 }, 10415 "ignored": { 10416 "type": "boolean" 10417 }, 10418 "reason": { 10419 "type": "string" 10420 }, 10421 "created_at": { 10422 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 10423 "type": "string" 10424 }, 10425 "url": { 10426 "type": "string" 10427 }, 10428 "repository_url": { 10429 "type": "string" 10430 } 10431 } 10432 } 10433 example: | 10434 { 10435 "subscribed": true, 10436 "ignored": false, 10437 "reason": null, 10438 "created_at": "2012-10-06T21:34:12Z", 10439 "url": "https://api.github.com/repos/octocat/example/subscription", 10440 "repository_url": "https://api.github.com/repos/octocat/example" 10441 } 10442 delete: 10443 description: Delete a Repository Subscription. 10444 /assignees: 10445 type: collection 10446 get: 10447 description: | 10448 List assignees. 10449 This call lists all the available assignees (owner + collaborators) to which 10450 issues may be assigned. 10451 responses: 10452 200: 10453 body: 10454 schema: | 10455 { 10456 "$schema": "http://json-schema.org/draft-03/schema", 10457 "type": "array", 10458 "list": [ 10459 { 10460 "properties": { 10461 "login": { 10462 "type": "string" 10463 }, 10464 "id": { 10465 "type": "integer" 10466 }, 10467 "avatar_url": { 10468 "type": "integer" 10469 }, 10470 "gravatar_id": { 10471 "type": "string" 10472 }, 10473 "url": { 10474 "type": "string" 10475 } 10476 }, 10477 "type": "object" 10478 } 10479 ] 10480 } 10481 example: | 10482 [ 10483 { 10484 "login": "octocat", 10485 "id": 1, 10486 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 10487 "gravatar_id": "somehexcode", 10488 "url": "https://api.github.com/users/octocat" 10489 } 10490 ] 10491 /{assignee}: 10492 type: base 10493 uriParameters: 10494 assignee: 10495 description: Login of the assignee. 10496 type: string 10497 get: 10498 description: | 10499 Check assignee. 10500 You may also check to see if a particular user is an assignee for a repository. 10501 responses: 10502 204: 10503 description: User is an assignee. 10504 404: 10505 description: User isn't an assignee. 10506 /labels: 10507 type: collection 10508 get: 10509 description: List all labels for this repository. 10510 responses: 10511 200: 10512 body: 10513 schema: | 10514 { 10515 "$schema": "http://json-schema.org/draft-03/schema", 10516 "type": "array", 10517 "list": [ 10518 { 10519 "properties": { 10520 "url": { 10521 "type": "string" 10522 }, 10523 "name": { 10524 "type": "string" 10525 }, 10526 "color": { 10527 "type": "string", 10528 "maxLength": 6, 10529 "minLength": 6 10530 } 10531 }, 10532 "type": "object" 10533 } 10534 ] 10535 } 10536 example: | 10537 [ 10538 { 10539 "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", 10540 "name": "bug", 10541 "color": "f29513" 10542 } 10543 ] 10544 post: 10545 description: Create a label. 10546 body: 10547 application/json: 10548 schema: | 10549 { 10550 "$schema": "http://json-schema.org/draft-03/schema", 10551 "type": "object", 10552 "properties": { 10553 "name": { 10554 "type": "string" 10555 }, 10556 "color": { 10557 "description": "6 character hex code, without a leading #.", 10558 "type": "string", 10559 "minLength": 6, 10560 "maxLength": 6 10561 } 10562 }, 10563 "required": [ "name", "color" ] 10564 } 10565 responses: 10566 201: 10567 body: 10568 schema: | 10569 { 10570 "$schema": "http://json-schema.org/draft-03/schema", 10571 "type": "object", 10572 "properties": { 10573 "url": { 10574 "type": "string" 10575 }, 10576 "name": { 10577 "type": "string" 10578 }, 10579 "color": { 10580 "type": "string", 10581 "maxLength": 6, 10582 "minLength": 6 10583 } 10584 } 10585 } 10586 example: | 10587 { 10588 "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", 10589 "name": "bug", 10590 "color": "f29513" 10591 } 10592 /{name}: 10593 uriParameters: 10594 name: 10595 description: Name of the label. 10596 type: string 10597 type: item 10598 get: 10599 description: Get a single label. 10600 responses: 10601 200: 10602 body: 10603 schema: | 10604 { 10605 "$schema": "http://json-schema.org/draft-03/schema", 10606 "type": "object", 10607 "properties": { 10608 "url": { 10609 "type": "string" 10610 }, 10611 "name": { 10612 "type": "string" 10613 }, 10614 "color": { 10615 "type": "string", 10616 "maxLength": 6, 10617 "minLength": 6 10618 } 10619 } 10620 } 10621 example: | 10622 { 10623 "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", 10624 "name": "bug", 10625 "color": "f29513" 10626 } 10627 patch: 10628 description: Update a label. 10629 body: 10630 application/json: 10631 schema: | 10632 { 10633 "$schema": "http://json-schema.org/draft-03/schema", 10634 "type": "object", 10635 "properties": { 10636 "name": { 10637 "type": "string" 10638 }, 10639 "color": { 10640 "description": "6 character hex code, without a leading #.", 10641 "type": "string", 10642 "minLength": 6, 10643 "maxLength": 6 10644 } 10645 }, 10646 "required": [ "name", "color" ] 10647 } 10648 responses: 10649 200: 10650 body: 10651 schema: | 10652 { 10653 "$schema": "http://json-schema.org/draft-03/schema", 10654 "type": "object", 10655 "properties": { 10656 "url": { 10657 "type": "string" 10658 }, 10659 "name": { 10660 "type": "string" 10661 }, 10662 "color": { 10663 "type": "string", 10664 "maxLength": 6, 10665 "minLength": 6 10666 } 10667 } 10668 } 10669 example: | 10670 { 10671 "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", 10672 "name": "bug", 10673 "color": "f29513" 10674 } 10675 delete: 10676 description: Delete a label. 10677 /milestones: 10678 type: collection 10679 get: 10680 description: List milestones for a repository. 10681 queryParameters: 10682 state: 10683 enum: 10684 - open 10685 - closed 10686 default: open 10687 sort: 10688 enum: 10689 - due_date 10690 - completeness 10691 default: due_date 10692 direction: 10693 enum: 10694 - asc 10695 - desc 10696 default: desc 10697 responses: 10698 200: 10699 body: 10700 schema: | 10701 { 10702 "$schema": "http://json-schema.org/draft-03/schema", 10703 "type": "object", 10704 "properties": { 10705 "url": { 10706 "type": "string" 10707 }, 10708 "number": { 10709 "type": "integer" 10710 }, 10711 "state": { 10712 "enum": [ 10713 "open", 10714 "closed" 10715 ] 10716 }, 10717 "title": { 10718 "type": "string" 10719 }, 10720 "description": { 10721 "type": "string" 10722 }, 10723 "creator": { 10724 "properties": { 10725 "login": { 10726 "type": "string" 10727 }, 10728 "id": { 10729 "type": "integer" 10730 }, 10731 "avatar_url": { 10732 "type": "string" 10733 }, 10734 "gravatar_id": { 10735 "type": "string" 10736 }, 10737 "url": { 10738 "type": "string" 10739 } 10740 }, 10741 "type": "object" 10742 }, 10743 "open_issues": { 10744 "type": "integer" 10745 }, 10746 "closed_issues": { 10747 "type": "integer" 10748 }, 10749 "created_at": { 10750 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 10751 "type": "string" 10752 }, 10753 "due_on": { 10754 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 10755 "type": "string" 10756 } 10757 } 10758 } 10759 example: | 10760 { 10761 "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", 10762 "number": 1, 10763 "state": "open", 10764 "title": "v1.0", 10765 "description": "", 10766 "creator": { 10767 "login": "octocat", 10768 "id": 1, 10769 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 10770 "gravatar_id": "somehexcode", 10771 "url": "https://api.github.com/users/octocat" 10772 }, 10773 "open_issues": 4, 10774 "closed_issues": 8, 10775 "created_at": "2011-04-10T20:09:31Z", 10776 "due_on": null 10777 } 10778 post: 10779 description: Create a milestone. 10780 body: 10781 application/json: 10782 schema: | 10783 { 10784 "$schema": "http://json-schema.org/draft-03/schema", 10785 "type": "object", 10786 "properties": { 10787 "title": { 10788 "type": "string" 10789 }, 10790 "state": { 10791 "enum": [ 10792 "open", 10793 "closed" 10794 ] 10795 }, 10796 "description": { 10797 "type": "string" 10798 }, 10799 "due_on": { 10800 "description": "ISO 8601 time.", 10801 "type": "string" 10802 } 10803 }, 10804 "required": [ "title" ] 10805 } 10806 responses: 10807 201: 10808 body: 10809 schema: | 10810 { 10811 "$schema": "http://json-schema.org/draft-03/schema", 10812 "type": "object", 10813 "properties": { 10814 "url": { 10815 "type": "string" 10816 }, 10817 "number": { 10818 "type": "integer" 10819 }, 10820 "state": { 10821 "enum": [ 10822 "open", 10823 "closed" 10824 ] 10825 }, 10826 "title": { 10827 "type": "string" 10828 }, 10829 "description": { 10830 "type": "string" 10831 }, 10832 "creator": { 10833 "properties": { 10834 "login": { 10835 "type": "string" 10836 }, 10837 "id": { 10838 "type": "integer" 10839 }, 10840 "avatar_url": { 10841 "type": "string" 10842 }, 10843 "gravatar_id": { 10844 "type": "string" 10845 }, 10846 "url": { 10847 "type": "string" 10848 } 10849 }, 10850 "type": "object" 10851 }, 10852 "open_issues": { 10853 "type": "integer" 10854 }, 10855 "closed_issues": { 10856 "type": "integer" 10857 }, 10858 "created_at": { 10859 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 10860 "type": "string" 10861 }, 10862 "due_on": { 10863 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 10864 "type": "string" 10865 } 10866 } 10867 } 10868 example: | 10869 { 10870 "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", 10871 "number": 1, 10872 "state": "open", 10873 "title": "v1.0", 10874 "description": "", 10875 "creator": { 10876 "login": "octocat", 10877 "id": 1, 10878 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 10879 "gravatar_id": "somehexcode", 10880 "url": "https://api.github.com/users/octocat" 10881 }, 10882 "open_issues": 4, 10883 "closed_issues": 8, 10884 "created_at": "2011-04-10T20:09:31Z", 10885 "due_on": null 10886 } 10887 /{number}: 10888 uriParameters: 10889 number: 10890 description: Id of the milestone. 10891 type: integer 10892 type: item 10893 get: 10894 description: Get a single milestone. 10895 responses: 10896 200: 10897 body: 10898 schema: | 10899 { 10900 "$schema": "http://json-schema.org/draft-03/schema", 10901 "type": "object", 10902 "properties": { 10903 "url": { 10904 "type": "string" 10905 }, 10906 "number": { 10907 "type": "integer" 10908 }, 10909 "state": { 10910 "enum": [ 10911 "open", 10912 "closed" 10913 ] 10914 }, 10915 "title": { 10916 "type": "string" 10917 }, 10918 "description": { 10919 "type": "string" 10920 }, 10921 "creator": { 10922 "properties": { 10923 "login": { 10924 "type": "string" 10925 }, 10926 "id": { 10927 "type": "integer" 10928 }, 10929 "avatar_url": { 10930 "type": "string" 10931 }, 10932 "gravatar_id": { 10933 "type": "string" 10934 }, 10935 "url": { 10936 "type": "string" 10937 } 10938 }, 10939 "type": "object" 10940 }, 10941 "open_issues": { 10942 "type": "integer" 10943 }, 10944 "closed_issues": { 10945 "type": "integer" 10946 }, 10947 "created_at": { 10948 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 10949 "type": "string" 10950 }, 10951 "due_on": { 10952 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 10953 "type": "string" 10954 } 10955 } 10956 } 10957 example: | 10958 { 10959 "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", 10960 "number": 1, 10961 "state": "open", 10962 "title": "v1.0", 10963 "description": "", 10964 "creator": { 10965 "login": "octocat", 10966 "id": 1, 10967 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 10968 "gravatar_id": "somehexcode", 10969 "url": "https://api.github.com/users/octocat" 10970 }, 10971 "open_issues": 4, 10972 "closed_issues": 8, 10973 "created_at": "2011-04-10T20:09:31Z", 10974 "due_on": null 10975 } 10976 patch: 10977 description: Update a milestone. 10978 body: 10979 application/json: 10980 schema: | 10981 { 10982 "$schema": "http://json-schema.org/draft-03/schema", 10983 "type": "object", 10984 "properties": { 10985 "number": { 10986 "type": "integer" 10987 }, 10988 "title": { 10989 "type": "string" 10990 }, 10991 "state": { 10992 "enum": [ 10993 "open", 10994 "closed" 10995 ] 10996 }, 10997 "description": { 10998 "type": "string" 10999 }, 11000 "due_on": { 11001 "description": "ISO 8601 time.", 11002 "type": "string" 11003 } 11004 }, 11005 "required": [ "number" ] 11006 } 11007 responses: 11008 200: 11009 body: 11010 schema: | 11011 { 11012 "$schema": "http://json-schema.org/draft-03/schema", 11013 "type": "object", 11014 "properties": { 11015 "url": { 11016 "type": "string" 11017 }, 11018 "number": { 11019 "type": "integer" 11020 }, 11021 "state": { 11022 "enum": [ 11023 "open", 11024 "closed" 11025 ] 11026 }, 11027 "title": { 11028 "type": "string" 11029 }, 11030 "description": { 11031 "type": "string" 11032 }, 11033 "creator": { 11034 "properties": { 11035 "login": { 11036 "type": "string" 11037 }, 11038 "id": { 11039 "type": "integer" 11040 }, 11041 "avatar_url": { 11042 "type": "string" 11043 }, 11044 "gravatar_id": { 11045 "type": "string" 11046 }, 11047 "url": { 11048 "type": "string" 11049 } 11050 }, 11051 "type": "object" 11052 }, 11053 "open_issues": { 11054 "type": "integer" 11055 }, 11056 "closed_issues": { 11057 "type": "integer" 11058 }, 11059 "created_at": { 11060 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 11061 "type": "string" 11062 }, 11063 "due_on": { 11064 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 11065 "type": "string" 11066 } 11067 } 11068 } 11069 example: | 11070 { 11071 "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", 11072 "number": 1, 11073 "state": "open", 11074 "title": "v1.0", 11075 "description": "", 11076 "creator": { 11077 "login": "octocat", 11078 "id": 1, 11079 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 11080 "gravatar_id": "somehexcode", 11081 "url": "https://api.github.com/users/octocat" 11082 }, 11083 "open_issues": 4, 11084 "closed_issues": 8, 11085 "created_at": "2011-04-10T20:09:31Z", 11086 "due_on": null 11087 } 11088 delete: 11089 description: Delete a milestone. 11090 /labels: 11091 type: collection 11092 get: 11093 description: Get labels for every issue in a milestone. 11094 responses: 11095 200: 11096 body: 11097 schema: | 11098 { 11099 "$schema": "http://json-schema.org/draft-03/schema", 11100 "type": "array", 11101 "list": [ 11102 { 11103 "properties": { 11104 "url": { 11105 "type": "string" 11106 }, 11107 "name": { 11108 "type": "string" 11109 }, 11110 "color": { 11111 "type": "string", 11112 "maxLength": 6, 11113 "minLength": 6 11114 } 11115 }, 11116 "type": "object" 11117 } 11118 ] 11119 } 11120 example: | 11121 [ 11122 { 11123 "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", 11124 "name": "bug", 11125 "color": "f29513" 11126 } 11127 ] 11128 /pulls: 11129 type: collection 11130 get: 11131 description: List pull requests. 11132 queryParameters: 11133 state: 11134 description: String to filter by state. 11135 enum: 11136 - open 11137 - closed 11138 default: open 11139 head: 11140 description: | 11141 Filter pulls by head user and branch name in the format of 'user:ref-name'. 11142 Example: github:new-script-format. 11143 type: string 11144 base: 11145 description: Filter pulls by base branch name. Example - gh-pages. 11146 responses: 11147 200: 11148 body: 11149 schema: | 11150 { 11151 "$schema": "http://json-schema.org/draft-03/schema", 11152 "type": "array", 11153 "list": [ 11154 { 11155 "properties": { 11156 "url": { 11157 "type": "string" 11158 }, 11159 "html_url": { 11160 "type": "string" 11161 }, 11162 "diff_url": { 11163 "type": "string" 11164 }, 11165 "patch_url": { 11166 "type": "string" 11167 }, 11168 "issue_url": { 11169 "type": "string" 11170 }, 11171 "number": { 11172 "type": "integer" 11173 }, 11174 "state": { 11175 "enum": [ 11176 "open", 11177 "closed" 11178 ] 11179 }, 11180 "title": { 11181 "type": "string" 11182 }, 11183 "body": { 11184 "type": "string" 11185 }, 11186 "created_at": { 11187 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 11188 "type": "string" 11189 }, 11190 "updated_at": { 11191 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 11192 "type": "string" 11193 }, 11194 "closed_at": { 11195 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 11196 "type": "string" 11197 }, 11198 "merged_at": { 11199 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 11200 "type": "string" 11201 }, 11202 "head": { 11203 "properties": { 11204 "label": { 11205 "type": "string" 11206 }, 11207 "ref": { 11208 "type": "string" 11209 }, 11210 "sha": { 11211 "type": "string" 11212 }, 11213 "user": { 11214 "properties": { 11215 "login": { 11216 "type": "string" 11217 }, 11218 "id": { 11219 "type": "integer" 11220 }, 11221 "avatar_url": { 11222 "type": "string" 11223 }, 11224 "gravatar_id": { 11225 "type": "string" 11226 }, 11227 "url": { 11228 "type": "string" 11229 } 11230 }, 11231 "type": "object" 11232 }, 11233 "repo": { 11234 "properties": { 11235 "id": { 11236 "type": "integer" 11237 }, 11238 "owner": { 11239 "properties": { 11240 "login": { 11241 "type": "string" 11242 }, 11243 "id": { 11244 "type": "integer" 11245 }, 11246 "avatar_url": { 11247 "type": "string" 11248 }, 11249 "gravatar_id": { 11250 "type": "string" 11251 }, 11252 "url": { 11253 "type": "string" 11254 } 11255 }, 11256 "type": "object" 11257 }, 11258 "name": { 11259 "type": "string" 11260 }, 11261 "full_name": { 11262 "type": "string" 11263 }, 11264 "description": { 11265 "type": "string" 11266 }, 11267 "private": { 11268 "type": "boolean" 11269 }, 11270 "fork": { 11271 "type": "boolean" 11272 }, 11273 "url": { 11274 "type": "string" 11275 }, 11276 "html_url": { 11277 "type": "string" 11278 }, 11279 "clone_url": { 11280 "type": "string" 11281 }, 11282 "git_url": { 11283 "type": "string" 11284 }, 11285 "ssh_url": { 11286 "type": "string" 11287 }, 11288 "svn_url": { 11289 "type": "string" 11290 }, 11291 "mirror_url": { 11292 "type": "string" 11293 }, 11294 "homepage": { 11295 "type": "string" 11296 }, 11297 "language": { 11298 "type": "string" 11299 }, 11300 "forks": { 11301 "type": "integer" 11302 }, 11303 "forks_count": { 11304 "type": "integer" 11305 }, 11306 "watchers": { 11307 "type": "integer" 11308 }, 11309 "watchers_count": { 11310 "type": "integer" 11311 }, 11312 "size": { 11313 "type": "integer" 11314 }, 11315 "master_branch": { 11316 "type": "string" 11317 }, 11318 "open_issues": { 11319 "type": "integer" 11320 }, 11321 "open_issues_count": { 11322 "type": "integer" 11323 }, 11324 "pushed_at": { 11325 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 11326 "type": "string" 11327 }, 11328 "created_at": { 11329 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 11330 "type": "string" 11331 }, 11332 "updated_at": { 11333 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 11334 "type": "string" 11335 } 11336 }, 11337 "type": "object" 11338 } 11339 }, 11340 "type": "object" 11341 }, 11342 "base": { 11343 "properties": { 11344 "label": { 11345 "type": "string" 11346 }, 11347 "ref": { 11348 "type": "string" 11349 }, 11350 "sha": { 11351 "type": "string" 11352 }, 11353 "user": { 11354 "properties": { 11355 "login": { 11356 "type": "string" 11357 }, 11358 "id": { 11359 "type": "integer" 11360 }, 11361 "avatar_url": { 11362 "type": "string" 11363 }, 11364 "gravatar_id": { 11365 "type": "string" 11366 }, 11367 "url": { 11368 "type": "string" 11369 } 11370 }, 11371 "type": "object" 11372 }, 11373 "repo": { 11374 "properties": { 11375 "id": { 11376 "type": "integer" 11377 }, 11378 "owner": { 11379 "properties": { 11380 "login": { 11381 "type": "string" 11382 }, 11383 "id": { 11384 "type": "integer" 11385 }, 11386 "avatar_url": { 11387 "type": "string" 11388 }, 11389 "gravatar_id": { 11390 "type": "string" 11391 }, 11392 "url": { 11393 "type": "string" 11394 } 11395 }, 11396 "type": "object" 11397 }, 11398 "name": { 11399 "type": "string" 11400 }, 11401 "full_name": { 11402 "type": "string" 11403 }, 11404 "description": { 11405 "type": "string" 11406 }, 11407 "private": { 11408 "type": "boolean" 11409 }, 11410 "fork": { 11411 "type": "boolean" 11412 }, 11413 "url": { 11414 "type": "string" 11415 }, 11416 "html_url": { 11417 "type": "string" 11418 }, 11419 "clone_url": { 11420 "type": "string" 11421 }, 11422 "git_url": { 11423 "type": "string" 11424 }, 11425 "ssh_url": { 11426 "type": "string" 11427 }, 11428 "svn_url": { 11429 "type": "string" 11430 }, 11431 "mirror_url": { 11432 "type": "string" 11433 }, 11434 "homepage": { 11435 "type": "string" 11436 }, 11437 "language": { 11438 "type": "string" 11439 }, 11440 "forks": { 11441 "type": "integer" 11442 }, 11443 "forks_count": { 11444 "type": "integer" 11445 }, 11446 "watchers": { 11447 "type": "integer" 11448 }, 11449 "watchers_count": { 11450 "type": "integer" 11451 }, 11452 "size": { 11453 "type": "integer" 11454 }, 11455 "master_branch": { 11456 "type": "string" 11457 }, 11458 "open_issues": { 11459 "type": "integer" 11460 }, 11461 "open_issues_count": { 11462 "type": "integer" 11463 }, 11464 "pushed_at": { 11465 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 11466 "type": "string" 11467 }, 11468 "created_at": { 11469 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 11470 "type": "string" 11471 }, 11472 "updated_at": { 11473 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 11474 "type": "string" 11475 } 11476 }, 11477 "type": "object" 11478 } 11479 }, 11480 "type": "object" 11481 }, 11482 "_links": { 11483 "properties": { 11484 "self": { 11485 "properties": { 11486 "href": { 11487 "type": "string" 11488 } 11489 }, 11490 "type": "object" 11491 }, 11492 "html": { 11493 "properties": { 11494 "href": { 11495 "type": "string" 11496 } 11497 }, 11498 "type": "object" 11499 }, 11500 "comments": { 11501 "properties": { 11502 "href": { 11503 "type": "string" 11504 } 11505 }, 11506 "type": "object" 11507 }, 11508 "review_comments": { 11509 "properties": { 11510 "href": { 11511 "type": "string" 11512 } 11513 }, 11514 "type": "object" 11515 } 11516 }, 11517 "type": "object" 11518 }, 11519 "user": { 11520 "properties": { 11521 "login": { 11522 "type": "string" 11523 }, 11524 "id": { 11525 "type": "integer" 11526 }, 11527 "avatar_url": { 11528 "type": "string" 11529 }, 11530 "gravatar_id": { 11531 "type": "string" 11532 }, 11533 "url": { 11534 "type": "string" 11535 } 11536 }, 11537 "type": "object" 11538 } 11539 }, 11540 "type": "object" 11541 } 11542 ] 11543 } 11544 example: | 11545 [ 11546 { 11547 "url": "https://api.github.com/octocat/Hello-World/pulls/1", 11548 "html_url": "https://github.com/octocat/Hello-World/pulls/1", 11549 "diff_url": "https://github.com/octocat/Hello-World/pulls/1.diff", 11550 "patch_url": "https://github.com/octocat/Hello-World/pulls/1.patch", 11551 "issue_url": "https://github.com/octocat/Hello-World/issue/1", 11552 "number": 1, 11553 "state": "open", 11554 "title": "new-feature", 11555 "body": "Please pull these awesome changes", 11556 "created_at": "2011-01-26T19:01:12Z", 11557 "updated_at": "2011-01-26T19:01:12Z", 11558 "closed_at": "2011-01-26T19:01:12Z", 11559 "merged_at": "2011-01-26T19:01:12Z", 11560 "head": { 11561 "label": "new-topic", 11562 "ref": "new-topic", 11563 "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 11564 "user": { 11565 "login": "octocat", 11566 "id": 1, 11567 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 11568 "gravatar_id": "somehexcode", 11569 "url": "https://api.github.com/users/octocat" 11570 }, 11571 "repo": { 11572 "id": 1296269, 11573 "owner": { 11574 "login": "octocat", 11575 "id": 1, 11576 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 11577 "gravatar_id": "somehexcode", 11578 "url": "https://api.github.com/users/octocat" 11579 }, 11580 "name": "Hello-World", 11581 "full_name": "octocat/Hello-World", 11582 "description": "This your first repo!", 11583 "private": false, 11584 "fork": false, 11585 "url": "https://api.github.com/repos/octocat/Hello-World", 11586 "html_url": "https://github.com/octocat/Hello-World", 11587 "clone_url": "https://github.com/octocat/Hello-World.git", 11588 "git_url": "git://github.com/octocat/Hello-World.git", 11589 "ssh_url": "git@github.com:octocat/Hello-World.git", 11590 "svn_url": "https://svn.github.com/octocat/Hello-World", 11591 "mirror_url": "git://git.example.com/octocat/Hello-World", 11592 "homepage": "https://github.com", 11593 "language": null, 11594 "forks": 9, 11595 "forks_count": 9, 11596 "watchers": 80, 11597 "watchers_count": 80, 11598 "size": 108, 11599 "master_branch": "master", 11600 "open_issues": 0, 11601 "open_issues_count": 0, 11602 "pushed_at": "2011-01-26T19:06:43Z", 11603 "created_at": "2011-01-26T19:01:12Z", 11604 "updated_at": "2011-01-26T19:14:43Z" 11605 } 11606 }, 11607 "base": { 11608 "label": "master", 11609 "ref": "master", 11610 "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 11611 "user": { 11612 "login": "octocat", 11613 "id": 1, 11614 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 11615 "gravatar_id": "somehexcode", 11616 "url": "https://api.github.com/users/octocat" 11617 }, 11618 "repo": { 11619 "id": 1296269, 11620 "owner": { 11621 "login": "octocat", 11622 "id": 1, 11623 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 11624 "gravatar_id": "somehexcode", 11625 "url": "https://api.github.com/users/octocat" 11626 }, 11627 "name": "Hello-World", 11628 "full_name": "octocat/Hello-World", 11629 "description": "This your first repo!", 11630 "private": false, 11631 "fork": false, 11632 "url": "https://api.github.com/repos/octocat/Hello-World", 11633 "html_url": "https://github.com/octocat/Hello-World", 11634 "clone_url": "https://github.com/octocat/Hello-World.git", 11635 "git_url": "git://github.com/octocat/Hello-World.git", 11636 "ssh_url": "git@github.com:octocat/Hello-World.git", 11637 "svn_url": "https://svn.github.com/octocat/Hello-World", 11638 "mirror_url": "git://git.example.com/octocat/Hello-World", 11639 "homepage": "https://github.com", 11640 "language": null, 11641 "forks": 9, 11642 "forks_count": 9, 11643 "watchers": 80, 11644 "watchers_count": 80, 11645 "size": 108, 11646 "master_branch": "master", 11647 "open_issues": 0, 11648 "open_issues_count": 0, 11649 "pushed_at": "2011-01-26T19:06:43Z", 11650 "created_at": "2011-01-26T19:01:12Z", 11651 "updated_at": "2011-01-26T19:14:43Z" 11652 } 11653 }, 11654 "_links": { 11655 "self": { 11656 "href": "https://api.github.com/octocat/Hello-World/pulls/1" 11657 }, 11658 "html": { 11659 "href": "https://github.com/octocat/Hello-World/pull/1" 11660 }, 11661 "comments": { 11662 "href": "https://api.github.com/octocat/Hello-World/issues/1/comments" 11663 }, 11664 "review_comments": { 11665 "href": "https://api.github.com/octocat/Hello-World/pulls/1/comments" 11666 } 11667 }, 11668 "user": { 11669 "login": "octocat", 11670 "id": 1, 11671 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 11672 "gravatar_id": "somehexcode", 11673 "url": "https://api.github.com/users/octocat" 11674 } 11675 } 11676 ] 11677 post: 11678 description: Create a pull request. 11679 responses: 11680 201: 11681 body: 11682 schema: | 11683 { 11684 "$schema": "http://json-schema.org/draft-03/schema", 11685 "type": "array", 11686 "list": [ 11687 { 11688 "properties": { 11689 "url": { 11690 "type": "string" 11691 }, 11692 "html_url": { 11693 "type": "string" 11694 }, 11695 "diff_url": { 11696 "type": "string" 11697 }, 11698 "patch_url": { 11699 "type": "string" 11700 }, 11701 "issue_url": { 11702 "type": "string" 11703 }, 11704 "number": { 11705 "type": "integer" 11706 }, 11707 "state": { 11708 "enum": [ 11709 "open", 11710 "closed" 11711 ] 11712 }, 11713 "title": { 11714 "type": "string" 11715 }, 11716 "body": { 11717 "type": "string" 11718 }, 11719 "created_at": { 11720 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 11721 "type": "string" 11722 }, 11723 "updated_at": { 11724 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 11725 "type": "string" 11726 }, 11727 "closed_at": { 11728 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 11729 "type": "string" 11730 }, 11731 "merged_at": { 11732 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 11733 "type": "string" 11734 }, 11735 "head": { 11736 "properties": { 11737 "label": { 11738 "type": "string" 11739 }, 11740 "ref": { 11741 "type": "string" 11742 }, 11743 "sha": { 11744 "type": "string" 11745 }, 11746 "user": { 11747 "properties": { 11748 "login": { 11749 "type": "string" 11750 }, 11751 "id": { 11752 "type": "integer" 11753 }, 11754 "avatar_url": { 11755 "type": "string" 11756 }, 11757 "gravatar_id": { 11758 "type": "string" 11759 }, 11760 "url": { 11761 "type": "string" 11762 } 11763 }, 11764 "type": "object" 11765 }, 11766 "repo": { 11767 "properties": { 11768 "id": { 11769 "type": "integer" 11770 }, 11771 "owner": { 11772 "properties": { 11773 "login": { 11774 "type": "string" 11775 }, 11776 "id": { 11777 "type": "integer" 11778 }, 11779 "avatar_url": { 11780 "type": "string" 11781 }, 11782 "gravatar_id": { 11783 "type": "string" 11784 }, 11785 "url": { 11786 "type": "string" 11787 } 11788 }, 11789 "type": "object" 11790 }, 11791 "name": { 11792 "type": "string" 11793 }, 11794 "full_name": { 11795 "type": "string" 11796 }, 11797 "description": { 11798 "type": "string" 11799 }, 11800 "private": { 11801 "type": "boolean" 11802 }, 11803 "fork": { 11804 "type": "boolean" 11805 }, 11806 "url": { 11807 "type": "string" 11808 }, 11809 "html_url": { 11810 "type": "string" 11811 }, 11812 "clone_url": { 11813 "type": "string" 11814 }, 11815 "git_url": { 11816 "type": "string" 11817 }, 11818 "ssh_url": { 11819 "type": "string" 11820 }, 11821 "svn_url": { 11822 "type": "string" 11823 }, 11824 "mirror_url": { 11825 "type": "string" 11826 }, 11827 "homepage": { 11828 "type": "string" 11829 }, 11830 "language": { 11831 "type": "string" 11832 }, 11833 "forks": { 11834 "type": "integer" 11835 }, 11836 "forks_count": { 11837 "type": "integer" 11838 }, 11839 "watchers": { 11840 "type": "integer" 11841 }, 11842 "watchers_count": { 11843 "type": "integer" 11844 }, 11845 "size": { 11846 "type": "integer" 11847 }, 11848 "master_branch": { 11849 "type": "string" 11850 }, 11851 "open_issues": { 11852 "type": "integer" 11853 }, 11854 "open_issues_count": { 11855 "type": "integer" 11856 }, 11857 "pushed_at": { 11858 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 11859 "type": "string" 11860 }, 11861 "created_at": { 11862 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 11863 "type": "string" 11864 }, 11865 "updated_at": { 11866 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 11867 "type": "string" 11868 } 11869 }, 11870 "type": "object" 11871 } 11872 }, 11873 "type": "object" 11874 }, 11875 "base": { 11876 "properties": { 11877 "label": { 11878 "type": "string" 11879 }, 11880 "ref": { 11881 "type": "string" 11882 }, 11883 "sha": { 11884 "type": "string" 11885 }, 11886 "user": { 11887 "properties": { 11888 "login": { 11889 "type": "string" 11890 }, 11891 "id": { 11892 "type": "integer" 11893 }, 11894 "avatar_url": { 11895 "type": "string" 11896 }, 11897 "gravatar_id": { 11898 "type": "string" 11899 }, 11900 "url": { 11901 "type": "string" 11902 } 11903 }, 11904 "type": "object" 11905 }, 11906 "repo": { 11907 "properties": { 11908 "id": { 11909 "type": "integer" 11910 }, 11911 "owner": { 11912 "properties": { 11913 "login": { 11914 "type": "string" 11915 }, 11916 "id": { 11917 "type": "integer" 11918 }, 11919 "avatar_url": { 11920 "type": "string" 11921 }, 11922 "gravatar_id": { 11923 "type": "string" 11924 }, 11925 "url": { 11926 "type": "string" 11927 } 11928 }, 11929 "type": "object" 11930 }, 11931 "name": { 11932 "type": "string" 11933 }, 11934 "full_name": { 11935 "type": "string" 11936 }, 11937 "description": { 11938 "type": "string" 11939 }, 11940 "private": { 11941 "type": "boolean" 11942 }, 11943 "fork": { 11944 "type": "boolean" 11945 }, 11946 "url": { 11947 "type": "string" 11948 }, 11949 "html_url": { 11950 "type": "string" 11951 }, 11952 "clone_url": { 11953 "type": "string" 11954 }, 11955 "git_url": { 11956 "type": "string" 11957 }, 11958 "ssh_url": { 11959 "type": "string" 11960 }, 11961 "svn_url": { 11962 "type": "string" 11963 }, 11964 "mirror_url": { 11965 "type": "string" 11966 }, 11967 "homepage": { 11968 "type": "string" 11969 }, 11970 "language": { 11971 "type": "string" 11972 }, 11973 "forks": { 11974 "type": "integer" 11975 }, 11976 "forks_count": { 11977 "type": "integer" 11978 }, 11979 "watchers": { 11980 "type": "integer" 11981 }, 11982 "watchers_count": { 11983 "type": "integer" 11984 }, 11985 "size": { 11986 "type": "integer" 11987 }, 11988 "master_branch": { 11989 "type": "string" 11990 }, 11991 "open_issues": { 11992 "type": "integer" 11993 }, 11994 "open_issues_count": { 11995 "type": "integer" 11996 }, 11997 "pushed_at": { 11998 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 11999 "type": "string" 12000 }, 12001 "created_at": { 12002 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 12003 "type": "string" 12004 }, 12005 "updated_at": { 12006 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 12007 "type": "string" 12008 } 12009 }, 12010 "type": "object" 12011 } 12012 }, 12013 "type": "object" 12014 }, 12015 "_links": { 12016 "properties": { 12017 "self": { 12018 "properties": { 12019 "href": { 12020 "type": "string" 12021 } 12022 }, 12023 "type": "object" 12024 }, 12025 "html": { 12026 "properties": { 12027 "href": { 12028 "type": "string" 12029 } 12030 }, 12031 "type": "object" 12032 }, 12033 "comments": { 12034 "properties": { 12035 "href": { 12036 "type": "string" 12037 } 12038 }, 12039 "type": "object" 12040 }, 12041 "review_comments": { 12042 "properties": { 12043 "href": { 12044 "type": "string" 12045 } 12046 }, 12047 "type": "object" 12048 } 12049 }, 12050 "type": "object" 12051 }, 12052 "user": { 12053 "properties": { 12054 "login": { 12055 "type": "string" 12056 }, 12057 "id": { 12058 "type": "integer" 12059 }, 12060 "avatar_url": { 12061 "type": "string" 12062 }, 12063 "gravatar_id": { 12064 "type": "string" 12065 }, 12066 "url": { 12067 "type": "string" 12068 } 12069 }, 12070 "type": "object" 12071 } 12072 }, 12073 "type": "object" 12074 } 12075 ] 12076 } 12077 example: | 12078 [ 12079 { 12080 "url": "https://api.github.com/octocat/Hello-World/pulls/1", 12081 "html_url": "https://github.com/octocat/Hello-World/pulls/1", 12082 "diff_url": "https://github.com/octocat/Hello-World/pulls/1.diff", 12083 "patch_url": "https://github.com/octocat/Hello-World/pulls/1.patch", 12084 "issue_url": "https://github.com/octocat/Hello-World/issue/1", 12085 "number": 1, 12086 "state": "open", 12087 "title": "new-feature", 12088 "body": "Please pull these awesome changes", 12089 "created_at": "2011-01-26T19:01:12Z", 12090 "updated_at": "2011-01-26T19:01:12Z", 12091 "closed_at": "2011-01-26T19:01:12Z", 12092 "merged_at": "2011-01-26T19:01:12Z", 12093 "head": { 12094 "label": "new-topic", 12095 "ref": "new-topic", 12096 "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 12097 "user": { 12098 "login": "octocat", 12099 "id": 1, 12100 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 12101 "gravatar_id": "somehexcode", 12102 "url": "https://api.github.com/users/octocat" 12103 }, 12104 "repo": { 12105 "id": 1296269, 12106 "owner": { 12107 "login": "octocat", 12108 "id": 1, 12109 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 12110 "gravatar_id": "somehexcode", 12111 "url": "https://api.github.com/users/octocat" 12112 }, 12113 "name": "Hello-World", 12114 "full_name": "octocat/Hello-World", 12115 "description": "This your first repo!", 12116 "private": false, 12117 "fork": false, 12118 "url": "https://api.github.com/repos/octocat/Hello-World", 12119 "html_url": "https://github.com/octocat/Hello-World", 12120 "clone_url": "https://github.com/octocat/Hello-World.git", 12121 "git_url": "git://github.com/octocat/Hello-World.git", 12122 "ssh_url": "git@github.com:octocat/Hello-World.git", 12123 "svn_url": "https://svn.github.com/octocat/Hello-World", 12124 "mirror_url": "git://git.example.com/octocat/Hello-World", 12125 "homepage": "https://github.com", 12126 "language": null, 12127 "forks": 9, 12128 "forks_count": 9, 12129 "watchers": 80, 12130 "watchers_count": 80, 12131 "size": 108, 12132 "master_branch": "master", 12133 "open_issues": 0, 12134 "open_issues_count": 0, 12135 "pushed_at": "2011-01-26T19:06:43Z", 12136 "created_at": "2011-01-26T19:01:12Z", 12137 "updated_at": "2011-01-26T19:14:43Z" 12138 } 12139 }, 12140 "base": { 12141 "label": "master", 12142 "ref": "master", 12143 "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 12144 "user": { 12145 "login": "octocat", 12146 "id": 1, 12147 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 12148 "gravatar_id": "somehexcode", 12149 "url": "https://api.github.com/users/octocat" 12150 }, 12151 "repo": { 12152 "id": 1296269, 12153 "owner": { 12154 "login": "octocat", 12155 "id": 1, 12156 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 12157 "gravatar_id": "somehexcode", 12158 "url": "https://api.github.com/users/octocat" 12159 }, 12160 "name": "Hello-World", 12161 "full_name": "octocat/Hello-World", 12162 "description": "This your first repo!", 12163 "private": false, 12164 "fork": false, 12165 "url": "https://api.github.com/repos/octocat/Hello-World", 12166 "html_url": "https://github.com/octocat/Hello-World", 12167 "clone_url": "https://github.com/octocat/Hello-World.git", 12168 "git_url": "git://github.com/octocat/Hello-World.git", 12169 "ssh_url": "git@github.com:octocat/Hello-World.git", 12170 "svn_url": "https://svn.github.com/octocat/Hello-World", 12171 "mirror_url": "git://git.example.com/octocat/Hello-World", 12172 "homepage": "https://github.com", 12173 "language": null, 12174 "forks": 9, 12175 "forks_count": 9, 12176 "watchers": 80, 12177 "watchers_count": 80, 12178 "size": 108, 12179 "master_branch": "master", 12180 "open_issues": 0, 12181 "open_issues_count": 0, 12182 "pushed_at": "2011-01-26T19:06:43Z", 12183 "created_at": "2011-01-26T19:01:12Z", 12184 "updated_at": "2011-01-26T19:14:43Z" 12185 } 12186 }, 12187 "_links": { 12188 "self": { 12189 "href": "https://api.github.com/octocat/Hello-World/pulls/1" 12190 }, 12191 "html": { 12192 "href": "https://github.com/octocat/Hello-World/pull/1" 12193 }, 12194 "comments": { 12195 "href": "https://api.github.com/octocat/Hello-World/issues/1/comments" 12196 }, 12197 "review_comments": { 12198 "href": "https://api.github.com/octocat/Hello-World/pulls/1/comments" 12199 } 12200 }, 12201 "user": { 12202 "login": "octocat", 12203 "id": 1, 12204 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 12205 "gravatar_id": "somehexcode", 12206 "url": "https://api.github.com/users/octocat" 12207 } 12208 } 12209 ] 12210 /{number}: 12211 uriParameters: 12212 number: 12213 description: Id of a pull. 12214 type: integer 12215 type: item 12216 get: 12217 description: Get a single pull request. 12218 responses: 12219 200: 12220 body: 12221 schema: | 12222 { 12223 "$schema": "http://json-schema.org/draft-03/schema", 12224 "type": "object", 12225 "properties": { 12226 "url": { 12227 "type": "string" 12228 }, 12229 "html_url": { 12230 "type": "string" 12231 }, 12232 "diff_url": { 12233 "type": "string" 12234 }, 12235 "patch_url": { 12236 "type": "string" 12237 }, 12238 "issue_url": { 12239 "type": "string" 12240 }, 12241 "number": { 12242 "type": "integer" 12243 }, 12244 "state": { 12245 "enum": [ 12246 "open", 12247 "closed" 12248 ] 12249 }, 12250 "title": { 12251 "type": "string" 12252 }, 12253 "body": { 12254 "type": "string" 12255 }, 12256 "created_at": { 12257 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 12258 "type": "string" 12259 }, 12260 "updated_at": { 12261 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 12262 "type": "string" 12263 }, 12264 "closed_at": { 12265 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 12266 "type": "string" 12267 }, 12268 "merged_at": { 12269 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 12270 "type": "string" 12271 }, 12272 "head": { 12273 "properties": { 12274 "label": { 12275 "type": "string" 12276 }, 12277 "ref": { 12278 "type": "string" 12279 }, 12280 "sha": { 12281 "type": "string" 12282 }, 12283 "user": { 12284 "properties": { 12285 "login": { 12286 "type": "string" 12287 }, 12288 "id": { 12289 "type": "integer" 12290 }, 12291 "avatar_url": { 12292 "type": "string" 12293 }, 12294 "gravatar_id": { 12295 "type": "string" 12296 }, 12297 "url": { 12298 "type": "string" 12299 } 12300 }, 12301 "type": "object" 12302 }, 12303 "repo": { 12304 "properties": { 12305 "id": { 12306 "type": "integer" 12307 }, 12308 "owner": { 12309 "properties": { 12310 "login": { 12311 "type": "string" 12312 }, 12313 "id": { 12314 "type": "integer" 12315 }, 12316 "avatar_url": { 12317 "type": "string" 12318 }, 12319 "gravatar_id": { 12320 "type": "string" 12321 }, 12322 "url": { 12323 "type": "string" 12324 } 12325 }, 12326 "type": "object" 12327 }, 12328 "name": { 12329 "type": "string" 12330 }, 12331 "full_name": { 12332 "type": "string" 12333 }, 12334 "description": { 12335 "type": "string" 12336 }, 12337 "private": { 12338 "type": "boolean" 12339 }, 12340 "fork": { 12341 "type": "boolean" 12342 }, 12343 "url": { 12344 "type": "string" 12345 }, 12346 "html_url": { 12347 "type": "string" 12348 }, 12349 "clone_url": { 12350 "type": "string" 12351 }, 12352 "git_url": { 12353 "type": "string" 12354 }, 12355 "ssh_url": { 12356 "type": "string" 12357 }, 12358 "svn_url": { 12359 "type": "string" 12360 }, 12361 "mirror_url": { 12362 "type": "string" 12363 }, 12364 "homepage": { 12365 "type": "string" 12366 }, 12367 "language": { 12368 "type": "string" 12369 }, 12370 "forks": { 12371 "type": "integer" 12372 }, 12373 "forks_count": { 12374 "type": "integer" 12375 }, 12376 "watchers": { 12377 "type": "integer" 12378 }, 12379 "watchers_count": { 12380 "type": "integer" 12381 }, 12382 "size": { 12383 "type": "integer" 12384 }, 12385 "master_branch": { 12386 "type": "string" 12387 }, 12388 "open_issues": { 12389 "type": "integer" 12390 }, 12391 "open_issues_count": { 12392 "type": "integer" 12393 }, 12394 "pushed_at": { 12395 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 12396 "type": "string" 12397 }, 12398 "created_at": { 12399 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 12400 "type": "string" 12401 }, 12402 "updated_at": { 12403 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 12404 "type": "string" 12405 } 12406 }, 12407 "type": "object" 12408 } 12409 }, 12410 "type": "object" 12411 }, 12412 "base": { 12413 "properties": { 12414 "label": { 12415 "type": "string" 12416 }, 12417 "ref": { 12418 "type": "string" 12419 }, 12420 "sha": { 12421 "type": "string" 12422 }, 12423 "user": { 12424 "properties": { 12425 "login": { 12426 "type": "string" 12427 }, 12428 "id": { 12429 "type": "integer" 12430 }, 12431 "avatar_url": { 12432 "type": "string" 12433 }, 12434 "gravatar_id": { 12435 "type": "string" 12436 }, 12437 "url": { 12438 "type": "string" 12439 } 12440 }, 12441 "type": "object" 12442 }, 12443 "repo": { 12444 "properties": { 12445 "id": { 12446 "type": "integer" 12447 }, 12448 "owner": { 12449 "properties": { 12450 "login": { 12451 "type": "string" 12452 }, 12453 "id": { 12454 "type": "integer" 12455 }, 12456 "avatar_url": { 12457 "type": "string" 12458 }, 12459 "gravatar_id": { 12460 "type": "string" 12461 }, 12462 "url": { 12463 "type": "string" 12464 } 12465 }, 12466 "type": "object" 12467 }, 12468 "name": { 12469 "type": "string" 12470 }, 12471 "full_name": { 12472 "type": "string" 12473 }, 12474 "description": { 12475 "type": "string" 12476 }, 12477 "private": { 12478 "type": "boolean" 12479 }, 12480 "fork": { 12481 "type": "boolean" 12482 }, 12483 "url": { 12484 "type": "string" 12485 }, 12486 "html_url": { 12487 "type": "string" 12488 }, 12489 "clone_url": { 12490 "type": "string" 12491 }, 12492 "git_url": { 12493 "type": "string" 12494 }, 12495 "ssh_url": { 12496 "type": "string" 12497 }, 12498 "svn_url": { 12499 "type": "string" 12500 }, 12501 "mirror_url": { 12502 "type": "string" 12503 }, 12504 "homepage": { 12505 "type": "string" 12506 }, 12507 "language": { 12508 "type": "string" 12509 }, 12510 "forks": { 12511 "type": "integer" 12512 }, 12513 "forks_count": { 12514 "type": "integer" 12515 }, 12516 "watchers": { 12517 "type": "integer" 12518 }, 12519 "watchers_count": { 12520 "type": "integer" 12521 }, 12522 "size": { 12523 "type": "integer" 12524 }, 12525 "master_branch": { 12526 "type": "string" 12527 }, 12528 "open_issues": { 12529 "type": "integer" 12530 }, 12531 "open_issues_count": { 12532 "type": "integer" 12533 }, 12534 "pushed_at": { 12535 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 12536 "type": "string" 12537 }, 12538 "created_at": { 12539 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 12540 "type": "string" 12541 }, 12542 "updated_at": { 12543 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 12544 "type": "string" 12545 } 12546 }, 12547 "type": "object" 12548 } 12549 }, 12550 "type": "object" 12551 }, 12552 "_links": { 12553 "properties": { 12554 "self": { 12555 "properties": { 12556 "href": { 12557 "type": "string" 12558 } 12559 }, 12560 "type": "object" 12561 }, 12562 "html": { 12563 "properties": { 12564 "href": { 12565 "type": "string" 12566 } 12567 }, 12568 "type": "object" 12569 }, 12570 "comments": { 12571 "properties": { 12572 "href": { 12573 "type": "string" 12574 } 12575 }, 12576 "type": "object" 12577 }, 12578 "review_comments": { 12579 "properties": { 12580 "href": { 12581 "type": "string" 12582 } 12583 }, 12584 "type": "object" 12585 } 12586 }, 12587 "type": "object" 12588 }, 12589 "user": { 12590 "properties": { 12591 "login": { 12592 "type": "string" 12593 }, 12594 "id": { 12595 "type": "integer" 12596 }, 12597 "avatar_url": { 12598 "type": "string" 12599 }, 12600 "gravatar_id": { 12601 "type": "string" 12602 }, 12603 "url": { 12604 "type": "string" 12605 } 12606 }, 12607 "type": "object" 12608 } 12609 } 12610 } 12611 example: | 12612 { 12613 "url": "https://api.github.com/octocat/Hello-World/pulls/1", 12614 "html_url": "https://github.com/octocat/Hello-World/pulls/1", 12615 "diff_url": "https://github.com/octocat/Hello-World/pulls/1.diff", 12616 "patch_url": "https://github.com/octocat/Hello-World/pulls/1.patch", 12617 "issue_url": "https://github.com/octocat/Hello-World/issue/1", 12618 "number": 1, 12619 "state": "open", 12620 "title": "new-feature", 12621 "body": "Please pull these awesome changes", 12622 "created_at": "2011-01-26T19:01:12Z", 12623 "updated_at": "2011-01-26T19:01:12Z", 12624 "closed_at": "2011-01-26T19:01:12Z", 12625 "merged_at": "2011-01-26T19:01:12Z", 12626 "head": { 12627 "label": "new-topic", 12628 "ref": "new-topic", 12629 "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 12630 "user": { 12631 "login": "octocat", 12632 "id": 1, 12633 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 12634 "gravatar_id": "somehexcode", 12635 "url": "https://api.github.com/users/octocat" 12636 }, 12637 "repo": { 12638 "id": 1296269, 12639 "owner": { 12640 "login": "octocat", 12641 "id": 1, 12642 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 12643 "gravatar_id": "somehexcode", 12644 "url": "https://api.github.com/users/octocat" 12645 }, 12646 "name": "Hello-World", 12647 "full_name": "octocat/Hello-World", 12648 "description": "This your first repo!", 12649 "private": false, 12650 "fork": false, 12651 "url": "https://api.github.com/repos/octocat/Hello-World", 12652 "html_url": "https://github.com/octocat/Hello-World", 12653 "clone_url": "https://github.com/octocat/Hello-World.git", 12654 "git_url": "git://github.com/octocat/Hello-World.git", 12655 "ssh_url": "git@github.com:octocat/Hello-World.git", 12656 "svn_url": "https://svn.github.com/octocat/Hello-World", 12657 "mirror_url": "git://git.example.com/octocat/Hello-World", 12658 "homepage": "https://github.com", 12659 "language": null, 12660 "forks": 9, 12661 "forks_count": 9, 12662 "watchers": 80, 12663 "watchers_count": 80, 12664 "size": 108, 12665 "master_branch": "master", 12666 "open_issues": 0, 12667 "open_issues_count": 0, 12668 "pushed_at": "2011-01-26T19:06:43Z", 12669 "created_at": "2011-01-26T19:01:12Z", 12670 "updated_at": "2011-01-26T19:14:43Z" 12671 } 12672 }, 12673 "base": { 12674 "label": "master", 12675 "ref": "master", 12676 "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 12677 "user": { 12678 "login": "octocat", 12679 "id": 1, 12680 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 12681 "gravatar_id": "somehexcode", 12682 "url": "https://api.github.com/users/octocat" 12683 }, 12684 "repo": { 12685 "id": 1296269, 12686 "owner": { 12687 "login": "octocat", 12688 "id": 1, 12689 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 12690 "gravatar_id": "somehexcode", 12691 "url": "https://api.github.com/users/octocat" 12692 }, 12693 "name": "Hello-World", 12694 "full_name": "octocat/Hello-World", 12695 "description": "This your first repo!", 12696 "private": false, 12697 "fork": false, 12698 "url": "https://api.github.com/repos/octocat/Hello-World", 12699 "html_url": "https://github.com/octocat/Hello-World", 12700 "clone_url": "https://github.com/octocat/Hello-World.git", 12701 "git_url": "git://github.com/octocat/Hello-World.git", 12702 "ssh_url": "git@github.com:octocat/Hello-World.git", 12703 "svn_url": "https://svn.github.com/octocat/Hello-World", 12704 "mirror_url": "git://git.example.com/octocat/Hello-World", 12705 "homepage": "https://github.com", 12706 "language": null, 12707 "forks": 9, 12708 "forks_count": 9, 12709 "watchers": 80, 12710 "watchers_count": 80, 12711 "size": 108, 12712 "master_branch": "master", 12713 "open_issues": 0, 12714 "open_issues_count": 0, 12715 "pushed_at": "2011-01-26T19:06:43Z", 12716 "created_at": "2011-01-26T19:01:12Z", 12717 "updated_at": "2011-01-26T19:14:43Z" 12718 } 12719 }, 12720 "_links": { 12721 "self": { 12722 "href": "https://api.github.com/octocat/Hello-World/pulls/1" 12723 }, 12724 "html": { 12725 "href": "https://github.com/octocat/Hello-World/pull/1" 12726 }, 12727 "comments": { 12728 "href": "https://api.github.com/octocat/Hello-World/issues/1/comments" 12729 }, 12730 "review_comments": { 12731 "href": "https://api.github.com/octocat/Hello-World/pulls/1/comments" 12732 } 12733 }, 12734 "user": { 12735 "login": "octocat", 12736 "id": 1, 12737 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 12738 "gravatar_id": "somehexcode", 12739 "url": "https://api.github.com/users/octocat" 12740 }, 12741 "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", 12742 "merged": false, 12743 "mergeable": true, 12744 "merged_by": { 12745 "login": "octocat", 12746 "id": 1, 12747 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 12748 "gravatar_id": "somehexcode", 12749 "url": "https://api.github.com/users/octocat" 12750 }, 12751 "comments": 10, 12752 "commits": 3, 12753 "additions": 100, 12754 "deletions": 3, 12755 "changed_files": 5 12756 } 12757 patch: 12758 description: Update a pull request. 12759 body: 12760 application/json: 12761 schema: | 12762 { 12763 "$schema": "http://json-schema.org/draft-03/schema", 12764 "type": "object", 12765 "properties": { 12766 "title": { 12767 "type": "string" 12768 }, 12769 "body": { 12770 "type": "string" 12771 }, 12772 "state": { 12773 "enum": [ "open", "closed" ] 12774 } 12775 } 12776 } 12777 responses: 12778 200: 12779 body: 12780 schema: | 12781 { 12782 "$schema": "http://json-schema.org/draft-03/schema", 12783 "type": "object", 12784 "properties": { 12785 "id": { 12786 "type": "integer" 12787 }, 12788 "owner": { 12789 "properties": { 12790 "login": { 12791 "type": "string" 12792 }, 12793 "id": { 12794 "type": "integer" 12795 }, 12796 "avatar_url": { 12797 "type": "string" 12798 }, 12799 "gravatar_id": { 12800 "type": "string" 12801 }, 12802 "url": { 12803 "type": "string" 12804 } 12805 }, 12806 "type": "object" 12807 }, 12808 "name": { 12809 "type": "string" 12810 }, 12811 "full_name": { 12812 "type": "string" 12813 }, 12814 "description": { 12815 "type": "string" 12816 }, 12817 "private": { 12818 "type": "boolean" 12819 }, 12820 "fork": { 12821 "type": "boolean" 12822 }, 12823 "url": { 12824 "type": "string" 12825 }, 12826 "html_url": { 12827 "type": "string" 12828 }, 12829 "clone_url": { 12830 "type": "string" 12831 }, 12832 "git_url": { 12833 "type": "string" 12834 }, 12835 "ssh_url": { 12836 "type": "string" 12837 }, 12838 "svn_url": { 12839 "type": "string" 12840 }, 12841 "mirror_url": { 12842 "type": "string" 12843 }, 12844 "homepage": { 12845 "type": "string" 12846 }, 12847 "language": { 12848 "type": "string" 12849 }, 12850 "forks": { 12851 "type": "integer" 12852 }, 12853 "forks_count": { 12854 "type": "integer" 12855 }, 12856 "watchers": { 12857 "type": "integer" 12858 }, 12859 "watchers_count": { 12860 "type": "integer" 12861 }, 12862 "size": { 12863 "type": "integer" 12864 }, 12865 "master_branch": { 12866 "type": "string" 12867 }, 12868 "open_issues": { 12869 "type": "integer" 12870 }, 12871 "open_issues_count": { 12872 "type": "integer" 12873 }, 12874 "pushed_at": { 12875 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 12876 "type": "string" 12877 }, 12878 "created_at": { 12879 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 12880 "type": "string" 12881 }, 12882 "updated_at": { 12883 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 12884 "type": "string" 12885 }, 12886 "organization": { 12887 "properties": { 12888 "login": { 12889 "type": "string" 12890 }, 12891 "id": { 12892 "type": "integer" 12893 }, 12894 "avatar_url": { 12895 "type": "string" 12896 }, 12897 "gravatar_id": { 12898 "type": "string" 12899 }, 12900 "url": { 12901 "type": "string" 12902 }, 12903 "type": { 12904 "type": "string" 12905 } 12906 }, 12907 "type": "object" 12908 }, 12909 "parent": { 12910 "description": "Is present when the repo is a fork. Parent is the repo this repo was forked from.", 12911 "properties": { 12912 "id": { 12913 "type": "integer" 12914 }, 12915 "owner": { 12916 "properties": { 12917 "login": { 12918 "type": "string" 12919 }, 12920 "id": { 12921 "type": "integer" 12922 }, 12923 "avatar_url": { 12924 "type": "string" 12925 }, 12926 "gravatar_id": { 12927 "type": "string" 12928 }, 12929 "url": { 12930 "type": "string" 12931 } 12932 }, 12933 "type": "object" 12934 }, 12935 "name": { 12936 "type": "string" 12937 }, 12938 "full_name": { 12939 "type": "string" 12940 }, 12941 "description": { 12942 "type": "string" 12943 }, 12944 "private": { 12945 "type": "boolean" 12946 }, 12947 "fork": { 12948 "type": "boolean" 12949 }, 12950 "url": { 12951 "type": "string" 12952 }, 12953 "html_url": { 12954 "type": "string" 12955 }, 12956 "clone_url": { 12957 "type": "string" 12958 }, 12959 "git_url": { 12960 "type": "string" 12961 }, 12962 "ssh_url": { 12963 "type": "string" 12964 }, 12965 "svn_url": { 12966 "type": "string" 12967 }, 12968 "mirror_url": { 12969 "type": "string" 12970 }, 12971 "homepage": { 12972 "type": "string" 12973 }, 12974 "language": { 12975 "type": "string" 12976 }, 12977 "forks": { 12978 "type": "integer" 12979 }, 12980 "forks_count": { 12981 "type": "integer" 12982 }, 12983 "watchers": { 12984 "type": "integer" 12985 }, 12986 "watchers_count": { 12987 "type": "integer" 12988 }, 12989 "size": { 12990 "type": "integer" 12991 }, 12992 "master_branch": { 12993 "type": "string" 12994 }, 12995 "open_issues": { 12996 "type": "integer" 12997 }, 12998 "open_issues_count": { 12999 "type": "integer" 13000 }, 13001 "pushed_at": { 13002 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 13003 "type": "string" 13004 }, 13005 "created_at": { 13006 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 13007 "type": "string" 13008 }, 13009 "updated_at": { 13010 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 13011 "type": "string" 13012 } 13013 }, 13014 "type": "object" 13015 }, 13016 "source": { 13017 "description": "Is present when the repo is a fork. Source is the ultimate source for the network.", 13018 "properties": { 13019 "id": { 13020 "type": "integer" 13021 }, 13022 "owner": { 13023 "properties": { 13024 "login": { 13025 "type": "string" 13026 }, 13027 "id": { 13028 "type": "integer" 13029 }, 13030 "avatar_url": { 13031 "type": "string" 13032 }, 13033 "gravatar_id": { 13034 "type": "string" 13035 }, 13036 "url": { 13037 "type": "string" 13038 } 13039 }, 13040 "type": "object" 13041 }, 13042 "type": "object" 13043 }, 13044 "name": { 13045 "type": "string" 13046 }, 13047 "full_name": { 13048 "type": "string" 13049 }, 13050 "description": { 13051 "type": "string" 13052 }, 13053 "private": { 13054 "type": "boolean" 13055 }, 13056 "fork": { 13057 "type": "boolean" 13058 }, 13059 "url": { 13060 "type": "string" 13061 }, 13062 "html_url": { 13063 "type": "string" 13064 }, 13065 "clone_url": { 13066 "type": "string" 13067 }, 13068 "git_url": { 13069 "type": "string" 13070 }, 13071 "ssh_url": { 13072 "type": "string" 13073 }, 13074 "svn_url": { 13075 "type": "string" 13076 }, 13077 "mirror_url": { 13078 "type": "string" 13079 }, 13080 "homepage": { 13081 "type": "string" 13082 }, 13083 "language": { 13084 "type": "string" 13085 }, 13086 "forks": { 13087 "type": "integer" 13088 }, 13089 "forks_count": { 13090 "type": "integer" 13091 }, 13092 "watchers": { 13093 "type": "integer" 13094 }, 13095 "watchers_count": { 13096 "type": "integer" 13097 }, 13098 "size": { 13099 "type": "integer" 13100 }, 13101 "master_branch": { 13102 "type": "string" 13103 }, 13104 "open_issues": { 13105 "type": "integer" 13106 }, 13107 "open_issues_count": { 13108 "type": "integer" 13109 }, 13110 "pushed_at": { 13111 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 13112 "type": "string" 13113 }, 13114 "created_at": { 13115 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 13116 "type": "string" 13117 }, 13118 "updated_at": { 13119 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 13120 "type": "string" 13121 } 13122 }, 13123 "has_issues": { 13124 "type": "boolean" 13125 }, 13126 "has_wiki": { 13127 "type": "boolean" 13128 }, 13129 "has_downloads": { 13130 "type": "boolean" 13131 } 13132 } 13133 } 13134 example: | 13135 { 13136 "id": 1296269, 13137 "owner": { 13138 "login": "octocat", 13139 "id": 1, 13140 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 13141 "gravatar_id": "somehexcode", 13142 "url": "https://api.github.com/users/octocat" 13143 }, 13144 "name": "Hello-World", 13145 "full_name": "octocat/Hello-World", 13146 "description": "This your first repo!", 13147 "private": false, 13148 "fork": false, 13149 "url": "https://api.github.com/repos/octocat/Hello-World", 13150 "html_url": "https://github.com/octocat/Hello-World", 13151 "clone_url": "https://github.com/octocat/Hello-World.git", 13152 "git_url": "git://github.com/octocat/Hello-World.git", 13153 "ssh_url": "git@github.com:octocat/Hello-World.git", 13154 "svn_url": "https://svn.github.com/octocat/Hello-World", 13155 "mirror_url": "git://git.example.com/octocat/Hello-World", 13156 "homepage": "https://github.com", 13157 "language": null, 13158 "forks": 9, 13159 "forks_count": 9, 13160 "watchers": 80, 13161 "watchers_count": 80, 13162 "size": 108, 13163 "master_branch": "master", 13164 "open_issues": 0, 13165 "open_issues_count": 0, 13166 "pushed_at": "2011-01-26T19:06:43Z", 13167 "created_at": "2011-01-26T19:01:12Z", 13168 "updated_at": "2011-01-26T19:14:43Z", 13169 "organization": { 13170 "login": "octocat", 13171 "id": 1, 13172 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 13173 "gravatar_id": "somehexcode", 13174 "url": "https://api.github.com/users/octocat", 13175 "type": "Organization" 13176 }, 13177 "parent": { 13178 "id": 1296269, 13179 "owner": { 13180 "login": "octocat", 13181 "id": 1, 13182 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 13183 "gravatar_id": "somehexcode", 13184 "url": "https://api.github.com/users/octocat" 13185 }, 13186 "name": "Hello-World", 13187 "full_name": "octocat/Hello-World", 13188 "description": "This your first repo!", 13189 "private": false, 13190 "fork": true, 13191 "url": "https://api.github.com/repos/octocat/Hello-World", 13192 "html_url": "https://github.com/octocat/Hello-World", 13193 "clone_url": "https://github.com/octocat/Hello-World.git", 13194 "git_url": "git://github.com/octocat/Hello-World.git", 13195 "ssh_url": "git@github.com:octocat/Hello-World.git", 13196 "svn_url": "https://svn.github.com/octocat/Hello-World", 13197 "mirror_url": "git://git.example.com/octocat/Hello-World", 13198 "homepage": "https://github.com", 13199 "language": null, 13200 "forks": 9, 13201 "forks_count": 9, 13202 "watchers": 80, 13203 "watchers_count": 80, 13204 "size": 108, 13205 "master_branch": "master", 13206 "open_issues": 0, 13207 "open_issues_count": 0, 13208 "pushed_at": "2011-01-26T19:06:43Z", 13209 "created_at": "2011-01-26T19:01:12Z", 13210 "updated_at": "2011-01-26T19:14:43Z" 13211 }, 13212 "source": { 13213 "id": 1296269, 13214 "owner": { 13215 "login": "octocat", 13216 "id": 1, 13217 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 13218 "gravatar_id": "somehexcode", 13219 "url": "https://api.github.com/users/octocat" 13220 }, 13221 "name": "Hello-World", 13222 "full_name": "octocat/Hello-World", 13223 "description": "This your first repo!", 13224 "private": false, 13225 "fork": true, 13226 "url": "https://api.github.com/repos/octocat/Hello-World", 13227 "html_url": "https://github.com/octocat/Hello-World", 13228 "clone_url": "https://github.com/octocat/Hello-World.git", 13229 "git_url": "git://github.com/octocat/Hello-World.git", 13230 "ssh_url": "git@github.com:octocat/Hello-World.git", 13231 "svn_url": "https://svn.github.com/octocat/Hello-World", 13232 "mirror_url": "git://git.example.com/octocat/Hello-World", 13233 "homepage": "https://github.com", 13234 "language": null, 13235 "forks": 9, 13236 "forks_count": 9, 13237 "watchers": 80, 13238 "watchers_count": 80, 13239 "size": 108, 13240 "master_branch": "master", 13241 "open_issues": 0, 13242 "open_issues_count": 0, 13243 "pushed_at": "2011-01-26T19:06:43Z", 13244 "created_at": "2011-01-26T19:01:12Z", 13245 "updated_at": "2011-01-26T19:14:43Z" 13246 }, 13247 "has_issues": true, 13248 "has_wiki": true, 13249 "has_downloads": true 13250 } 13251 # Files 13252 /files: 13253 type: item 13254 get: 13255 description: List pull requests files. 13256 responses: 13257 200: 13258 body: 13259 schema: | 13260 { 13261 "$schema": "http://json-schema.org/draft-03/schema", 13262 "type": "array", 13263 "list": [ 13264 { 13265 "properties": { 13266 "url": { 13267 "type": "string" 13268 }, 13269 "html_url": { 13270 "type": "string" 13271 }, 13272 "diff_url": { 13273 "type": "string" 13274 }, 13275 "patch_url": { 13276 "type": "string" 13277 }, 13278 "issue_url": { 13279 "type": "string" 13280 }, 13281 "number": { 13282 "type": "integer" 13283 }, 13284 "state": { 13285 "enum": [ 13286 "open", 13287 "closed" 13288 ] 13289 }, 13290 "title": { 13291 "type": "string" 13292 }, 13293 "body": { 13294 "type": "string" 13295 }, 13296 "created_at": { 13297 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 13298 "type": "string" 13299 }, 13300 "updated_at": { 13301 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 13302 "type": "string" 13303 }, 13304 "closed_at": { 13305 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 13306 "type": "string" 13307 }, 13308 "merged_at": { 13309 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 13310 "type": "string" 13311 }, 13312 "head": { 13313 "properties": { 13314 "label": { 13315 "type": "string" 13316 }, 13317 "ref": { 13318 "type": "string" 13319 }, 13320 "sha": { 13321 "type": "string" 13322 }, 13323 "user": { 13324 "properties": { 13325 "login": { 13326 "type": "string" 13327 }, 13328 "id": { 13329 "type": "integer" 13330 }, 13331 "avatar_url": { 13332 "type": "string" 13333 }, 13334 "gravatar_id": { 13335 "type": "string" 13336 }, 13337 "url": { 13338 "type": "string" 13339 } 13340 }, 13341 "type": "object" 13342 }, 13343 "repo": { 13344 "properties": { 13345 "id": { 13346 "type": "integer" 13347 }, 13348 "owner": { 13349 "properties": { 13350 "login": { 13351 "type": "string" 13352 }, 13353 "id": { 13354 "type": "integer" 13355 }, 13356 "avatar_url": { 13357 "type": "string" 13358 }, 13359 "gravatar_id": { 13360 "type": "string" 13361 }, 13362 "url": { 13363 "type": "string" 13364 } 13365 }, 13366 "type": "object" 13367 }, 13368 "name": { 13369 "type": "string" 13370 }, 13371 "full_name": { 13372 "type": "string" 13373 }, 13374 "description": { 13375 "type": "string" 13376 }, 13377 "private": { 13378 "type": "boolean" 13379 }, 13380 "fork": { 13381 "type": "boolean" 13382 }, 13383 "url": { 13384 "type": "string" 13385 }, 13386 "html_url": { 13387 "type": "string" 13388 }, 13389 "clone_url": { 13390 "type": "string" 13391 }, 13392 "git_url": { 13393 "type": "string" 13394 }, 13395 "ssh_url": { 13396 "type": "string" 13397 }, 13398 "svn_url": { 13399 "type": "string" 13400 }, 13401 "mirror_url": { 13402 "type": "string" 13403 }, 13404 "homepage": { 13405 "type": "string" 13406 }, 13407 "language": { 13408 "type": "string" 13409 }, 13410 "forks": { 13411 "type": "integer" 13412 }, 13413 "forks_count": { 13414 "type": "integer" 13415 }, 13416 "watchers": { 13417 "type": "integer" 13418 }, 13419 "watchers_count": { 13420 "type": "integer" 13421 }, 13422 "size": { 13423 "type": "integer" 13424 }, 13425 "master_branch": { 13426 "type": "string" 13427 }, 13428 "open_issues": { 13429 "type": "integer" 13430 }, 13431 "open_issues_count": { 13432 "type": "integer" 13433 }, 13434 "pushed_at": { 13435 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 13436 "type": "string" 13437 }, 13438 "created_at": { 13439 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 13440 "type": "string" 13441 }, 13442 "updated_at": { 13443 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 13444 "type": "string" 13445 } 13446 }, 13447 "type": "object" 13448 } 13449 }, 13450 "type": "object" 13451 }, 13452 "base": { 13453 "properties": { 13454 "label": { 13455 "type": "string" 13456 }, 13457 "ref": { 13458 "type": "string" 13459 }, 13460 "sha": { 13461 "type": "string" 13462 }, 13463 "user": { 13464 "properties": { 13465 "login": { 13466 "type": "string" 13467 }, 13468 "id": { 13469 "type": "integer" 13470 }, 13471 "avatar_url": { 13472 "type": "string" 13473 }, 13474 "gravatar_id": { 13475 "type": "string" 13476 }, 13477 "url": { 13478 "type": "string" 13479 } 13480 }, 13481 "type": "object" 13482 }, 13483 "repo": { 13484 "properties": { 13485 "id": { 13486 "type": "integer" 13487 }, 13488 "owner": { 13489 "properties": { 13490 "login": { 13491 "type": "string" 13492 }, 13493 "id": { 13494 "type": "integer" 13495 }, 13496 "avatar_url": { 13497 "type": "string" 13498 }, 13499 "gravatar_id": { 13500 "type": "string" 13501 }, 13502 "url": { 13503 "type": "string" 13504 } 13505 }, 13506 "type": "object" 13507 }, 13508 "name": { 13509 "type": "string" 13510 }, 13511 "full_name": { 13512 "type": "string" 13513 }, 13514 "description": { 13515 "type": "string" 13516 }, 13517 "private": { 13518 "type": "boolean" 13519 }, 13520 "fork": { 13521 "type": "boolean" 13522 }, 13523 "url": { 13524 "type": "string" 13525 }, 13526 "html_url": { 13527 "type": "string" 13528 }, 13529 "clone_url": { 13530 "type": "string" 13531 }, 13532 "git_url": { 13533 "type": "string" 13534 }, 13535 "ssh_url": { 13536 "type": "string" 13537 }, 13538 "svn_url": { 13539 "type": "string" 13540 }, 13541 "mirror_url": { 13542 "type": "string" 13543 }, 13544 "homepage": { 13545 "type": "string" 13546 }, 13547 "language": { 13548 "type": "string" 13549 }, 13550 "forks": { 13551 "type": "integer" 13552 }, 13553 "forks_count": { 13554 "type": "integer" 13555 }, 13556 "watchers": { 13557 "type": "integer" 13558 }, 13559 "watchers_count": { 13560 "type": "integer" 13561 }, 13562 "size": { 13563 "type": "integer" 13564 }, 13565 "master_branch": { 13566 "type": "string" 13567 }, 13568 "open_issues": { 13569 "type": "integer" 13570 }, 13571 "open_issues_count": { 13572 "type": "integer" 13573 }, 13574 "pushed_at": { 13575 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 13576 "type": "string" 13577 }, 13578 "created_at": { 13579 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 13580 "type": "string" 13581 }, 13582 "updated_at": { 13583 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 13584 "type": "string" 13585 } 13586 }, 13587 "type": "object" 13588 } 13589 }, 13590 "type": "object" 13591 }, 13592 "_links": { 13593 "properties": { 13594 "self": { 13595 "properties": { 13596 "href": { 13597 "type": "string" 13598 } 13599 }, 13600 "type": "object" 13601 }, 13602 "html": { 13603 "properties": { 13604 "href": { 13605 "type": "string" 13606 } 13607 }, 13608 "type": "object" 13609 }, 13610 "comments": { 13611 "properties": { 13612 "href": { 13613 "type": "string" 13614 } 13615 }, 13616 "type": "object" 13617 }, 13618 "review_comments": { 13619 "properties": { 13620 "href": { 13621 "type": "string" 13622 } 13623 }, 13624 "type": "object" 13625 } 13626 }, 13627 "type": "object" 13628 }, 13629 "user": { 13630 "properties": { 13631 "login": { 13632 "type": "string" 13633 }, 13634 "id": { 13635 "type": "integer" 13636 }, 13637 "avatar_url": { 13638 "type": "string" 13639 }, 13640 "gravatar_id": { 13641 "type": "string" 13642 }, 13643 "url": { 13644 "type": "string" 13645 } 13646 }, 13647 "type": "object" 13648 } 13649 }, 13650 "type": "object" 13651 } 13652 ] 13653 } 13654 example: | 13655 [ 13656 { 13657 "url": "https://api.github.com/octocat/Hello-World/pulls/1", 13658 "html_url": "https://github.com/octocat/Hello-World/pulls/1", 13659 "diff_url": "https://github.com/octocat/Hello-World/pulls/1.diff", 13660 "patch_url": "https://github.com/octocat/Hello-World/pulls/1.patch", 13661 "issue_url": "https://github.com/octocat/Hello-World/issue/1", 13662 "number": 1, 13663 "state": "open", 13664 "title": "new-feature", 13665 "body": "Please pull these awesome changes", 13666 "created_at": "2011-01-26T19:01:12Z", 13667 "updated_at": "2011-01-26T19:01:12Z", 13668 "closed_at": "2011-01-26T19:01:12Z", 13669 "merged_at": "2011-01-26T19:01:12Z", 13670 "head": { 13671 "label": "new-topic", 13672 "ref": "new-topic", 13673 "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 13674 "user": { 13675 "login": "octocat", 13676 "id": 1, 13677 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 13678 "gravatar_id": "somehexcode", 13679 "url": "https://api.github.com/users/octocat" 13680 }, 13681 "repo": { 13682 "id": 1296269, 13683 "owner": { 13684 "login": "octocat", 13685 "id": 1, 13686 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 13687 "gravatar_id": "somehexcode", 13688 "url": "https://api.github.com/users/octocat" 13689 }, 13690 "name": "Hello-World", 13691 "full_name": "octocat/Hello-World", 13692 "description": "This your first repo!", 13693 "private": false, 13694 "fork": false, 13695 "url": "https://api.github.com/repos/octocat/Hello-World", 13696 "html_url": "https://github.com/octocat/Hello-World", 13697 "clone_url": "https://github.com/octocat/Hello-World.git", 13698 "git_url": "git://github.com/octocat/Hello-World.git", 13699 "ssh_url": "git@github.com:octocat/Hello-World.git", 13700 "svn_url": "https://svn.github.com/octocat/Hello-World", 13701 "mirror_url": "git://git.example.com/octocat/Hello-World", 13702 "homepage": "https://github.com", 13703 "language": null, 13704 "forks": 9, 13705 "forks_count": 9, 13706 "watchers": 80, 13707 "watchers_count": 80, 13708 "size": 108, 13709 "master_branch": "master", 13710 "open_issues": 0, 13711 "open_issues_count": 0, 13712 "pushed_at": "2011-01-26T19:06:43Z", 13713 "created_at": "2011-01-26T19:01:12Z", 13714 "updated_at": "2011-01-26T19:14:43Z" 13715 } 13716 }, 13717 "base": { 13718 "label": "master", 13719 "ref": "master", 13720 "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 13721 "user": { 13722 "login": "octocat", 13723 "id": 1, 13724 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 13725 "gravatar_id": "somehexcode", 13726 "url": "https://api.github.com/users/octocat" 13727 }, 13728 "repo": { 13729 "id": 1296269, 13730 "owner": { 13731 "login": "octocat", 13732 "id": 1, 13733 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 13734 "gravatar_id": "somehexcode", 13735 "url": "https://api.github.com/users/octocat" 13736 }, 13737 "name": "Hello-World", 13738 "full_name": "octocat/Hello-World", 13739 "description": "This your first repo!", 13740 "private": false, 13741 "fork": false, 13742 "url": "https://api.github.com/repos/octocat/Hello-World", 13743 "html_url": "https://github.com/octocat/Hello-World", 13744 "clone_url": "https://github.com/octocat/Hello-World.git", 13745 "git_url": "git://github.com/octocat/Hello-World.git", 13746 "ssh_url": "git@github.com:octocat/Hello-World.git", 13747 "svn_url": "https://svn.github.com/octocat/Hello-World", 13748 "mirror_url": "git://git.example.com/octocat/Hello-World", 13749 "homepage": "https://github.com", 13750 "language": null, 13751 "forks": 9, 13752 "forks_count": 9, 13753 "watchers": 80, 13754 "watchers_count": 80, 13755 "size": 108, 13756 "master_branch": "master", 13757 "open_issues": 0, 13758 "open_issues_count": 0, 13759 "pushed_at": "2011-01-26T19:06:43Z", 13760 "created_at": "2011-01-26T19:01:12Z", 13761 "updated_at": "2011-01-26T19:14:43Z" 13762 } 13763 }, 13764 "_links": { 13765 "self": { 13766 "href": "https://api.github.com/octocat/Hello-World/pulls/1" 13767 }, 13768 "html": { 13769 "href": "https://github.com/octocat/Hello-World/pull/1" 13770 }, 13771 "comments": { 13772 "href": "https://api.github.com/octocat/Hello-World/issues/1/comments" 13773 }, 13774 "review_comments": { 13775 "href": "https://api.github.com/octocat/Hello-World/pulls/1/comments" 13776 } 13777 }, 13778 "user": { 13779 "login": "octocat", 13780 "id": 1, 13781 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 13782 "gravatar_id": "somehexcode", 13783 "url": "https://api.github.com/users/octocat" 13784 } 13785 } 13786 ] 13787 # Commits 13788 /commits: 13789 type: item 13790 get: 13791 description: List commits on a pull request. 13792 responses: 13793 200: 13794 body: 13795 schema: | 13796 { 13797 "$schema": "http://json-schema.org/draft-03/schema", 13798 "type": "array", 13799 "list": [ 13800 { 13801 "properties": { 13802 "url": { 13803 "type": "string" 13804 }, 13805 "sha": { 13806 "type": "string" 13807 }, 13808 "commit": { 13809 "properties": { 13810 "url": { 13811 "type": "string" 13812 }, 13813 "author": { 13814 "properties": { 13815 "name": { 13816 "type": "string" 13817 }, 13818 "email": { 13819 "type": "string" 13820 }, 13821 "date": { 13822 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 13823 "type": "string" 13824 } 13825 }, 13826 "type": "object" 13827 }, 13828 "type": "object" 13829 }, 13830 "committer": { 13831 "properties": { 13832 "name": { 13833 "type": "string" 13834 }, 13835 "email": { 13836 "type": "string" 13837 }, 13838 "date": { 13839 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 13840 "type": "string" 13841 } 13842 }, 13843 "type": "object" 13844 }, 13845 "message": { 13846 "type": "string" 13847 }, 13848 "tree": { 13849 "properties": { 13850 "url": { 13851 "type": "string" 13852 }, 13853 "sha": { 13854 "type": "string" 13855 } 13856 }, 13857 "type": "object" 13858 } 13859 }, 13860 "author": { 13861 "properties": { 13862 "login": { 13863 "type": "string" 13864 }, 13865 "id": { 13866 "type": "integer" 13867 }, 13868 "avatar_url": { 13869 "type": "string" 13870 }, 13871 "gravatar_id": { 13872 "type": "string" 13873 }, 13874 "url": { 13875 "type": "string" 13876 } 13877 }, 13878 "type": "object" 13879 }, 13880 "committer": { 13881 "properties": { 13882 "login": { 13883 "type": "string" 13884 }, 13885 "id": { 13886 "type": "integer" 13887 }, 13888 "avatar_url": { 13889 "type": "string" 13890 }, 13891 "gravatar_id": { 13892 "type": "string" 13893 }, 13894 "url": { 13895 "type": "string" 13896 } 13897 }, 13898 "type": "object" 13899 }, 13900 "parents": [ 13901 { 13902 "properties": { 13903 "url": { 13904 "type": "string" 13905 }, 13906 "sha": { 13907 "type": "string" 13908 } 13909 }, 13910 "type": "object" 13911 } 13912 ], 13913 "type": "array" 13914 }, 13915 "type": "object" 13916 } 13917 ] 13918 } 13919 example: | 13920 [ 13921 { 13922 "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", 13923 "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 13924 "commit": { 13925 "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", 13926 "author": { 13927 "name": "Monalisa Octocat", 13928 "email": "support@github.com", 13929 "date": "2011-04-14T16:00:49Z" 13930 }, 13931 "committer": { 13932 "name": "Monalisa Octocat", 13933 "email": "support@github.com", 13934 "date": "2011-04-14T16:00:49Z" 13935 }, 13936 "message": "Fix all the bugs", 13937 "tree": { 13938 "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", 13939 "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" 13940 } 13941 }, 13942 "author": { 13943 "login": "octocat", 13944 "id": 1, 13945 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 13946 "gravatar_id": "somehexcode", 13947 "url": "https://api.github.com/users/octocat" 13948 }, 13949 "committer": { 13950 "login": "octocat", 13951 "id": 1, 13952 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 13953 "gravatar_id": "somehexcode", 13954 "url": "https://api.github.com/users/octocat" 13955 }, 13956 "parents": [ 13957 { 13958 "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", 13959 "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" 13960 } 13961 ] 13962 } 13963 ] 13964 /merge: 13965 type: base 13966 get: 13967 description: Get if a pull request has been merged. 13968 responses: 13969 204: 13970 description: Pull request has been merged. 13971 404: 13972 description: Pull request has not been merged. 13973 put: 13974 description: Merge a pull request (Merge Buttonâ„¢) 13975 body: 13976 application/json: 13977 schema: | 13978 { 13979 "$schema": "http://json-schema.org/draft-03/schema", 13980 "type": "object", 13981 "properties": { 13982 "commit_message": { 13983 "description": "The message that will be used for the merge commit", 13984 "type": "string" 13985 } 13986 } 13987 } 13988 responses: 13989 200: 13990 description: Response if merge was successful. 13991 body: 13992 application/json: 13993 schema: | 13994 { 13995 "$schema": "http://json-schema.org/draft-03/schema", 13996 "type": "object", 13997 "properties": { 13998 "sha": { 13999 "type": "string" 14000 }, 14001 "merged": { 14002 "type": "boolean" 14003 }, 14004 "message": { 14005 "type": "string" 14006 } 14007 } 14008 } 14009 example: | 14010 { 14011 "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 14012 "merged": true, 14013 "message": "Pull Request successfully merged" 14014 } 14015 405: 14016 description: Response if merge cannot be performed. 14017 body: 14018 application/json: 14019 schema: | 14020 { 14021 "$schema": "http://json-schema.org/draft-03/schema", 14022 "type": "object", 14023 "properties": { 14024 "sha": { 14025 "type": "string" 14026 }, 14027 "merged": { 14028 "type": "boolean" 14029 }, 14030 "message": { 14031 "type": "string" 14032 } 14033 } 14034 } 14035 example: | 14036 { 14037 "sha": null, 14038 "merged": false, 14039 "message": "Failure reason" 14040 } 14041 /comments: 14042 type: collection 14043 get: 14044 description: List comments on a pull request. 14045 responses: 14046 200: 14047 body: 14048 schema: | 14049 { 14050 "$schema": "http://json-schema.org/draft-03/schema", 14051 "type": "object", 14052 "properties": { 14053 "url": { 14054 "type": "string" 14055 }, 14056 "id": { 14057 "type": "integer" 14058 }, 14059 "body": { 14060 "type": "string" 14061 }, 14062 "path": { 14063 "type": "string" 14064 }, 14065 "position": { 14066 "type": "integer" 14067 }, 14068 "commit_id": { 14069 "type": "string" 14070 }, 14071 "user": { 14072 "properties": { 14073 "login": { 14074 "type": "string" 14075 }, 14076 "id": { 14077 "type": "integer" 14078 }, 14079 "avatar_url": { 14080 "type": "string" 14081 }, 14082 "gravatar_id": { 14083 "type": "string" 14084 }, 14085 "url": { 14086 "type": "string" 14087 } 14088 }, 14089 "type": "object" 14090 }, 14091 "created_at": { 14092 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 14093 "type": "string" 14094 }, 14095 "updated_at": { 14096 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 14097 "type": "string" 14098 }, 14099 "_links": { 14100 "properties": { 14101 "self": { 14102 "properties": { 14103 "href": { 14104 "type": "string" 14105 } 14106 }, 14107 "type": "object" 14108 }, 14109 "html": { 14110 "properties": { 14111 "href": { 14112 "type": "string" 14113 } 14114 }, 14115 "type": "object" 14116 }, 14117 "pull_request": { 14118 "properties": { 14119 "href": { 14120 "type": "string" 14121 } 14122 }, 14123 "type": "object" 14124 } 14125 }, 14126 "type": "object" 14127 } 14128 } 14129 } 14130 example: | 14131 { 14132 "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", 14133 "id": 1, 14134 "body": "Great stuff", 14135 "path": "file1.txt", 14136 "position": 4, 14137 "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 14138 "user": { 14139 "login": "octocat", 14140 "id": 1, 14141 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 14142 "gravatar_id": "somehexcode", 14143 "url": "https://api.github.com/users/octocat" 14144 }, 14145 "created_at": "2011-04-14T16:00:49Z", 14146 "updated_at": "2011-04-14T16:00:49Z", 14147 "_links": { 14148 "self": { 14149 "href": "https://api.github.com/octocat/Hello-World/pulls/comments/1" 14150 }, 14151 "html": { 14152 "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" 14153 }, 14154 "pull_request": { 14155 "href": "https://api.github.com/octocat/Hello-World/pulls/1" 14156 } 14157 } 14158 } 14159 post: 14160 description: | 14161 Create a comment. 14162 #TODO Alternative input ( http://developer.github.com/v3/pulls/comments/ ) 14163 description: | 14164 Alternative Input. 14165 Instead of passing commit_id, path, and position you can reply to an 14166 existing Pull Request Comment like this: 14167 14168 body 14169 Required string 14170 in_reply_to 14171 Required number - Comment id to reply to. 14172 body: 14173 application/json: 14174 schema: | 14175 { 14176 "$schema": "http://json-schema.org/draft-03/schema", 14177 "type": "object", 14178 "properties": { 14179 "body": { 14180 "type": "string" 14181 }, 14182 "commit_id": { 14183 "description": "Sha of the commit to comment on.", 14184 "type": "string" 14185 }, 14186 "path": { 14187 "description": "Relative path of the file to comment on.", 14188 "type": "string" 14189 }, 14190 "position": { 14191 "description": "Line index in the diff to comment on.", 14192 "type": "string" 14193 } 14194 }, 14195 "required": [ "body", "commit_id", "path", "position" ] 14196 } 14197 responses: 14198 201: 14199 body: 14200 schema: | 14201 { 14202 "$schema": "http://json-schema.org/draft-03/schema", 14203 "type": "object", 14204 "properties": { 14205 "url": { 14206 "type": "string" 14207 }, 14208 "id": { 14209 "type": "integer" 14210 }, 14211 "body": { 14212 "type": "string" 14213 }, 14214 "path": { 14215 "type": "string" 14216 }, 14217 "position": { 14218 "type": "integer" 14219 }, 14220 "commit_id": { 14221 "type": "string" 14222 }, 14223 "user": { 14224 "properties": { 14225 "login": { 14226 "type": "string" 14227 }, 14228 "id": { 14229 "type": "integer" 14230 }, 14231 "avatar_url": { 14232 "type": "string" 14233 }, 14234 "gravatar_id": { 14235 "type": "string" 14236 }, 14237 "url": { 14238 "type": "string" 14239 } 14240 }, 14241 "type": "object" 14242 }, 14243 "created_at": { 14244 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 14245 "type": "string" 14246 }, 14247 "updated_at": { 14248 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 14249 "type": "string" 14250 }, 14251 "_links": { 14252 "properties": { 14253 "self": { 14254 "properties": { 14255 "href": { 14256 "type": "string" 14257 } 14258 }, 14259 "type": "object" 14260 }, 14261 "html": { 14262 "properties": { 14263 "href": { 14264 "type": "string" 14265 } 14266 }, 14267 "type": "object" 14268 }, 14269 "pull_request": { 14270 "properties": { 14271 "href": { 14272 "type": "string" 14273 } 14274 }, 14275 "type": "object" 14276 } 14277 }, 14278 "type": "object" 14279 } 14280 } 14281 } 14282 example: | 14283 { 14284 "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", 14285 "id": 1, 14286 "body": "Great stuff", 14287 "path": "file1.txt", 14288 "position": 4, 14289 "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 14290 "user": { 14291 "login": "octocat", 14292 "id": 1, 14293 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 14294 "gravatar_id": "somehexcode", 14295 "url": "https://api.github.com/users/octocat" 14296 }, 14297 "created_at": "2011-04-14T16:00:49Z", 14298 "updated_at": "2011-04-14T16:00:49Z", 14299 "_links": { 14300 "self": { 14301 "href": "https://api.github.com/octocat/Hello-World/pulls/comments/1" 14302 }, 14303 "html": { 14304 "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" 14305 }, 14306 "pull_request": { 14307 "href": "https://api.github.com/octocat/Hello-World/pulls/1" 14308 } 14309 } 14310 } 14311 /comments: 14312 type: collection 14313 get: 14314 description: | 14315 List comments in a repository. 14316 By default, Review Comments are ordered by ascending ID. 14317 queryParameters: 14318 sort: 14319 enum: 14320 - created 14321 - updated 14322 direction: 14323 description: Ignored without 'sort' parameter. 14324 enum: 14325 - asc 14326 - desc 14327 since: 14328 description: Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ 14329 type: string 14330 responses: 14331 200: 14332 body: 14333 schema: | 14334 { 14335 "$schema": "http://json-schema.org/draft-03/schema", 14336 "type": "array", 14337 "list": [ 14338 { 14339 "properties": { 14340 "url": { 14341 "type": "string" 14342 }, 14343 "id": { 14344 "type": "integer" 14345 }, 14346 "body": { 14347 "type": "string" 14348 }, 14349 "path": { 14350 "type": "string" 14351 }, 14352 "position": { 14353 "type": "integer" 14354 }, 14355 "commit_id": { 14356 "type": "string" 14357 }, 14358 "user": { 14359 "properties": { 14360 "login": { 14361 "type": "string" 14362 }, 14363 "id": { 14364 "type": "integer" 14365 }, 14366 "avatar_url": { 14367 "type": "string" 14368 }, 14369 "gravatar_id": { 14370 "type": "string" 14371 }, 14372 "url": { 14373 "type": "string" 14374 } 14375 }, 14376 "type": "object" 14377 }, 14378 "created_at": { 14379 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 14380 "type": "string" 14381 }, 14382 "updated_at": { 14383 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 14384 "type": "string" 14385 }, 14386 "_links": { 14387 "properties": { 14388 "self": { 14389 "properties": { 14390 "href": { 14391 "type": "string" 14392 } 14393 }, 14394 "type": "object" 14395 }, 14396 "html": { 14397 "properties": { 14398 "href": { 14399 "type": "string" 14400 } 14401 }, 14402 "type": "object" 14403 }, 14404 "pull_request": { 14405 "properties": { 14406 "href": { 14407 "type": "string" 14408 } 14409 }, 14410 "type": "object" 14411 } 14412 }, 14413 "type": "object" 14414 } 14415 }, 14416 "type": "object" 14417 } 14418 ] 14419 } 14420 example: | 14421 [ 14422 { 14423 "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", 14424 "id": 1, 14425 "body": "Great stuff", 14426 "path": "file1.txt", 14427 "position": 4, 14428 "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 14429 "user": { 14430 "login": "octocat", 14431 "id": 1, 14432 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 14433 "gravatar_id": "somehexcode", 14434 "url": "https://api.github.com/users/octocat" 14435 }, 14436 "created_at": "2011-04-14T16:00:49Z", 14437 "updated_at": "2011-04-14T16:00:49Z", 14438 "_links": { 14439 "self": { 14440 "href": "https://api.github.com/octocat/Hello-World/pulls/comments/1" 14441 }, 14442 "html": { 14443 "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" 14444 }, 14445 "pull_request": { 14446 "href": "https://api.github.com/octocat/Hello-World/pulls/1" 14447 } 14448 } 14449 } 14450 ] 14451 /{number}: 14452 uriParameters: 14453 number: 14454 description: Id of the comment. 14455 type: integer 14456 type: item 14457 get: 14458 description: Get a single comment. 14459 responses: 14460 200: 14461 body: 14462 schema: | 14463 { 14464 "$schema": "http://json-schema.org/draft-03/schema", 14465 "type": "object", 14466 "properties": { 14467 "url": { 14468 "type": "string" 14469 }, 14470 "id": { 14471 "type": "integer" 14472 }, 14473 "body": { 14474 "type": "string" 14475 }, 14476 "path": { 14477 "type": "string" 14478 }, 14479 "position": { 14480 "type": "integer" 14481 }, 14482 "commit_id": { 14483 "type": "string" 14484 }, 14485 "user": { 14486 "properties": { 14487 "login": { 14488 "type": "string" 14489 }, 14490 "id": { 14491 "type": "integer" 14492 }, 14493 "avatar_url": { 14494 "type": "string" 14495 }, 14496 "gravatar_id": { 14497 "type": "string" 14498 }, 14499 "url": { 14500 "type": "string" 14501 } 14502 }, 14503 "type": "object" 14504 }, 14505 "created_at": { 14506 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 14507 "type": "string" 14508 }, 14509 "updated_at": { 14510 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 14511 "type": "string" 14512 }, 14513 "_links": { 14514 "properties": { 14515 "self": { 14516 "properties": { 14517 "href": { 14518 "type": "string" 14519 } 14520 }, 14521 "type": "object" 14522 }, 14523 "html": { 14524 "properties": { 14525 "href": { 14526 "type": "string" 14527 } 14528 }, 14529 "type": "object" 14530 }, 14531 "pull_request": { 14532 "properties": { 14533 "href": { 14534 "type": "string" 14535 } 14536 }, 14537 "type": "object" 14538 } 14539 }, 14540 "type": "object" 14541 } 14542 } 14543 } 14544 example: | 14545 { 14546 "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", 14547 "id": 1, 14548 "body": "Great stuff", 14549 "path": "file1.txt", 14550 "position": 4, 14551 "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 14552 "user": { 14553 "login": "octocat", 14554 "id": 1, 14555 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 14556 "gravatar_id": "somehexcode", 14557 "url": "https://api.github.com/users/octocat" 14558 }, 14559 "created_at": "2011-04-14T16:00:49Z", 14560 "updated_at": "2011-04-14T16:00:49Z", 14561 "_links": { 14562 "self": { 14563 "href": "https://api.github.com/octocat/Hello-World/pulls/comments/1" 14564 }, 14565 "html": { 14566 "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" 14567 }, 14568 "pull_request": { 14569 "href": "https://api.github.com/octocat/Hello-World/pulls/1" 14570 } 14571 } 14572 } 14573 patch: 14574 description: Edit a comment. 14575 body: 14576 application/json: 14577 schema: | 14578 { 14579 "$schema": "http://json-schema.org/draft-03/schema", 14580 "type": "object", 14581 "properties": { 14582 "body": { 14583 "type": "string" 14584 } 14585 }, 14586 "required": [ "body" ] 14587 } 14588 responses: 14589 200: 14590 body: 14591 schema: | 14592 { 14593 "$schema": "http://json-schema.org/draft-03/schema", 14594 "type": "object", 14595 "properties": { 14596 "url": { 14597 "type": "string" 14598 }, 14599 "id": { 14600 "type": "integer" 14601 }, 14602 "body": { 14603 "type": "string" 14604 }, 14605 "path": { 14606 "type": "string" 14607 }, 14608 "position": { 14609 "type": "integer" 14610 }, 14611 "commit_id": { 14612 "type": "string" 14613 }, 14614 "user": { 14615 "properties": { 14616 "login": { 14617 "type": "string" 14618 }, 14619 "id": { 14620 "type": "integer" 14621 }, 14622 "avatar_url": { 14623 "type": "string" 14624 }, 14625 "gravatar_id": { 14626 "type": "string" 14627 }, 14628 "url": { 14629 "type": "string" 14630 } 14631 }, 14632 "type": "object" 14633 }, 14634 "created_at": { 14635 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 14636 "type": "string" 14637 }, 14638 "updated_at": { 14639 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 14640 "type": "string" 14641 }, 14642 "_links": { 14643 "properties": { 14644 "self": { 14645 "properties": { 14646 "href": { 14647 "type": "string" 14648 } 14649 }, 14650 "type": "object" 14651 }, 14652 "html": { 14653 "properties": { 14654 "href": { 14655 "type": "string" 14656 } 14657 }, 14658 "type": "object" 14659 }, 14660 "pull_request": { 14661 "properties": { 14662 "href": { 14663 "type": "string" 14664 } 14665 }, 14666 "type": "object" 14667 } 14668 }, 14669 "type": "object" 14670 } 14671 } 14672 } 14673 example: | 14674 { 14675 "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", 14676 "id": 1, 14677 "body": "Great stuff", 14678 "path": "file1.txt", 14679 "position": 4, 14680 "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 14681 "user": { 14682 "login": "octocat", 14683 "id": 1, 14684 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 14685 "gravatar_id": "somehexcode", 14686 "url": "https://api.github.com/users/octocat" 14687 }, 14688 "created_at": "2011-04-14T16:00:49Z", 14689 "updated_at": "2011-04-14T16:00:49Z", 14690 "_links": { 14691 "self": { 14692 "href": "https://api.github.com/octocat/Hello-World/pulls/comments/1" 14693 }, 14694 "html": { 14695 "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" 14696 }, 14697 "pull_request": { 14698 "href": "https://api.github.com/octocat/Hello-World/pulls/1" 14699 } 14700 } 14701 } 14702 delete: 14703 description: Delete a comment. 14704 /collaborators: 14705 type: collection 14706 get: 14707 description: | 14708 List. 14709 When authenticating as an organization owner of an organization-owned 14710 repository, all organization owners are included in the list of 14711 collaborators. Otherwise, only users with access to the repository are 14712 returned in the collaborators list. 14713 responses: 14714 200: 14715 body: 14716 schema: | 14717 { 14718 "$schema": "http://json-schema.org/draft-03/schema", 14719 "type": "array", 14720 "list": [ 14721 { 14722 "properties": { 14723 "login": { 14724 "type": "string" 14725 }, 14726 "id": { 14727 "type": "integer" 14728 }, 14729 "avatar_url": { 14730 "type": "string" 14731 }, 14732 "gravatar_id": { 14733 "type": "string" 14734 }, 14735 "url": { 14736 "type": "string" 14737 } 14738 }, 14739 "type": "object" 14740 } 14741 ] 14742 } 14743 example: | 14744 [ 14745 { 14746 "login": "octocat", 14747 "id": 1, 14748 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 14749 "gravatar_id": "somehexcode", 14750 "url": "https://api.github.com/users/octocat" 14751 } 14752 ] 14753 /{user}: 14754 uriParameters: 14755 user: 14756 description: Login of the user. 14757 type: string 14758 type: base 14759 get: 14760 description: Check if user is a collaborator 14761 responses: 14762 204: 14763 description: User is a collaborator. 14764 404: 14765 description: User is not a collaborator. 14766 put: 14767 description: Add collaborator. 14768 responses: 14769 204: 14770 description: Collaborator added. 14771 delete: 14772 description: Remove collaborator. 14773 responses: 14774 204: 14775 description: Collaborator removed. 14776 /comments: 14777 type: collection 14778 get: 14779 description: | 14780 List commit comments for a repository. 14781 Comments are ordered by ascending ID. 14782 responses: 14783 200: 14784 body: 14785 schema: | 14786 { 14787 "$schema": "http://json-schema.org/draft-03/schema", 14788 "type": "array", 14789 "list": [ 14790 { 14791 "properties": { 14792 "html_url": { 14793 "type": "string" 14794 }, 14795 "url": { 14796 "type": "string" 14797 }, 14798 "id": { 14799 "type": "integer" 14800 }, 14801 "body": { 14802 "type": "string" 14803 }, 14804 "path": { 14805 "type": "string" 14806 }, 14807 "position": { 14808 "type": "integer" 14809 }, 14810 "line": { 14811 "type": "integer" 14812 }, 14813 "commit_id": { 14814 "type": "string" 14815 }, 14816 "user": { 14817 "properties": { 14818 "login": { 14819 "type": "string" 14820 }, 14821 "id": { 14822 "type": "integer" 14823 }, 14824 "avatar_url": { 14825 "type": "string" 14826 }, 14827 "gravatar_id": { 14828 "type": "string" 14829 }, 14830 "url": { 14831 "type": "string" 14832 } 14833 }, 14834 "type": "object" 14835 }, 14836 "created_at": { 14837 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 14838 "type": "string" 14839 }, 14840 "updated_at": { 14841 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 14842 "type": "string" 14843 } 14844 }, 14845 "type": "object" 14846 } 14847 ] 14848 } 14849 example: | 14850 [ 14851 { 14852 "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", 14853 "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", 14854 "id": 1, 14855 "body": "Great stuff", 14856 "path": "file1.txt", 14857 "position": 4, 14858 "line": 14, 14859 "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 14860 "user": { 14861 "login": "octocat", 14862 "id": 1, 14863 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 14864 "gravatar_id": "somehexcode", 14865 "url": "https://api.github.com/users/octocat" 14866 }, 14867 "created_at": "2011-04-14T16:00:49Z", 14868 "updated_at": "2011-04-14T16:00:49Z" 14869 } 14870 ] 14871 /{commentId}: 14872 uriParameters: 14873 commentId: 14874 description: Id of a comment. 14875 type: integer 14876 type: item 14877 get: 14878 description: Get a single commit comment. 14879 responses: 14880 200: 14881 body: 14882 schema: | 14883 { 14884 "$schema": "http://json-schema.org/draft-03/schema", 14885 "type": "object", 14886 "properties": { 14887 "html_url": { 14888 "type": "string" 14889 }, 14890 "url": { 14891 "type": "string" 14892 }, 14893 "id": { 14894 "type": "integer" 14895 }, 14896 "body": { 14897 "type": "string" 14898 }, 14899 "path": { 14900 "type": "string" 14901 }, 14902 "position": { 14903 "type": "integer" 14904 }, 14905 "line": { 14906 "type": "integer" 14907 }, 14908 "commit_id": { 14909 "type": "string" 14910 }, 14911 "user": { 14912 "properties": { 14913 "login": { 14914 "type": "string" 14915 }, 14916 "id": { 14917 "type": "integer" 14918 }, 14919 "avatar_url": { 14920 "type": "string" 14921 }, 14922 "gravatar_id": { 14923 "type": "string" 14924 }, 14925 "url": { 14926 "type": "string" 14927 } 14928 }, 14929 "type": "object" 14930 }, 14931 "created_at": { 14932 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 14933 "type": "string" 14934 }, 14935 "updated_at": { 14936 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 14937 "type": "string" 14938 } 14939 } 14940 } 14941 example: | 14942 { 14943 "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", 14944 "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", 14945 "id": 1, 14946 "body": "Great stuff", 14947 "path": "file1.txt", 14948 "position": 4, 14949 "line": 14, 14950 "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 14951 "user": { 14952 "login": "octocat", 14953 "id": 1, 14954 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 14955 "gravatar_id": "somehexcode", 14956 "url": "https://api.github.com/users/octocat" 14957 }, 14958 "created_at": "2011-04-14T16:00:49Z", 14959 "updated_at": "2011-04-14T16:00:49Z" 14960 } 14961 patch: 14962 description: Update a commit comment. 14963 body: 14964 application/json: 14965 schema: | 14966 { 14967 "$schema": "http://json-schema.org/draft-03/schema", 14968 "type": "object", 14969 "properties": { 14970 "body": { 14971 "type": "string" 14972 } 14973 }, 14974 "required": [ "body" ] 14975 } 14976 responses: 14977 200: 14978 body: 14979 schema: | 14980 { 14981 "$schema": "http://json-schema.org/draft-03/schema", 14982 "type": "object", 14983 "properties": { 14984 "html_url": { 14985 "type": "string" 14986 }, 14987 "url": { 14988 "type": "string" 14989 }, 14990 "id": { 14991 "type": "integer" 14992 }, 14993 "body": { 14994 "type": "string" 14995 }, 14996 "path": { 14997 "type": "string" 14998 }, 14999 "position": { 15000 "type": "integer" 15001 }, 15002 "line": { 15003 "type": "integer" 15004 }, 15005 "commit_id": { 15006 "type": "string" 15007 }, 15008 "user": { 15009 "properties": { 15010 "login": { 15011 "type": "string" 15012 }, 15013 "id": { 15014 "type": "integer" 15015 }, 15016 "avatar_url": { 15017 "type": "string" 15018 }, 15019 "gravatar_id": { 15020 "type": "string" 15021 }, 15022 "url": { 15023 "type": "string" 15024 } 15025 }, 15026 "type": "object" 15027 }, 15028 "created_at": { 15029 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 15030 "type": "string" 15031 }, 15032 "updated_at": { 15033 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 15034 "type": "string" 15035 } 15036 } 15037 } 15038 example: | 15039 { 15040 "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", 15041 "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", 15042 "id": 1, 15043 "body": "Great stuff", 15044 "path": "file1.txt", 15045 "position": 4, 15046 "line": 14, 15047 "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 15048 "user": { 15049 "login": "octocat", 15050 "id": 1, 15051 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 15052 "gravatar_id": "somehexcode", 15053 "url": "https://api.github.com/users/octocat" 15054 }, 15055 "created_at": "2011-04-14T16:00:49Z", 15056 "updated_at": "2011-04-14T16:00:49Z" 15057 } 15058 delete: 15059 description: Delete a commit comment 15060 /commits: 15061 type: collection 15062 get: 15063 description: List commits on a repository. 15064 queryParameters: 15065 sha: 15066 description: Sha or branch to start listing commits from. 15067 type: string 15068 path: 15069 description: Only commits containing this file path will be returned. 15070 type: string 15071 author: 15072 description: GitHub login, name, or email by which to filter by commit author. 15073 type: string 15074 since: 15075 description: ISO 8601 Date - Only commits after this date will be returned. 15076 type: string 15077 until: 15078 description: ISO 8601 Date - Only commits before this date will be returned. 15079 responses: 15080 200: 15081 body: 15082 schema: | 15083 { 15084 "$schema": "http://json-schema.org/draft-03/schema", 15085 "type": "array", 15086 "list": [ 15087 { 15088 "properties": { 15089 "url": { 15090 "type": "string" 15091 }, 15092 "sha": { 15093 "type": "string" 15094 }, 15095 "commit": { 15096 "properties": { 15097 "url": { 15098 "type": "string" 15099 }, 15100 "author": { 15101 "properties": { 15102 "name": { 15103 "type": "string" 15104 }, 15105 "email": { 15106 "type": "string" 15107 }, 15108 "date": { 15109 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 15110 "type": "string" 15111 } 15112 }, 15113 "type": "object" 15114 }, 15115 "type": "object" 15116 }, 15117 "committer": { 15118 "properties": { 15119 "name": { 15120 "type": "string" 15121 }, 15122 "email": { 15123 "type": "string" 15124 }, 15125 "date": { 15126 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 15127 "type": "string" 15128 } 15129 }, 15130 "type": "object" 15131 }, 15132 "message": { 15133 "type": "string" 15134 }, 15135 "tree": { 15136 "properties": { 15137 "url": { 15138 "type": "string" 15139 }, 15140 "sha": { 15141 "type": "string" 15142 } 15143 }, 15144 "type": "object" 15145 } 15146 }, 15147 "author": { 15148 "properties": { 15149 "login": { 15150 "type": "string" 15151 }, 15152 "id": { 15153 "type": "integer" 15154 }, 15155 "avatar_url": { 15156 "type": "string" 15157 }, 15158 "gravatar_id": { 15159 "type": "string" 15160 }, 15161 "url": { 15162 "type": "string" 15163 } 15164 }, 15165 "type": "object" 15166 }, 15167 "committer": { 15168 "properties": { 15169 "login": { 15170 "type": "string" 15171 }, 15172 "id": { 15173 "type": "integer" 15174 }, 15175 "avatar_url": { 15176 "type": "string" 15177 }, 15178 "gravatar_id": { 15179 "type": "string" 15180 }, 15181 "url": { 15182 "type": "string" 15183 } 15184 }, 15185 "type": "object" 15186 }, 15187 "parents": [ 15188 { 15189 "properties": { 15190 "url": { 15191 "type": "string" 15192 }, 15193 "sha": { 15194 "type": "string" 15195 } 15196 }, 15197 "type": "object" 15198 } 15199 ], 15200 "type": "array" 15201 }, 15202 "type": "object" 15203 } 15204 ] 15205 } 15206 example: | 15207 [ 15208 { 15209 "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", 15210 "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 15211 "commit": { 15212 "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", 15213 "author": { 15214 "name": "Monalisa Octocat", 15215 "email": "support@github.com", 15216 "date": "2011-04-14T16:00:49Z" 15217 }, 15218 "committer": { 15219 "name": "Monalisa Octocat", 15220 "email": "support@github.com", 15221 "date": "2011-04-14T16:00:49Z" 15222 }, 15223 "message": "Fix all the bugs", 15224 "tree": { 15225 "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", 15226 "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" 15227 } 15228 }, 15229 "author": { 15230 "login": "octocat", 15231 "id": 1, 15232 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 15233 "gravatar_id": "somehexcode", 15234 "url": "https://api.github.com/users/octocat" 15235 }, 15236 "committer": { 15237 "login": "octocat", 15238 "id": 1, 15239 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 15240 "gravatar_id": "somehexcode", 15241 "url": "https://api.github.com/users/octocat" 15242 }, 15243 "parents": [ 15244 { 15245 "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", 15246 "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" 15247 } 15248 ] 15249 } 15250 ] 15251 /{shaCode}: 15252 uriParameters: 15253 shaCode: 15254 description: SHA-1 code of the commit. 15255 type: string 15256 type: item 15257 get: 15258 description: Get a single commit. 15259 responses: 15260 200: 15261 body: 15262 schema: | 15263 { 15264 "$schema": "http://json-schema.org/draft-03/schema", 15265 "type": "object", 15266 "properties": { 15267 "url": { 15268 "type": "string" 15269 }, 15270 "sha": { 15271 "type": "string" 15272 }, 15273 "commit": { 15274 "properties": { 15275 "url": { 15276 "type": "string" 15277 }, 15278 "author": { 15279 "properties": { 15280 "name": { 15281 "type": "string" 15282 }, 15283 "email": { 15284 "type": "string" 15285 }, 15286 "date": { 15287 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 15288 "type": "string" 15289 } 15290 }, 15291 "type": "object" 15292 }, 15293 "type": "object" 15294 }, 15295 "committer": { 15296 "properties": { 15297 "name": { 15298 "type": "string" 15299 }, 15300 "email": { 15301 "type": "string" 15302 }, 15303 "date": { 15304 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 15305 "type": "string" 15306 } 15307 }, 15308 "type": "object" 15309 }, 15310 "message": { 15311 "type": "string" 15312 }, 15313 "tree": { 15314 "properties": { 15315 "url": { 15316 "type": "string" 15317 }, 15318 "sha": { 15319 "type": "string" 15320 } 15321 }, 15322 "type": "object" 15323 } 15324 }, 15325 "author": { 15326 "properties": { 15327 "login": { 15328 "type": "string" 15329 }, 15330 "id": { 15331 "type": "integer" 15332 }, 15333 "avatar_url": { 15334 "type": "string" 15335 }, 15336 "gravatar_id": { 15337 "type": "string" 15338 }, 15339 "url": { 15340 "type": "string" 15341 } 15342 }, 15343 "type": "object" 15344 }, 15345 "committer": { 15346 "properties": { 15347 "login": { 15348 "type": "string" 15349 }, 15350 "id": { 15351 "type": "integer" 15352 }, 15353 "avatar_url": { 15354 "type": "string" 15355 }, 15356 "gravatar_id": { 15357 "type": "string" 15358 }, 15359 "url": { 15360 "type": "string" 15361 } 15362 }, 15363 "type": "object" 15364 }, 15365 "parents": [ 15366 { 15367 "properties": { 15368 "url": { 15369 "type": "string" 15370 }, 15371 "sha": { 15372 "type": "string" 15373 } 15374 }, 15375 "type": "object" 15376 } 15377 ], 15378 "type": "array" 15379 } 15380 } 15381 example: | 15382 { 15383 "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", 15384 "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 15385 "commit": { 15386 "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", 15387 "author": { 15388 "name": "Monalisa Octocat", 15389 "email": "support@github.com", 15390 "date": "2011-04-14T16:00:49Z" 15391 }, 15392 "committer": { 15393 "name": "Monalisa Octocat", 15394 "email": "support@github.com", 15395 "date": "2011-04-14T16:00:49Z" 15396 }, 15397 "message": "Fix all the bugs", 15398 "tree": { 15399 "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", 15400 "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" 15401 } 15402 }, 15403 "author": { 15404 "login": "octocat", 15405 "id": 1, 15406 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 15407 "gravatar_id": "somehexcode", 15408 "url": "https://api.github.com/users/octocat" 15409 }, 15410 "committer": { 15411 "login": "octocat", 15412 "id": 1, 15413 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 15414 "gravatar_id": "somehexcode", 15415 "url": "https://api.github.com/users/octocat" 15416 }, 15417 "parents": [ 15418 { 15419 "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", 15420 "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" 15421 } 15422 ], 15423 "stats": { 15424 "additions": 104, 15425 "deletions": 4, 15426 "total": 108 15427 }, 15428 "files": [ 15429 { 15430 "filename": "file1.txt", 15431 "additions": 10, 15432 "deletions": 2, 15433 "changes": 12, 15434 "status": "modified", 15435 "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", 15436 "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", 15437 "patch": "@@ -29,7 +29,7 @@\n....." 15438 } 15439 ] 15440 } 15441 /comments: 15442 type: collection 15443 get: 15444 description: List comments for a single commitList comments for a single commit. 15445 responses: 15446 200: 15447 body: 15448 schema: | 15449 { 15450 "$schema": "http://json-schema.org/draft-03/schema", 15451 "type": "array", 15452 "list": [ 15453 { 15454 "properties": { 15455 "html_url": { 15456 "type": "string" 15457 }, 15458 "url": { 15459 "type": "string" 15460 }, 15461 "id": { 15462 "type": "integer" 15463 }, 15464 "body": { 15465 "type": "string" 15466 }, 15467 "path": { 15468 "type": "string" 15469 }, 15470 "position": { 15471 "type": "integer" 15472 }, 15473 "line": { 15474 "type": "integer" 15475 }, 15476 "commit_id": { 15477 "type": "string" 15478 }, 15479 "user": { 15480 "properties": { 15481 "login": { 15482 "type": "string" 15483 }, 15484 "id": { 15485 "type": "integer" 15486 }, 15487 "avatar_url": { 15488 "type": "string" 15489 }, 15490 "gravatar_id": { 15491 "type": "string" 15492 }, 15493 "url": { 15494 "type": "string" 15495 } 15496 }, 15497 "type": "object" 15498 }, 15499 "created_at": { 15500 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 15501 "type": "string" 15502 }, 15503 "updated_at": { 15504 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 15505 "type": "string" 15506 } 15507 }, 15508 "type": "object" 15509 } 15510 ] 15511 } 15512 example: | 15513 [ 15514 { 15515 "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", 15516 "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", 15517 "id": 1, 15518 "body": "Great stuff", 15519 "path": "file1.txt", 15520 "position": 4, 15521 "line": 14, 15522 "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 15523 "user": { 15524 "login": "octocat", 15525 "id": 1, 15526 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 15527 "gravatar_id": "somehexcode", 15528 "url": "https://api.github.com/users/octocat" 15529 }, 15530 "created_at": "2011-04-14T16:00:49Z", 15531 "updated_at": "2011-04-14T16:00:49Z" 15532 } 15533 ] 15534 post: 15535 description: Create a commit comment. 15536 body: 15537 application/json: 15538 schema: | 15539 { 15540 "$schema": "http://json-schema.org/draft-03/schema", 15541 "type": "object", 15542 "properties": { 15543 "sha": { 15544 "description": "SHA of the commit to comment on.", 15545 "type": "string" 15546 }, 15547 "body": { 15548 "type": "string" 15549 }, 15550 "path": { 15551 "description": "Relative path of the file to comment on.", 15552 "type": "string" 15553 }, 15554 "position": { 15555 "description": "Line index in the diff to comment on.", 15556 "type": "integer" 15557 }, 15558 "line": { 15559 "description": "Deprecated - Use position parameter instead.", 15560 "type": "string" 15561 }, 15562 "number": { 15563 "description": "Line number in the file to comment on. Defaults to null.", 15564 "type": "string" 15565 } 15566 }, 15567 "required": [ "sha", "body" ] 15568 } 15569 responses: 15570 201: 15571 body: 15572 schema: | 15573 { 15574 "$schema": "http://json-schema.org/draft-03/schema", 15575 "type": "object", 15576 "properties": { 15577 "html_url": { 15578 "type": "string" 15579 }, 15580 "url": { 15581 "type": "string" 15582 }, 15583 "id": { 15584 "type": "integer" 15585 }, 15586 "body": { 15587 "type": "string" 15588 }, 15589 "path": { 15590 "type": "string" 15591 }, 15592 "position": { 15593 "type": "integer" 15594 }, 15595 "line": { 15596 "type": "integer" 15597 }, 15598 "commit_id": { 15599 "type": "string" 15600 }, 15601 "user": { 15602 "properties": { 15603 "login": { 15604 "type": "string" 15605 }, 15606 "id": { 15607 "type": "integer" 15608 }, 15609 "avatar_url": { 15610 "type": "string" 15611 }, 15612 "gravatar_id": { 15613 "type": "string" 15614 }, 15615 "url": { 15616 "type": "string" 15617 } 15618 }, 15619 "type": "object" 15620 }, 15621 "created_at": { 15622 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 15623 "type": "string" 15624 }, 15625 "updated_at": { 15626 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 15627 "type": "string" 15628 } 15629 } 15630 } 15631 example: | 15632 { 15633 "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", 15634 "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", 15635 "id": 1, 15636 "body": "Great stuff", 15637 "path": "file1.txt", 15638 "position": 4, 15639 "line": 14, 15640 "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 15641 "user": { 15642 "login": "octocat", 15643 "id": 1, 15644 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 15645 "gravatar_id": "somehexcode", 15646 "url": "https://api.github.com/users/octocat" 15647 }, 15648 "created_at": "2011-04-14T16:00:49Z", 15649 "updated_at": "2011-04-14T16:00:49Z" 15650 } 15651 /contents/{path}: 15652 uriParameters: 15653 path: 15654 type: string 15655 type: base 15656 get: 15657 description: | 15658 Get contents. 15659 This method returns the contents of a file or directory in a repository. 15660 Files and symlinks support a custom media type for getting the raw content. 15661 Directories and submodules do not support custom media types. 15662 Note: This API supports files up to 1 megabyte in size. 15663 Here can be many outcomes. For details see "http://developer.github.com/v3/repos/contents/" 15664 queryParameters: 15665 path: 15666 description: The content path. 15667 type: string 15668 ref: 15669 description: The String name of the Commit/Branch/Tag. Defaults to 'master'. 15670 type: string 15671 responses: 15672 200: 15673 body: 15674 application/json: 15675 #TODO many outcomes 15676 schema: | 15677 { 15678 "$schema": "http://json-schema.org/draft-03/schema", 15679 "type": "object", 15680 "properties": { 15681 "type": { 15682 "type": "string" 15683 }, 15684 "encoding": { 15685 "type": "string" 15686 }, 15687 "size": { 15688 "type": "integer" 15689 }, 15690 "name": { 15691 "type": "string" 15692 }, 15693 "path": { 15694 "type": "string" 15695 }, 15696 "content": { 15697 "type": "string" 15698 }, 15699 "sha": { 15700 "type": "string" 15701 }, 15702 "url": { 15703 "type": "string" 15704 }, 15705 "git_url": { 15706 "type": "string" 15707 }, 15708 "html_url": { 15709 "type": "string" 15710 }, 15711 "_links": { 15712 "properties": { 15713 "git": { 15714 "type": "string" 15715 }, 15716 "self": { 15717 "type": "string" 15718 }, 15719 "html": { 15720 "type": "string" 15721 } 15722 }, 15723 "type": "object" 15724 } 15725 } 15726 } 15727 example: | 15728 { 15729 "type": "file", 15730 "encoding": "base64", 15731 "size": 5362, 15732 "name": "README.md", 15733 "path": "README.md", 15734 "content": "encoded content ...", 15735 "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", 15736 "url": "https://api.github.com/repos/pengwynn/octokit/contents/README.md", 15737 "git_url": "https://api.github.com/repos/pengwynn/octokit/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", 15738 "html_url": "https://github.com/pengwynn/octokit/blob/master/README.md", 15739 "_links": { 15740 "git": "https://api.github.com/repos/pengwynn/octokit/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", 15741 "self": "https://api.github.com/repos/pengwynn/octokit/contents/README.md", 15742 "html": "https://github.com/pengwynn/octokit/blob/master/README.md" 15743 } 15744 } 15745 put: 15746 description: Create a file. 15747 body: 15748 application/json: 15749 schema: | 15750 { 15751 "$schema": "http://json-schema.org/draft-03/schema", 15752 "type": "object", 15753 "properties": { 15754 "content": { 15755 "properties": { 15756 "name": { 15757 "type": "string" 15758 }, 15759 "path": { 15760 "type": "string" 15761 }, 15762 "sha": { 15763 "type": "string" 15764 }, 15765 "size": { 15766 "type": "integer" 15767 }, 15768 "url": { 15769 "type": "string" 15770 }, 15771 "html_url": { 15772 "type": "string" 15773 }, 15774 "git_url": { 15775 "type": "string" 15776 }, 15777 "type": { 15778 "type": "string" 15779 }, 15780 "_links": { 15781 "properties": { 15782 "self": { 15783 "type": "string" 15784 }, 15785 "git": { 15786 "type": "string" 15787 }, 15788 "html": { 15789 "type": "string" 15790 } 15791 }, 15792 "type": "object" 15793 } 15794 }, 15795 "type": "object" 15796 }, 15797 "commit": { 15798 "properties": { 15799 "sha": { 15800 "type": "string" 15801 }, 15802 "url": { 15803 "type": "string" 15804 }, 15805 "html_url": { 15806 "type": "string" 15807 }, 15808 "author": { 15809 "properties": { 15810 "date": { 15811 "type": "string" 15812 }, 15813 "name": { 15814 "type": "string" 15815 }, 15816 "email": { 15817 "type": "string" 15818 } 15819 }, 15820 "type": "object" 15821 }, 15822 "committer": { 15823 "properties": { 15824 "date": { 15825 "type": "string" 15826 }, 15827 "name": { 15828 "type": "string" 15829 }, 15830 "email": { 15831 "type": "string" 15832 } 15833 }, 15834 "type": "object" 15835 }, 15836 "message": { 15837 "type": "string" 15838 }, 15839 "tree": { 15840 "properties": { 15841 "url": { 15842 "type": "string" 15843 }, 15844 "sha": { 15845 "type": "string" 15846 } 15847 }, 15848 "type": "object" 15849 }, 15850 "parents": [ 15851 { 15852 "properties": { 15853 "url": { 15854 "type": "string" 15855 }, 15856 "html_url": { 15857 "type": "string" 15858 }, 15859 "sha": { 15860 "type": "string" 15861 } 15862 }, 15863 "type": "object" 15864 } 15865 ] 15866 }, 15867 "type": "object" 15868 } 15869 } 15870 } 15871 responses: 15872 200: 15873 body: 15874 schema: | 15875 { 15876 "$schema": "http://json-schema.org/draft-03/schema", 15877 "type": "object", 15878 "properties": { 15879 "path": { 15880 "description": "The content path.", 15881 "type": "string" 15882 }, 15883 "message": { 15884 "description": "The commit message.", 15885 "type": "string" 15886 }, 15887 "content": { 15888 "description": "The new file content, Base64 encoded.", 15889 "type": "string" 15890 }, 15891 "sha": { 15892 "description": "Is included if we want to modify existing file. The blob SHA of the file being replaced.", 15893 "type": "string" 15894 }, 15895 "branch": { 15896 "description": "The branch name. If not provided, uses the repository's default branch (usually master).", 15897 "type": "string" 15898 }, 15899 "author": { 15900 "properties": { 15901 "name": { 15902 "description": "The name of the author of the commit.", 15903 "type": "string" 15904 }, 15905 "email": { 15906 "description": "The email of the author of the commit", 15907 "type": "string" 15908 } 15909 }, 15910 "type": "object" 15911 }, 15912 "committer": { 15913 "properties": { 15914 "name": { 15915 "description": "The name of the committer of the commit.", 15916 "type": "string" 15917 }, 15918 "email": { 15919 "description": "The email of the committer of the commit.", 15920 "type": "string" 15921 } 15922 }, 15923 "type": "object" 15924 } 15925 }, 15926 "required": [ "path", "message", "content", "branch" ] 15927 } 15928 example: | 15929 { 15930 "content": { 15931 "name": "hello.txt", 15932 "path": "notes/hello.txt", 15933 "sha": "95b966ae1c166bd92f8ae7d1c313e738c731dfc3", 15934 "size": 9, 15935 "url": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", 15936 "html_url": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt", 15937 "git_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3", 15938 "type": "file", 15939 "_links": { 15940 "self": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", 15941 "git": "https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3", 15942 "html": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt" 15943 } 15944 }, 15945 "commit": { 15946 "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", 15947 "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", 15948 "html_url": "https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd", 15949 "author": { 15950 "date": "2010-04-10T14:10:01-07:00", 15951 "name": "Scott Chacon", 15952 "email": "schacon@gmail.com" 15953 }, 15954 "committer": { 15955 "date": "2010-04-10T14:10:01-07:00", 15956 "name": "Scott Chacon", 15957 "email": "schacon@gmail.com" 15958 }, 15959 "message": "my commit message", 15960 "tree": { 15961 "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", 15962 "sha": "691272480426f78a0138979dd3ce63b77f706feb" 15963 }, 15964 "parents": [ 15965 { 15966 "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", 15967 "html_url": "https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5", 15968 "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5" 15969 } 15970 ] 15971 } 15972 } 15973 delete: 15974 body: 15975 application/json: 15976 schema: | 15977 { 15978 "$schema": "http://json-schema.org/draft-03/schema", 15979 "type": "object", 15980 "properties": { 15981 "path": { 15982 "description": "The content path.", 15983 "type": "string" 15984 }, 15985 "message": { 15986 "description": "The commit message.", 15987 "type": "string" 15988 }, 15989 "content": { 15990 "description": "The new file content, Base64 encoded.", 15991 "type": "string" 15992 }, 15993 "sha": { 15994 "description": "The blob SHA of the file being removed.", 15995 "type": "string" 15996 }, 15997 "branch": { 15998 "description": "The branch name. If not provided, uses the repository's default branch (usually master).", 15999 "type": "string" 16000 }, 16001 "author": { 16002 "properties": { 16003 "name": { 16004 "description": "The name of the author of the commit.", 16005 "type": "string" 16006 }, 16007 "email": { 16008 "description": "The email of the author of the commit", 16009 "type": "string" 16010 } 16011 }, 16012 "type": "object" 16013 }, 16014 "committer": { 16015 "properties": { 16016 "name": { 16017 "description": "The name of the committer of the commit.", 16018 "type": "string" 16019 }, 16020 "email": { 16021 "description": "The email of the committer of the commit.", 16022 "type": "string" 16023 } 16024 }, 16025 "type": "object" 16026 } 16027 }, 16028 "required": [ "path", "message", "sha" ] 16029 } 16030 description: | 16031 Delete a file. 16032 This method deletes a file in a repository. 16033 responses: 16034 200: 16035 body: 16036 schema: | 16037 { 16038 "$schema": "http://json-schema.org/draft-03/schema", 16039 "type": "object", 16040 "properties": { 16041 "content": { 16042 "type": "string" 16043 }, 16044 "commit": { 16045 "properties": { 16046 "sha": { 16047 "type": "string" 16048 }, 16049 "url": { 16050 "type": "string" 16051 }, 16052 "html_url": { 16053 "type": "string" 16054 }, 16055 "author": { 16056 "properties": { 16057 "date": { 16058 "type": "string" 16059 }, 16060 "name": { 16061 "type": "string" 16062 }, 16063 "email": { 16064 "type": "string" 16065 } 16066 }, 16067 "type": "object" 16068 }, 16069 "committer": { 16070 "date": { 16071 "type": "string" 16072 }, 16073 "name": { 16074 "type": "string" 16075 }, 16076 "email": { 16077 "type": "string" 16078 } 16079 }, 16080 "message": { 16081 "type": "string" 16082 }, 16083 "tree": { 16084 "properties": { 16085 "url": { 16086 "type": "string" 16087 }, 16088 "sha": { 16089 "type": "string" 16090 } 16091 }, 16092 "type": "object" 16093 }, 16094 "parents": [ 16095 { 16096 "properties": { 16097 "url": { 16098 "type": "string" 16099 }, 16100 "html_url": { 16101 "type": "string" 16102 }, 16103 "sha": { 16104 "type": "string" 16105 } 16106 }, 16107 "type": "object" 16108 } 16109 ] 16110 }, 16111 "type": "object" 16112 } 16113 } 16114 } 16115 example: | 16116 { 16117 "content": null, 16118 "commit": { 16119 "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", 16120 "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", 16121 "html_url": "https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd", 16122 "author": { 16123 "date": "2010-04-10T14:10:01-07:00", 16124 "name": "Scott Chacon", 16125 "email": "schacon@gmail.com" 16126 }, 16127 "committer": { 16128 "date": "2010-04-10T14:10:01-07:00", 16129 "name": "Scott Chacon", 16130 "email": "schacon@gmail.com" 16131 }, 16132 "message": "my commit message", 16133 "tree": { 16134 "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", 16135 "sha": "691272480426f78a0138979dd3ce63b77f706feb" 16136 }, 16137 "parents": [ 16138 { 16139 "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", 16140 "html_url": "https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5", 16141 "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5" 16142 } 16143 ] 16144 } 16145 } 16146 /{archive_format}/{path}: 16147 type: base 16148 uriParameters: 16149 archive_format: 16150 enum: 16151 - tarball 16152 - zipball 16153 required: true 16154 path: 16155 description: Valid Git reference, defaults to 'master'. 16156 type: string 16157 get: 16158 description: | 16159 Get archive link. 16160 This method will return a 302 to a URL to download a tarball or zipball 16161 archive for a repository. Please make sure your HTTP framework is 16162 configured to follow redirects or you will need to use the Location header 16163 to make a second GET request. 16164 Note: For private repositories, these links are temporary and expire quickly. 16165 responses: 16166 302: 16167 description: Found. 16168 /downloads: 16169 type: collection 16170 get: 16171 description: List downloads for a repository. 16172 responses: 16173 200: 16174 body: 16175 schema: | 16176 { 16177 "$schema": "http://json-schema.org/draft-03/schema", 16178 "type": "array", 16179 "list": [ 16180 { 16181 "properties": { 16182 "url": { 16183 "type": "string" 16184 }, 16185 "html_url": { 16186 "type": "string" 16187 }, 16188 "id": { 16189 "type": "integer" 16190 }, 16191 "name": { 16192 "type": "string" 16193 }, 16194 "description": { 16195 "type": "string" 16196 }, 16197 "size": { 16198 "type": "integer" 16199 }, 16200 "download_count": { 16201 "type": "integer" 16202 }, 16203 "content_type": { 16204 "type": "string" 16205 } 16206 }, 16207 "type": "object" 16208 } 16209 ] 16210 } 16211 example: | 16212 { 16213 "url": "https://api.github.com/repos/octocat/Hello-World/downloads/1", 16214 "html_url": "https://github.com/repos/octocat/Hello-World/downloads/new_file.jpg", 16215 "id": 1, 16216 "name": "new_file.jpg", 16217 "description": "Description of your download", 16218 "size": 1024, 16219 "download_count": 40, 16220 "content_type": ".jpg" 16221 } 16222 post: 16223 description: | 16224 Create a new download (Part 1: Create the resource). 16225 For part 2 see http://developer.github.com/v3/repos/downloads/#create-a-new-download-part-2-upload-file-to-s3 16226 body: 16227 application/json: 16228 schema: | 16229 { 16230 "$schema": "http://json-schema.org/draft-03/schema", 16231 "type": "object", 16232 "properties": { 16233 "name": { 16234 "type": "string" 16235 }, 16236 "size": { 16237 "description": "Size of file in bytes.", 16238 "type": "integer" 16239 }, 16240 "description": { 16241 "type": "string" 16242 }, 16243 "content_type": { 16244 "type": "string" 16245 } 16246 }, 16247 "required": [ "name", "size" ] 16248 } 16249 responses: 16250 201: 16251 body: 16252 schema: | 16253 { 16254 "$schema": "http://json-schema.org/draft-03/schema", 16255 "type": "object", 16256 "properties": { 16257 "url": { 16258 "type": "string" 16259 }, 16260 "html_url": { 16261 "type": "string" 16262 }, 16263 "id": { 16264 "type": "integer" 16265 }, 16266 "name": { 16267 "type": "string" 16268 }, 16269 "description": { 16270 "type": "string" 16271 }, 16272 "size": { 16273 "type": "integer" 16274 }, 16275 "download_count": { 16276 "type": "integer" 16277 }, 16278 "content_type": { 16279 "type": "string" 16280 }, 16281 "policy": { 16282 "type": "string" 16283 }, 16284 "signature": { 16285 "type": "string" 16286 }, 16287 "bucket": { 16288 "type": "string" 16289 }, 16290 "accesskeyid": { 16291 "type": "string" 16292 }, 16293 "path": { 16294 "type": "string" 16295 }, 16296 "acl": { 16297 "type": "string" 16298 }, 16299 "expirationdate": { 16300 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 16301 "type": "string" 16302 }, 16303 "prefix": { 16304 "type": "string" 16305 }, 16306 "mime_type": { 16307 "type": "string" 16308 }, 16309 "redirect": { 16310 "type": "boolean" 16311 }, 16312 "s3_url": { 16313 "type": "string" 16314 } 16315 } 16316 } 16317 example: | 16318 { 16319 "url": "https://api.github.com/repos/octocat/Hello-World/downloads/1", 16320 "html_url": "https://github.com/repos/octocat/Hello-World/downloads/new_file.jpg", 16321 "id": 1, 16322 "name": "new_file.jpg", 16323 "description": "Description of your download", 16324 "size": 1024, 16325 "download_count": 40, 16326 "content_type": ".jpg", 16327 "policy": "ewogICAg...", 16328 "signature": "mwnFDC...", 16329 "bucket": "github", 16330 "accesskeyid": "1ABCDEFG...", 16331 "path": "downloads/octocat/Hello-World/new_file.jpg", 16332 "acl": "public-read", 16333 "expirationdate": "2011-04-14T16:00:49Z", 16334 "prefix": "downloads/octocat/Hello-World/", 16335 "mime_type": "image/jpeg", 16336 "redirect": false, 16337 "s3_url": "https://github.s3.amazonaws.com/" 16338 } 16339 /{downloadId}: 16340 type: item 16341 uriParameters: 16342 downloadId: 16343 description: Id of the download. 16344 type: integer 16345 get: 16346 description: Get a single download. 16347 responses: 16348 200: 16349 body: 16350 schema: | 16351 { 16352 "$schema": "http://json-schema.org/draft-03/schema", 16353 "type": "array", 16354 "list": [ 16355 { 16356 "properties": { 16357 "url": { 16358 "type": "string" 16359 }, 16360 "html_url": { 16361 "type": "string" 16362 }, 16363 "id": { 16364 "type": "integer" 16365 }, 16366 "name": { 16367 "type": "string" 16368 }, 16369 "description": { 16370 "type": "string" 16371 }, 16372 "size": { 16373 "type": "integer" 16374 }, 16375 "download_count": { 16376 "type": "integer" 16377 }, 16378 "content_type": { 16379 "type": "string" 16380 } 16381 }, 16382 "type": "object" 16383 } 16384 ] 16385 } 16386 example: | 16387 delete: 16388 description: Delete a download. 16389 /forks: 16390 type: collection 16391 get: 16392 description: List forks. 16393 queryParameters: 16394 sort: 16395 enum: 16396 - newest 16397 - oldest 16398 - watchers 16399 default: newest 16400 responses: 16401 200: 16402 body: 16403 schema: | 16404 { 16405 "$schema": "http://json-schema.org/draft-03/schema", 16406 "type": "array", 16407 "list": [ 16408 { 16409 "properties": { 16410 "id": { 16411 "type": "integer" 16412 }, 16413 "owner": { 16414 "properties": { 16415 "login": { 16416 "type": "string" 16417 }, 16418 "id": { 16419 "type": "integer" 16420 }, 16421 "avatar_url": { 16422 "type": "string" 16423 }, 16424 "gravatar_id": { 16425 "type": "string" 16426 }, 16427 "url": { 16428 "type": "string" 16429 } 16430 }, 16431 "type": "object" 16432 }, 16433 "name": { 16434 "type": "string" 16435 }, 16436 "full_name": { 16437 "type": "string" 16438 }, 16439 "description": { 16440 "type": "string" 16441 }, 16442 "private": { 16443 "type": "boolean" 16444 }, 16445 "fork": { 16446 "type": "boolean" 16447 }, 16448 "url": { 16449 "type": "string" 16450 }, 16451 "html_url": { 16452 "type": "string" 16453 }, 16454 "clone_url": { 16455 "type": "string" 16456 }, 16457 "git_url": { 16458 "type": "string" 16459 }, 16460 "ssh_url": { 16461 "type": "string" 16462 }, 16463 "svn_url": { 16464 "type": "string" 16465 }, 16466 "mirror_url": { 16467 "type": "string" 16468 }, 16469 "homepage": { 16470 "type": "string" 16471 }, 16472 "language": { 16473 "type": "string" 16474 }, 16475 "forks": { 16476 "type": "integer" 16477 }, 16478 "forks_count": { 16479 "type": "integer" 16480 }, 16481 "watchers": { 16482 "type": "integer" 16483 }, 16484 "watchers_count": { 16485 "type": "integer" 16486 }, 16487 "size": { 16488 "type": "integer" 16489 }, 16490 "master_branch": { 16491 "type": "string" 16492 }, 16493 "open_issues": { 16494 "type": "integer" 16495 }, 16496 "open_issues_count": { 16497 "type": "integer" 16498 }, 16499 "pushed_at": { 16500 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 16501 "type": "string" 16502 }, 16503 "created_at": { 16504 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 16505 "type": "string" 16506 }, 16507 "updated_at": { 16508 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 16509 "type": "string" 16510 } 16511 }, 16512 "type": "object" 16513 } 16514 ] 16515 } 16516 example: | 16517 [ 16518 { 16519 "id": 1296269, 16520 "owner": { 16521 "login": "octocat", 16522 "id": 1, 16523 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 16524 "gravatar_id": "somehexcode", 16525 "url": "https://api.github.com/users/octocat" 16526 }, 16527 "name": "Hello-World", 16528 "full_name": "octocat/Hello-World", 16529 "description": "This your first repo!", 16530 "private": false, 16531 "fork": true, 16532 "url": "https://api.github.com/repos/octocat/Hello-World", 16533 "html_url": "https://github.com/octocat/Hello-World", 16534 "clone_url": "https://github.com/octocat/Hello-World.git", 16535 "git_url": "git://github.com/octocat/Hello-World.git", 16536 "ssh_url": "git@github.com:octocat/Hello-World.git", 16537 "svn_url": "https://svn.github.com/octocat/Hello-World", 16538 "mirror_url": "git://git.example.com/octocat/Hello-World", 16539 "homepage": "https://github.com", 16540 "language": null, 16541 "forks": 9, 16542 "forks_count": 9, 16543 "watchers": 80, 16544 "watchers_count": 80, 16545 "size": 108, 16546 "master_branch": "master", 16547 "open_issues": 0, 16548 "open_issues_count": 0, 16549 "pushed_at": "2011-01-26T19:06:43Z", 16550 "created_at": "2011-01-26T19:01:12Z", 16551 "updated_at": "2011-01-26T19:14:43Z" 16552 } 16553 ] 16554 post: 16555 description: | 16556 Create a fork. 16557 Forking a Repository happens asynchronously. Therefore, you may have to wait 16558 a short period before accessing the git objects. If this takes longer than 5 16559 minutes, be sure to contact Support. 16560 body: 16561 application/json: 16562 schema: | 16563 { 16564 "$schema": "http://json-schema.org/draft-03/schema", 16565 "type": "object", 16566 "properties": { 16567 "organization": { 16568 "description": "Organization login. The repository will be forked into this organization.", 16569 "type": "string" 16570 } 16571 } 16572 } 16573 responses: 16574 201: 16575 body: 16576 schema: | 16577 { 16578 "$schema": "http://json-schema.org/draft-03/schema", 16579 "type": "object", 16580 "properties": { 16581 "id": { 16582 "type": "integer" 16583 }, 16584 "owner": { 16585 "properties": { 16586 "login": { 16587 "type": "string" 16588 }, 16589 "id": { 16590 "type": "integer" 16591 }, 16592 "avatar_url": { 16593 "type": "string" 16594 }, 16595 "gravatar_id": { 16596 "type": "string" 16597 }, 16598 "url": { 16599 "type": "string" 16600 } 16601 }, 16602 "type": "object" 16603 }, 16604 "name": { 16605 "type": "string" 16606 }, 16607 "full_name": { 16608 "type": "string" 16609 }, 16610 "description": { 16611 "type": "string" 16612 }, 16613 "private": { 16614 "type": "boolean" 16615 }, 16616 "fork": { 16617 "type": "boolean" 16618 }, 16619 "url": { 16620 "type": "string" 16621 }, 16622 "html_url": { 16623 "type": "string" 16624 }, 16625 "clone_url": { 16626 "type": "string" 16627 }, 16628 "git_url": { 16629 "type": "string" 16630 }, 16631 "ssh_url": { 16632 "type": "string" 16633 }, 16634 "svn_url": { 16635 "type": "string" 16636 }, 16637 "mirror_url": { 16638 "type": "string" 16639 }, 16640 "homepage": { 16641 "type": "string" 16642 }, 16643 "language": { 16644 "type": "string" 16645 }, 16646 "forks": { 16647 "type": "integer" 16648 }, 16649 "forks_count": { 16650 "type": "integer" 16651 }, 16652 "watchers": { 16653 "type": "integer" 16654 }, 16655 "watchers_count": { 16656 "type": "integer" 16657 }, 16658 "size": { 16659 "type": "integer" 16660 }, 16661 "master_branch": { 16662 "type": "string" 16663 }, 16664 "open_issues": { 16665 "type": "integer" 16666 }, 16667 "open_issues_count": { 16668 "type": "integer" 16669 }, 16670 "pushed_at": { 16671 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 16672 "type": "string" 16673 }, 16674 "created_at": { 16675 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 16676 "type": "string" 16677 }, 16678 "updated_at": { 16679 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 16680 "type": "string" 16681 } 16682 } 16683 } 16684 example: | 16685 { 16686 "id": 1296269, 16687 "owner": { 16688 "login": "octocat", 16689 "id": 1, 16690 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 16691 "gravatar_id": "somehexcode", 16692 "url": "https://api.github.com/users/octocat" 16693 }, 16694 "name": "Hello-World", 16695 "full_name": "octocat/Hello-World", 16696 "description": "This your first repo!", 16697 "private": false, 16698 "fork": true, 16699 "url": "https://api.github.com/repos/octocat/Hello-World", 16700 "html_url": "https://github.com/octocat/Hello-World", 16701 "clone_url": "https://github.com/octocat/Hello-World.git", 16702 "git_url": "git://github.com/octocat/Hello-World.git", 16703 "ssh_url": "git@github.com:octocat/Hello-World.git", 16704 "svn_url": "https://svn.github.com/octocat/Hello-World", 16705 "mirror_url": "git://git.example.com/octocat/Hello-World", 16706 "homepage": "https://github.com", 16707 "language": null, 16708 "forks": 9, 16709 "forks_count": 9, 16710 "watchers": 80, 16711 "watchers_count": 80, 16712 "size": 108, 16713 "master_branch": "master", 16714 "open_issues": 0, 16715 "open_issues_count": 0, 16716 "pushed_at": "2011-01-26T19:06:43Z", 16717 "created_at": "2011-01-26T19:01:12Z", 16718 "updated_at": "2011-01-26T19:14:43Z" 16719 } 16720 /keys: 16721 type: collection 16722 get: 16723 description: Get list of keys. 16724 responses: 16725 200: 16726 body: 16727 schema: | 16728 { 16729 "$schema": "http://json-schema.org/draft-03/schema", 16730 "type": "array", 16731 "list": [ 16732 { 16733 "properties": { 16734 "id": { 16735 "type": "integer" 16736 }, 16737 "key": { 16738 "type": "string" 16739 }, 16740 "url": { 16741 "type": "string" 16742 }, 16743 "title": { 16744 "type": "string" 16745 } 16746 }, 16747 "type": "object" 16748 } 16749 ] 16750 } 16751 example: | 16752 [ 16753 { 16754 "id": 1, 16755 "key": "ssh-rsa AAA...", 16756 "url": "https://api.github.com/user/keys/1", 16757 "title": "octocat@octomac" 16758 } 16759 ] 16760 post: 16761 description: Create a key. 16762 body: 16763 application/json: 16764 schema: | 16765 { 16766 "$schema": "http://json-schema.org/draft-03/schema", 16767 "type": "object", 16768 "properties": { 16769 "title": { 16770 "type": "string" 16771 }, 16772 "key": { 16773 "type": "string" 16774 } 16775 } 16776 } 16777 responses: 16778 201: 16779 body: 16780 schema: | 16781 { 16782 "$schema": "http://json-schema.org/draft-03/schema", 16783 "type": "object", 16784 "properties": { 16785 "id": { 16786 "type": "integer" 16787 }, 16788 "key": { 16789 "type": "string" 16790 }, 16791 "url": { 16792 "type": "string" 16793 }, 16794 "title": { 16795 "type": "string" 16796 } 16797 } 16798 } 16799 example: | 16800 { 16801 "id": 1, 16802 "key": "ssh-rsa AAA...", 16803 "url": "https://api.github.com/user/keys/1", 16804 "title": "octocat@octomac" 16805 } 16806 /{keyId}: 16807 uriParameters: 16808 keyId: 16809 description: Id of a key. 16810 type: integer 16811 type: item 16812 get: 16813 description: Get a key 16814 responses: 16815 200: 16816 body: 16817 schema: | 16818 { 16819 "$schema": "http://json-schema.org/draft-03/schema", 16820 "type": "object", 16821 "properties": { 16822 "id": { 16823 "type": "integer" 16824 }, 16825 "key": { 16826 "type": "string" 16827 }, 16828 "url": { 16829 "type": "string" 16830 }, 16831 "title": { 16832 "type": "string" 16833 } 16834 } 16835 } 16836 example: | 16837 { 16838 "id": 1, 16839 "key": "ssh-rsa AAA...", 16840 "url": "https://api.github.com/user/keys/1", 16841 "title": "octocat@octomac" 16842 } 16843 patch: 16844 body: 16845 application/json: 16846 schema: | 16847 { 16848 "$schema": "http://json-schema.org/draft-03/schema", 16849 "type": "object", 16850 "properties": { 16851 "title": { 16852 "type": "string" 16853 }, 16854 "key": { 16855 "type": "string" 16856 } 16857 } 16858 } 16859 responses: 16860 200: 16861 body: 16862 schema: | 16863 { 16864 "$schema": "http://json-schema.org/draft-03/schema", 16865 "type": "object", 16866 "properties": { 16867 "id": { 16868 "type": "integer" 16869 }, 16870 "key": { 16871 "type": "string" 16872 }, 16873 "url": { 16874 "type": "string" 16875 }, 16876 "title": { 16877 "type": "string" 16878 } 16879 } 16880 } 16881 example: | 16882 { 16883 "id": 1, 16884 "key": "ssh-rsa AAA...", 16885 "url": "https://api.github.com/user/keys/1", 16886 "title": "octocat@octomac" 16887 } 16888 description: Edit a key. 16889 delete: 16890 description: Delete a key. 16891 /hooks: 16892 type: collection 16893 get: 16894 description: Get list of hooks. 16895 responses: 16896 200: 16897 body: 16898 schema: | 16899 { 16900 "$schema": "http://json-schema.org/draft-03/schema", 16901 "type": "object", 16902 "properties": { 16903 "url": { 16904 "type": "string" 16905 }, 16906 "updated_at": { 16907 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 16908 "type": "string" 16909 }, 16910 "created_at": { 16911 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 16912 "type": "string" 16913 }, 16914 "name": { 16915 "type": "string" 16916 }, 16917 "events": [ 16918 { 16919 "enum": [ 16920 "push", 16921 "issues", 16922 "issue_comment", 16923 "commit_comment", 16924 "pull_request", 16925 "pull_request_review_comment", 16926 "gollum", 16927 "watch", 16928 "download", 16929 "fork", 16930 "fork_apply", 16931 "member", 16932 "public", 16933 "team_add", 16934 "status" 16935 ] 16936 } 16937 ], 16938 "type": "array", 16939 "active": { 16940 "type": "boolean" 16941 }, 16942 "config": { 16943 "properties": { 16944 "url": { 16945 "type": "string" 16946 }, 16947 "content_type": { 16948 "type": "string" 16949 } 16950 }, 16951 "type": "object" 16952 }, 16953 "id": { 16954 "type": "integer" 16955 } 16956 } 16957 } 16958 example: | 16959 [ 16960 { 16961 "url": "https://api.github.com/repos/octocat/Hello-World/hooks/1", 16962 "updated_at": "2011-09-06T20:39:23Z", 16963 "created_at": "2011-09-06T17:26:27Z", 16964 "name": "web", 16965 "events": [ 16966 "push", 16967 "pull_request" 16968 ], 16969 "active": true, 16970 "config": { 16971 "url": "http://example.com", 16972 "content_type": "json" 16973 }, 16974 "id": 1 16975 } 16976 ] 16977 post: 16978 description: Create a hook. 16979 body: 16980 application/json: 16981 schema: | 16982 { 16983 "$schema": "http://json-schema.org/draft-03/schema", 16984 "type": "object", 16985 "properties": { 16986 "config": { 16987 "description": "A Hash containing key/value pairs to provide settings for this hook. Modifying this will replace the entire config object. These settings vary between the services and are defined in the github-services repo. Booleans are stored internally as \"1\" for true, and \"0\" for false. Any JSON true/false values will be converted automatically.", 16988 "type": "string" 16989 }, 16990 "events": [ 16991 { 16992 "enum": [ 16993 "push", 16994 "issues", 16995 "issue_comment", 16996 "commit_comment", 16997 "pull_request", 16998 "pull_request_review_comment", 16999 "gollum", 17000 "watch", 17001 "download", 17002 "fork", 17003 "fork_apply", 17004 "member", 17005 "public", 17006 "team_add", 17007 "status" 17008 ] 17009 } 17010 ], 17011 "type": "array", 17012 "add_events": [ 17013 { 17014 "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", 17015 "enum": [ 17016 "push", 17017 "issues", 17018 "issue_comment", 17019 "commit_comment", 17020 "pull_request", 17021 "pull_request_review_comment", 17022 "gollum", 17023 "watch", 17024 "download", 17025 "fork", 17026 "fork_apply", 17027 "member", 17028 "public", 17029 "team_add", 17030 "status" 17031 ] 17032 } 17033 ], 17034 "type": "array", 17035 "remove_events": [ 17036 { 17037 "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", 17038 "enum": [ 17039 "push", 17040 "issues", 17041 "issue_comment", 17042 "commit_comment", 17043 "pull_request", 17044 "pull_request_review_comment", 17045 "gollum", 17046 "watch", 17047 "download", 17048 "fork", 17049 "fork_apply", 17050 "member", 17051 "public", 17052 "team_add", 17053 "status" 17054 ] 17055 } 17056 ], 17057 "type": "array", 17058 "active": { 17059 "description": "Determines whether the hook is actually triggered on pushes.", 17060 "type": "boolean" 17061 } 17062 } 17063 } 17064 responses: 17065 201: 17066 body: 17067 schema: | 17068 { 17069 "$schema": "http://json-schema.org/draft-03/schema", 17070 "type": "object", 17071 "properties": { 17072 "url": { 17073 "type": "string" 17074 }, 17075 "updated_at": { 17076 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 17077 "type": "string" 17078 }, 17079 "created_at": { 17080 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 17081 "type": "string" 17082 }, 17083 "name": { 17084 "type": "string" 17085 }, 17086 "events": [ 17087 { 17088 "enum": [ 17089 "push", 17090 "issues", 17091 "issue_comment", 17092 "commit_comment", 17093 "pull_request", 17094 "pull_request_review_comment", 17095 "gollum", 17096 "watch", 17097 "download", 17098 "fork", 17099 "fork_apply", 17100 "member", 17101 "public", 17102 "team_add", 17103 "status" 17104 ] 17105 } 17106 ], 17107 "type": "array", 17108 "active": { 17109 "type": "boolean" 17110 }, 17111 "config": { 17112 "properties": { 17113 "url": { 17114 "type": "string" 17115 }, 17116 "content_type": { 17117 "type": "string" 17118 } 17119 }, 17120 "type": "object" 17121 }, 17122 "id": { 17123 "type": "integer" 17124 } 17125 } 17126 } 17127 example: | 17128 [ 17129 { 17130 "url": "https://api.github.com/repos/octocat/Hello-World/hooks/1", 17131 "updated_at": "2011-09-06T20:39:23Z", 17132 "created_at": "2011-09-06T17:26:27Z", 17133 "name": "web", 17134 "events": [ 17135 "push", 17136 "pull_request" 17137 ], 17138 "active": true, 17139 "config": { 17140 "url": "http://example.com", 17141 "content_type": "json" 17142 }, 17143 "id": 1 17144 } 17145 ] 17146 /{hookId}: 17147 uriParameters: 17148 hookId: 17149 description: Id of the hook. 17150 type: integer 17151 type: item 17152 get: 17153 description: Get single hook. 17154 responses: 17155 200: 17156 body: 17157 schema: | 17158 { 17159 "$schema": "http://json-schema.org/draft-03/schema", 17160 "type": "object", 17161 "properties": { 17162 "url": { 17163 "type": "string" 17164 }, 17165 "updated_at": { 17166 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 17167 "type": "string" 17168 }, 17169 "created_at": { 17170 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 17171 "type": "string" 17172 }, 17173 "name": { 17174 "type": "string" 17175 }, 17176 "events": [ 17177 { 17178 "enum": [ 17179 "push", 17180 "issues", 17181 "issue_comment", 17182 "commit_comment", 17183 "pull_request", 17184 "pull_request_review_comment", 17185 "gollum", 17186 "watch", 17187 "download", 17188 "fork", 17189 "fork_apply", 17190 "member", 17191 "public", 17192 "team_add", 17193 "status" 17194 ] 17195 } 17196 ], 17197 "type": "array", 17198 "active": { 17199 "type": "boolean" 17200 }, 17201 "config": { 17202 "properties": { 17203 "url": { 17204 "type": "string" 17205 }, 17206 "content_type": { 17207 "type": "string" 17208 } 17209 }, 17210 "type": "object" 17211 }, 17212 "id": { 17213 "type": "integer" 17214 } 17215 } 17216 } 17217 example: | 17218 [ 17219 { 17220 "url": "https://api.github.com/repos/octocat/Hello-World/hooks/1", 17221 "updated_at": "2011-09-06T20:39:23Z", 17222 "created_at": "2011-09-06T17:26:27Z", 17223 "name": "web", 17224 "events": [ 17225 "push", 17226 "pull_request" 17227 ], 17228 "active": true, 17229 "config": { 17230 "url": "http://example.com", 17231 "content_type": "json" 17232 }, 17233 "id": 1 17234 } 17235 ] 17236 patch: 17237 description: Edit a hook. 17238 body: 17239 application/json: 17240 schema: | 17241 { 17242 "$schema": "http://json-schema.org/draft-03/schema", 17243 "type": "object", 17244 "properties": { 17245 "config": { 17246 "description": "A Hash containing key/value pairs to provide settings for this hook. Modifying this will replace the entire config object. These settings vary between the services and are defined in the github-services repo. Booleans are stored internally as \"1\" for true, and \"0\" for false. Any JSON true/false values will be converted automatically.", 17247 "type": "string" 17248 }, 17249 "events": [ 17250 { 17251 "enum": [ 17252 "push", 17253 "issues", 17254 "issue_comment", 17255 "commit_comment", 17256 "pull_request", 17257 "pull_request_review_comment", 17258 "gollum", 17259 "watch", 17260 "download", 17261 "fork", 17262 "fork_apply", 17263 "member", 17264 "public", 17265 "team_add", 17266 "status" 17267 ] 17268 } 17269 ], 17270 "type": "array", 17271 "add_events": [ 17272 { 17273 "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", 17274 "enum": [ 17275 "push", 17276 "issues", 17277 "issue_comment", 17278 "commit_comment", 17279 "pull_request", 17280 "pull_request_review_comment", 17281 "gollum", 17282 "watch", 17283 "download", 17284 "fork", 17285 "fork_apply", 17286 "member", 17287 "public", 17288 "team_add", 17289 "status" 17290 ] 17291 } 17292 ], 17293 "type": "array", 17294 "remove_events": [ 17295 { 17296 "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", 17297 "enum": [ 17298 "push", 17299 "issues", 17300 "issue_comment", 17301 "commit_comment", 17302 "pull_request", 17303 "pull_request_review_comment", 17304 "gollum", 17305 "watch", 17306 "download", 17307 "fork", 17308 "fork_apply", 17309 "member", 17310 "public", 17311 "team_add", 17312 "status" 17313 ] 17314 } 17315 ], 17316 "type": "array", 17317 "active": { 17318 "description": "Determines whether the hook is actually triggered on pushes.", 17319 "type": "boolean" 17320 } 17321 } 17322 } 17323 responses: 17324 200: 17325 body: 17326 schema: | 17327 { 17328 "$schema": "http://json-schema.org/draft-03/schema", 17329 "type": "object", 17330 "properties": { 17331 "url": { 17332 "type": "string" 17333 }, 17334 "updated_at": { 17335 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 17336 "type": "string" 17337 }, 17338 "created_at": { 17339 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 17340 "type": "string" 17341 }, 17342 "name": { 17343 "type": "string" 17344 }, 17345 "events": [ 17346 { 17347 "enum": [ 17348 "push", 17349 "issues", 17350 "issue_comment", 17351 "commit_comment", 17352 "pull_request", 17353 "pull_request_review_comment", 17354 "gollum", 17355 "watch", 17356 "download", 17357 "fork", 17358 "fork_apply", 17359 "member", 17360 "public", 17361 "team_add", 17362 "status" 17363 ] 17364 } 17365 ], 17366 "type": "array", 17367 "active": { 17368 "type": "boolean" 17369 }, 17370 "config": { 17371 "properties": { 17372 "url": { 17373 "type": "string" 17374 }, 17375 "content_type": { 17376 "type": "string" 17377 } 17378 }, 17379 "type": "object" 17380 }, 17381 "id": { 17382 "type": "integer" 17383 } 17384 } 17385 } 17386 example: | 17387 [ 17388 { 17389 "url": "https://api.github.com/repos/octocat/Hello-World/hooks/1", 17390 "updated_at": "2011-09-06T20:39:23Z", 17391 "created_at": "2011-09-06T17:26:27Z", 17392 "name": "web", 17393 "events": [ 17394 "push", 17395 "pull_request" 17396 ], 17397 "active": true, 17398 "config": { 17399 "url": "http://example.com", 17400 "content_type": "json" 17401 }, 17402 "id": 1 17403 } 17404 ] 17405 delete: 17406 description: Delete a hook. 17407 /tests: 17408 type: base 17409 post: 17410 description: | 17411 Test a push hook. 17412 This will trigger the hook with the latest push to the current repository 17413 if the hook is subscribed to push events. If the hook is not subscribed 17414 to push events, the server will respond with 204 but no test POST will 17415 be generated. 17416 Note: Previously /repos/:owner/:repo/hooks/:id/test 17417 responses: 17418 204: 17419 description: Hook is triggered. 17420 /merges: 17421 type: base 17422 post: 17423 description: Perform a merge. 17424 body: 17425 application/json: 17426 schema: | 17427 { 17428 "$schema": "http://json-schema.org/draft-03/schema", 17429 "type": "object", 17430 "properties": { 17431 "base": { 17432 "description": "The name of the base branch that the head will be merged into.", 17433 "type": "string" 17434 }, 17435 "head": { 17436 "description": "The head to merge. This can be a branch name or a commit SHA1.", 17437 "type": "string" 17438 }, 17439 "commit_message": { 17440 "description": "Commit message to use for the merge commit. If omitted, a default message will be used.", 17441 "type": "string" 17442 } 17443 }, 17444 "required": [ "base", "head" ] 17445 } 17446 responses: 17447 201: 17448 description: Successful Response (The resulting merge commit) 17449 body: 17450 application/json: 17451 schema: | 17452 { 17453 "$schema": "http://json-schema.org/draft-03/schema", 17454 "type": "object", 17455 "properties": { 17456 "sha": { 17457 "type": "string" 17458 }, 17459 "commit": { 17460 "properties": { 17461 "author": { 17462 "properties": { 17463 "name": { 17464 "type": "string" 17465 }, 17466 "date": { 17467 "type": "string" 17468 }, 17469 "email": { 17470 "type": "string" 17471 } 17472 }, 17473 "type": "object" 17474 }, 17475 "committer": { 17476 "properties": { 17477 "name": { 17478 "type": "string" 17479 }, 17480 "date": { 17481 "type": "string" 17482 }, 17483 "email": { 17484 "type": "string" 17485 } 17486 }, 17487 "type": "object" 17488 }, 17489 "message": { 17490 "type": "string" 17491 }, 17492 "tree": { 17493 "properties": { 17494 "sha": { 17495 "type": "string" 17496 }, 17497 "url": { 17498 "type": "string" 17499 } 17500 }, 17501 "type": "object" 17502 }, 17503 "url": { 17504 "type": "string" 17505 }, 17506 "comment_count": { 17507 "type": "integer" 17508 } 17509 }, 17510 "type": "object" 17511 }, 17512 "url": { 17513 "type": "string" 17514 }, 17515 "comments_url": { 17516 "type": "string" 17517 }, 17518 "author": { 17519 "properties": { 17520 "login": { 17521 "type": "string" 17522 }, 17523 "id": { 17524 "type": "integer" 17525 }, 17526 "avatar_url": { 17527 "type": "string" 17528 }, 17529 "gravatar_id": { 17530 "type": "string" 17531 }, 17532 "url": { 17533 "type": "string" 17534 }, 17535 "html_url": { 17536 "type": "string" 17537 }, 17538 "followers_url": { 17539 "type": "string" 17540 }, 17541 "following_url": { 17542 "type": "string" 17543 }, 17544 "gists_url": { 17545 "type": "string" 17546 }, 17547 "starred_url": { 17548 "type": "string" 17549 }, 17550 "subscriptions_url": { 17551 "type": "string" 17552 }, 17553 "organizations_url": { 17554 "type": "string" 17555 }, 17556 "repos_url": { 17557 "type": "string" 17558 }, 17559 "events_url": { 17560 "type": "string" 17561 }, 17562 "received_events_url": { 17563 "type": "string" 17564 }, 17565 "type": { 17566 "type": "string" 17567 } 17568 }, 17569 "type": "object" 17570 }, 17571 "committer": { 17572 "properties": { 17573 "login": { 17574 "type": "string" 17575 }, 17576 "id": { 17577 "type": "integer" 17578 }, 17579 "avatar_url": { 17580 "type": "string" 17581 }, 17582 "gravatar_id": { 17583 "type": "string" 17584 }, 17585 "url": { 17586 "type": "string" 17587 }, 17588 "html_url": { 17589 "type": "string" 17590 }, 17591 "followers_url": { 17592 "type": "string" 17593 }, 17594 "following_url": { 17595 "type": "string" 17596 }, 17597 "gists_url": { 17598 "type": "string" 17599 }, 17600 "starred_url": { 17601 "type": "string" 17602 }, 17603 "subscriptions_url": { 17604 "type": "string" 17605 }, 17606 "organizations_url": { 17607 "type": "string" 17608 }, 17609 "repos_url": { 17610 "type": "string" 17611 }, 17612 "events_url": { 17613 "type": "string" 17614 }, 17615 "received_events_url": { 17616 "type": "string" 17617 }, 17618 "type": { 17619 "type": "string" 17620 } 17621 }, 17622 "type": "object" 17623 }, 17624 "parents": [ 17625 { 17626 "properties": { 17627 "sha": { 17628 "type": "string" 17629 }, 17630 "url": { 17631 "type": "string" 17632 } 17633 }, 17634 "type": "object" 17635 } 17636 ], 17637 "type": "array" 17638 } 17639 } 17640 example: | 17641 { 17642 "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", 17643 "merged": true, 17644 "message": "Pull Request successfully merged" 17645 } 17646 204: 17647 description: No-op response (base already contains the head, nothing to merge) 17648 409: 17649 description: Merge conflict response. 17650 body: 17651 application/json: 17652 schema: | 17653 { 17654 "$schema": "http://json-schema.org/draft-03/schema", 17655 "type": "object", 17656 "properties": { 17657 "message": { 17658 "description": "Error message", 17659 "type": "string" 17660 } 17661 } 17662 } 17663 example: | 17664 { 17665 "message": "Merge Conflict" 17666 } 17667 404: 17668 description: Missing base response or missing head response 17669 body: 17670 application/json: 17671 schema: | 17672 { 17673 "$schema": "http://json-schema.org/draft-03/schema", 17674 "type": "object", 17675 "properties": { 17676 "message": { 17677 "description": "Error message", 17678 "type": "string" 17679 } 17680 } 17681 } 17682 example: | 17683 { 17684 "message": "Base does not exist" 17685 } 17686 /statuses/{ref}: 17687 type: collection 17688 uriParameters: 17689 ref: 17690 description: | 17691 Ref to list the statuses from. It can be a SHA, a branch name, or a tag name. 17692 type: string 17693 get: 17694 description: List Statuses for a specific Ref. 17695 responses: 17696 200: 17697 body: 17698 schema: | 17699 { 17700 "$schema": "http://json-schema.org/draft-03/schema", 17701 "type": "array", 17702 "list": [ 17703 { 17704 "properties": { 17705 "created_at": { 17706 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 17707 "type": "string" 17708 }, 17709 "updated_at": { 17710 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 17711 "type": "string" 17712 }, 17713 "state": { 17714 "type": "string" 17715 }, 17716 "target_url": { 17717 "type": "string" 17718 }, 17719 "description": { 17720 "type": "string" 17721 }, 17722 "id": { 17723 "type": "integer" 17724 }, 17725 "url": { 17726 "type": "string" 17727 }, 17728 "creator": { 17729 "properties": { 17730 "login": { 17731 "type": "string" 17732 }, 17733 "id": { 17734 "type": "integer" 17735 }, 17736 "avatar_url": { 17737 "type": "string" 17738 }, 17739 "gravatar_id": { 17740 "type": "string" 17741 }, 17742 "url": { 17743 "type": "string" 17744 } 17745 }, 17746 "type": "object" 17747 } 17748 }, 17749 "type": "object" 17750 } 17751 ] 17752 } 17753 example: | 17754 [ 17755 { 17756 "created_at": "2012-07-20T01:19:13Z", 17757 "updated_at": "2012-07-20T01:19:13Z", 17758 "state": "success", 17759 "target_url": "https://ci.example.com/1000/output", 17760 "description": "Build has completed successfully", 17761 "id": 1, 17762 "url": "https://api.github.com/repos/octocat/example/statuses/1", 17763 "creator": { 17764 "login": "octocat", 17765 "id": 1, 17766 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 17767 "gravatar_id": "somehexcode", 17768 "url": "https://api.github.com/users/octocat" 17769 } 17770 } 17771 ] 17772 post: 17773 description: Create a Status. 17774 body: 17775 application/json: 17776 schema: | 17777 { 17778 "$schema": "http://json-schema.org/draft-03/schema", 17779 "type": "object", 17780 "properties": { 17781 "state": { 17782 "enum": [ 17783 "pending", "success", "error", "failure" 17784 ] 17785 }, 17786 "target_url": { 17787 "description": "Target url to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the ?source' of the Status.", 17788 "type": "string" 17789 }, 17790 "description": { 17791 "description": "Short description of the status", 17792 "type": "string" 17793 } 17794 } 17795 } 17796 responses: 17797 201: 17798 body: 17799 schema: | 17800 { 17801 "$schema": "http://json-schema.org/draft-03/schema", 17802 "type": "array", 17803 "list": [ 17804 { 17805 "properties": { 17806 "created_at": { 17807 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 17808 "type": "string" 17809 }, 17810 "updated_at": { 17811 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 17812 "type": "string" 17813 }, 17814 "state": { 17815 "type": "string" 17816 }, 17817 "target_url": { 17818 "type": "string" 17819 }, 17820 "description": { 17821 "type": "string" 17822 }, 17823 "id": { 17824 "type": "integer" 17825 }, 17826 "url": { 17827 "type": "string" 17828 }, 17829 "creator": { 17830 "properties": { 17831 "login": { 17832 "type": "string" 17833 }, 17834 "id": { 17835 "type": "integer" 17836 }, 17837 "avatar_url": { 17838 "type": "string" 17839 }, 17840 "gravatar_id": { 17841 "type": "string" 17842 }, 17843 "url": { 17844 "type": "string" 17845 } 17846 }, 17847 "type": "object" 17848 } 17849 }, 17850 "type": "object" 17851 } 17852 ] 17853 } 17854 example: | 17855 [ 17856 { 17857 "created_at": "2012-07-20T01:19:13Z", 17858 "updated_at": "2012-07-20T01:19:13Z", 17859 "state": "success", 17860 "target_url": "https://ci.example.com/1000/output", 17861 "description": "Build has completed successfully", 17862 "id": 1, 17863 "url": "https://api.github.com/repos/octocat/example/statuses/1", 17864 "creator": { 17865 "login": "octocat", 17866 "id": 1, 17867 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 17868 "gravatar_id": "somehexcode", 17869 "url": "https://api.github.com/users/octocat" 17870 } 17871 } 17872 ] 17873 /stats: 17874 /contributors: 17875 type: collection 17876 get: 17877 description: Get contributors list with additions, deletions, and commit counts. 17878 responses: 17879 200: 17880 body: 17881 schema: | 17882 { 17883 "$schema": "http://json-schema.org/draft-03/schema", 17884 "type": "array", 17885 "list": [ 17886 { 17887 "author": { 17888 "login": { 17889 "type": "string" 17890 }, 17891 "id": { 17892 "type": "integer" 17893 }, 17894 "avatar_url": { 17895 "type": "string" 17896 }, 17897 "gravatar_id": { 17898 "type": "string" 17899 }, 17900 "url": { 17901 "type": "string" 17902 } 17903 }, 17904 "total": { 17905 "description": "The Total number of commits authored by the contributor.", 17906 "type": "integer" 17907 }, 17908 "weeks": [ 17909 { 17910 "properties": { 17911 "w": { 17912 "description": "Start of the week.", 17913 "type": "string" 17914 }, 17915 "a": { 17916 "description": "Number of additions.", 17917 "type": "integer" 17918 }, 17919 "d": { 17920 "description": "Number of deletions.", 17921 "type": "integer" 17922 }, 17923 "c": { 17924 "description": "Number of commits.", 17925 "type": "integer" 17926 } 17927 }, 17928 "type": "object" 17929 } 17930 ], 17931 "type": "array" 17932 } 17933 ] 17934 } 17935 example: | 17936 [ 17937 { 17938 "author": { 17939 "login": "octocat", 17940 "id": 1, 17941 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 17942 "gravatar_id": "somehexcode", 17943 "url": "https://api.github.com/users/octocat" 17944 }, 17945 "total": 135, 17946 "weeks": [ 17947 { 17948 "w": "1367712000", 17949 "a": 6898, 17950 "d": 77, 17951 "c": 10 17952 } 17953 ] 17954 } 17955 ] 17956 /commit_activity: 17957 type: collection 17958 get: 17959 description: | 17960 Get the last year of commit activity data. 17961 Returns the last year of commit activity grouped by week. The days array 17962 is a group of commits per day, starting on Sunday. 17963 responses: 17964 200: 17965 body: 17966 schema: | 17967 { 17968 "$schema": "http://json-schema.org/draft-03/schema", 17969 "type": "array", 17970 "list": [ 17971 { 17972 "properties": { 17973 "days": [ 17974 { 17975 "type": "integer" 17976 } 17977 ], 17978 "type": "array", 17979 "total": { 17980 "type": "integer" 17981 }, 17982 "week": { 17983 "type": "integer" 17984 } 17985 }, 17986 "type": "object" 17987 } 17988 ] 17989 } 17990 example: | 17991 [ 17992 { 17993 "days": [ 17994 0, 17995 3, 17996 26, 17997 20, 17998 39, 17999 1, 18000 0 18001 ], 18002 "total": 89, 18003 "week": 1336280400 18004 } 18005 ] 18006 /code_frequency: 18007 type: collection 18008 get: 18009 description: | 18010 Get the number of additions and deletions per week. 18011 Returns a weekly aggregate of the number of additions and deletions pushed 18012 to a repository. 18013 responses: 18014 200: 18015 body: 18016 schema: | 18017 { 18018 "$schema": "http://json-schema.org/draft-03/schema", 18019 "type": "array", 18020 "list": [ 18021 { 18022 "type": "integer" 18023 } 18024 ] 18025 } 18026 example: | 18027 [ 18028 [ 18029 1302998400, 18030 1124, 18031 -435 18032 ] 18033 ] 18034 /participation: 18035 type: collection 18036 get: 18037 description: Get the weekly commit count for the repo owner and everyone else. 18038 responses: 18039 200: 18040 body: 18041 schema: | 18042 { 18043 "$schema": "http://json-schema.org/draft-03/schema", 18044 "type": "object", 18045 "properties": { 18046 "all": [ 18047 { 18048 "type": "integer" 18049 } 18050 ], 18051 "type": "array", 18052 "owner": [ 18053 { 18054 "type": "integer" 18055 } 18056 ], 18057 "type": "array" 18058 } 18059 } 18060 example: | 18061 { 18062 "all": [ 18063 11, 18064 21, 18065 15, 18066 2, 18067 8, 18068 1, 18069 8, 18070 23, 18071 17, 18072 21, 18073 11, 18074 10, 18075 33, 18076 91, 18077 38, 18078 34, 18079 22, 18080 23, 18081 32, 18082 3, 18083 43, 18084 87, 18085 71, 18086 18, 18087 13, 18088 5, 18089 13, 18090 16, 18091 66, 18092 27, 18093 12, 18094 45, 18095 110, 18096 117, 18097 13, 18098 8, 18099 18, 18100 9, 18101 19, 18102 26, 18103 39, 18104 12, 18105 20, 18106 31, 18107 46, 18108 91, 18109 45, 18110 10, 18111 24, 18112 9, 18113 29, 18114 7 18115 ], 18116 "owner": [ 18117 3, 18118 2, 18119 3, 18120 0, 18121 2, 18122 0, 18123 5, 18124 14, 18125 7, 18126 9, 18127 1, 18128 5, 18129 0, 18130 48, 18131 19, 18132 2, 18133 0, 18134 1, 18135 10, 18136 2, 18137 23, 18138 40, 18139 35, 18140 8, 18141 8, 18142 2, 18143 10, 18144 6, 18145 30, 18146 0, 18147 2, 18148 9, 18149 53, 18150 104, 18151 3, 18152 3, 18153 10, 18154 4, 18155 7, 18156 11, 18157 21, 18158 4, 18159 4, 18160 22, 18161 26, 18162 63, 18163 11, 18164 2, 18165 14, 18166 1, 18167 10, 18168 3 18169 ] 18170 } 18171 /punch_card: 18172 type: collection 18173 get: 18174 description: | 18175 Get the number of commits per hour in each day. 18176 Each array contains the day number, hour number, and number of commits 18177 0-6 Sunday - Saturday 18178 0-23 Hour of day 18179 Number of commits 18180 18181 For example, [2, 14, 25] indicates that there were 25 total commits, during 18182 the 2.00pm hour on Tuesdays. All times are based on the time zone of 18183 individual commits. 18184 responses: 18185 200: 18186 body: 18187 schema: | 18188 { 18189 "$schema": "http://json-schema.org/draft-03/schema", 18190 "type": "array", 18191 "list": [ 18192 { 18193 "": [ 18194 { 18195 "type": "integer" 18196 } 18197 ] 18198 } 18199 ] 18200 } 18201 example: | 18202 [ 18203 [ 18204 0, 18205 0, 18206 5 18207 ], 18208 [ 18209 0, 18210 1, 18211 43 18212 ], 18213 [ 18214 0, 18215 2, 18216 21 18217 ] 18218 ] 18219/user: 18220 type: item 18221 get: 18222 description: Get the authenticated user. 18223 responses: 18224 200: 18225 body: 18226 schema: | 18227 { 18228 "$schema": "http://json-schema.org/draft-03/schema", 18229 "type": "object", 18230 "properties": { 18231 "login": { 18232 "type": "string" 18233 }, 18234 "id": { 18235 "type": "integer" 18236 }, 18237 "avatar_url": { 18238 "type": "string" 18239 }, 18240 "gravatar_id": { 18241 "type": "string" 18242 }, 18243 "url": { 18244 "type": "string" 18245 }, 18246 "name": { 18247 "type": "string" 18248 }, 18249 "company": { 18250 "type": "string" 18251 }, 18252 "blog": { 18253 "type": "string" 18254 }, 18255 "location": { 18256 "type": "string" 18257 }, 18258 "email": { 18259 "type": "string" 18260 }, 18261 "hireable": { 18262 "type": "boolean" 18263 }, 18264 "bio": { 18265 "type": "string" 18266 }, 18267 "public_repos": { 18268 "type": "integer" 18269 }, 18270 "public_gists": { 18271 "type": "integer" 18272 }, 18273 "followers": { 18274 "type": "integer" 18275 }, 18276 "following": { 18277 "type": "integer" 18278 }, 18279 "html_url": { 18280 "type": "string" 18281 }, 18282 "created_at": { 18283 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 18284 "type": "string" 18285 }, 18286 "type": { 18287 "type": "string" 18288 }, 18289 "total_private_repos": { 18290 "type": "integer" 18291 }, 18292 "owned_private_repos": { 18293 "type": "integer" 18294 }, 18295 "private_gists": { 18296 "type": "integer" 18297 }, 18298 "disk_usage": { 18299 "type": "integer" 18300 }, 18301 "collaborators": { 18302 "type": "integer" 18303 }, 18304 "plan": { 18305 "properties": { 18306 "name": { 18307 "type": "string" 18308 }, 18309 "space": { 18310 "type": "integer" 18311 }, 18312 "collaborators": { 18313 "type": "integer" 18314 }, 18315 "private_repos": { 18316 "type": "integer" 18317 } 18318 }, 18319 "type": "object" 18320 } 18321 } 18322 } 18323 example: | 18324 { 18325 "login": "octocat", 18326 "id": 1, 18327 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 18328 "gravatar_id": "somehexcode", 18329 "url": "https://api.github.com/users/octocat", 18330 "name": "monalisa octocat", 18331 "company": "GitHub", 18332 "blog": "https://github.com/blog", 18333 "location": "San Francisco", 18334 "email": "octocat@github.com", 18335 "hireable": false, 18336 "bio": "There once was...", 18337 "public_repos": 2, 18338 "public_gists": 1, 18339 "followers": 20, 18340 "following": 0, 18341 "html_url": "https://github.com/octocat", 18342 "created_at": "2008-01-14T04:33:35Z", 18343 "type": "User", 18344 "total_private_repos": 100, 18345 "owned_private_repos": 100, 18346 "private_gists": 81, 18347 "disk_usage": 10000, 18348 "collaborators": 8, 18349 "plan": { 18350 "name": "Medium", 18351 "space": 400, 18352 "collaborators": 10, 18353 "private_repos": 20 18354 } 18355 } 18356 patch: 18357 description: Update the authenticated user. 18358 body: 18359 application/json: 18360 schema: | 18361 { 18362 "$schema": "http://json-schema.org/draft-03/schema", 18363 "type": "object", 18364 "properties": { 18365 "name": { 18366 "type": "string" 18367 }, 18368 "email": { 18369 "type": "string" 18370 }, 18371 "blog": { 18372 "type": "string" 18373 }, 18374 "company": { 18375 "type": "string" 18376 }, 18377 "location": { 18378 "type": "string" 18379 }, 18380 "hireable": { 18381 "type": "boolean" 18382 }, 18383 "bio": { 18384 "type": "string" 18385 } 18386 } 18387 } 18388 responses: 18389 200: 18390 body: 18391 schema: | 18392 { 18393 "$schema": "http://json-schema.org/draft-03/schema", 18394 "type": "object", 18395 "properties": { 18396 "login": { 18397 "type": "string" 18398 }, 18399 "id": { 18400 "type": "integer" 18401 }, 18402 "avatar_url": { 18403 "type": "string" 18404 }, 18405 "gravatar_id": { 18406 "type": "string" 18407 }, 18408 "url": { 18409 "type": "string" 18410 }, 18411 "name": { 18412 "type": "string" 18413 }, 18414 "company": { 18415 "type": "string" 18416 }, 18417 "blog": { 18418 "type": "string" 18419 }, 18420 "location": { 18421 "type": "string" 18422 }, 18423 "email": { 18424 "type": "string" 18425 }, 18426 "hireable": { 18427 "type": "boolean" 18428 }, 18429 "bio": { 18430 "type": "string" 18431 }, 18432 "public_repos": { 18433 "type": "integer" 18434 }, 18435 "public_gists": { 18436 "type": "integer" 18437 }, 18438 "followers": { 18439 "type": "integer" 18440 }, 18441 "following": { 18442 "type": "integer" 18443 }, 18444 "html_url": { 18445 "type": "string" 18446 }, 18447 "created_at": { 18448 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 18449 "type": "string" 18450 }, 18451 "type": { 18452 "type": "string" 18453 }, 18454 "total_private_repos": { 18455 "type": "integer" 18456 }, 18457 "owned_private_repos": { 18458 "type": "integer" 18459 }, 18460 "private_gists": { 18461 "type": "integer" 18462 }, 18463 "disk_usage": { 18464 "type": "integer" 18465 }, 18466 "collaborators": { 18467 "type": "integer" 18468 }, 18469 "plan": { 18470 "properties": { 18471 "name": { 18472 "type": "string" 18473 }, 18474 "space": { 18475 "type": "integer" 18476 }, 18477 "collaborators": { 18478 "type": "integer" 18479 }, 18480 "private_repos": { 18481 "type": "integer" 18482 } 18483 }, 18484 "type": "object" 18485 } 18486 } 18487 } 18488 example: | 18489 { 18490 "login": "octocat", 18491 "id": 1, 18492 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 18493 "gravatar_id": "somehexcode", 18494 "url": "https://api.github.com/users/octocat", 18495 "name": "monalisa octocat", 18496 "company": "GitHub", 18497 "blog": "https://github.com/blog", 18498 "location": "San Francisco", 18499 "email": "octocat@github.com", 18500 "hireable": false, 18501 "bio": "There once was...", 18502 "public_repos": 2, 18503 "public_gists": 1, 18504 "followers": 20, 18505 "following": 0, 18506 "html_url": "https://github.com/octocat", 18507 "created_at": "2008-01-14T04:33:35Z", 18508 "type": "User", 18509 "total_private_repos": 100, 18510 "owned_private_repos": 100, 18511 "private_gists": 81, 18512 "disk_usage": 10000, 18513 "collaborators": 8, 18514 "plan": { 18515 "name": "Medium", 18516 "space": 400, 18517 "collaborators": 10, 18518 "private_repos": 20 18519 } 18520 } 18521 /orgs: 18522 type: collection 18523 get: 18524 description: List public and private organizations for the authenticated user. 18525 responses: 18526 200: 18527 body: 18528 schema: | 18529 { 18530 "$schema": "http://json-schema.org/draft-03/schema", 18531 "type": "array", 18532 "": [ 18533 { 18534 "login": { 18535 "type": "string" 18536 }, 18537 "id": { 18538 "type": "integer" 18539 }, 18540 "url": { 18541 "type": "string" 18542 }, 18543 "avatar_url": { 18544 "type": "string" 18545 } 18546 } 18547 ] 18548 } 18549 example: | 18550 [ 18551 { 18552 "login": "github", 18553 "id": 1, 18554 "url": "https://api.github.com/orgs/github", 18555 "avatar_url": "https://github.com/images/error/octocat_happy.gif" 18556 } 18557 ] 18558 # Other 18559 /{userId}: 18560 type: collection 18561 uriParameters: 18562 userId: 18563 type: integer 18564 get: 18565 securedBy: [ oauth_2_0, null ] 18566 description: Get a single user. 18567 responses: 18568 200: 18569 body: 18570 schema: | 18571 { 18572 "$schema": "http://json-schema.org/draft-03/schema", 18573 "type": "object", 18574 "properties": { 18575 "login": { 18576 "type": "string" 18577 }, 18578 "id": { 18579 "type": "integer" 18580 }, 18581 "avatar_url": { 18582 "type": "string" 18583 }, 18584 "gravatar_id": { 18585 "type": "string" 18586 }, 18587 "url": { 18588 "type": "string" 18589 }, 18590 "name": { 18591 "type": "string" 18592 }, 18593 "company": { 18594 "type": "string" 18595 }, 18596 "blog": { 18597 "type": "string" 18598 }, 18599 "location": { 18600 "type": "string" 18601 }, 18602 "email": { 18603 "description": "Note: The returned email is the user's publicly visible email address (or null if the user has not specified a public email address in their profile).", 18604 "type": "string" 18605 }, 18606 "hireable": { 18607 "type": "boolean" 18608 }, 18609 "bio": { 18610 "type": "string" 18611 }, 18612 "public_repos": { 18613 "type": "integer" 18614 }, 18615 "public_gists": { 18616 "type": "integer" 18617 }, 18618 "followers": { 18619 "type": "integer" 18620 }, 18621 "following": { 18622 "type": "integer" 18623 }, 18624 "html_url": { 18625 "type": "string" 18626 }, 18627 "created_at": { 18628 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 18629 "type": "string" 18630 }, 18631 "type": { 18632 "type": "string" 18633 } 18634 } 18635 } 18636 example: | 18637 { 18638 "login": "octocat", 18639 "id": 1, 18640 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 18641 "gravatar_id": "somehexcode", 18642 "url": "https://api.github.com/users/octocat", 18643 "name": "monalisa octocat", 18644 "company": "GitHub", 18645 "blog": "https://github.com/blog", 18646 "location": "San Francisco", 18647 "email": "octocat@github.com", 18648 "hireable": false, 18649 "bio": "There once was...", 18650 "public_repos": 2, 18651 "public_gists": 1, 18652 "followers": 20, 18653 "following": 0, 18654 "html_url": "https://github.com/octocat", 18655 "created_at": "2008-01-14T04:33:35Z", 18656 "type": "User" 18657 } 18658 # Received events 18659 /received_events: 18660 type: collection 18661 get: 18662 description: List events that a user has received. 18663 responses: 18664 200: 18665 body: 18666 schema: | 18667 { 18668 "$schema": "http://json-schema.org/draft-03/schema", 18669 "type": "array", 18670 "properties": [ 18671 { 18672 "properties": { 18673 "type": { 18674 "type": "string" 18675 }, 18676 "public": { 18677 "type": "boolean" 18678 }, 18679 "payload": { 18680 "properties": {}, 18681 "type": "object" 18682 }, 18683 "repo": { 18684 "properties": { 18685 "id": { 18686 "type": "integer" 18687 }, 18688 "name": { 18689 "type": "string" 18690 }, 18691 "url": { 18692 "type": "string" 18693 } 18694 }, 18695 "type": "object" 18696 }, 18697 "actor": { 18698 "properties": { 18699 "login": { 18700 "type": "string" 18701 }, 18702 "id": { 18703 "type": "integer" 18704 }, 18705 "avatar_url": { 18706 "type": "string" 18707 }, 18708 "gravatar_id": { 18709 "type": "string" 18710 }, 18711 "url": { 18712 "type": "string" 18713 } 18714 }, 18715 "type": "object" 18716 }, 18717 "org": { 18718 "properties": { 18719 "login": { 18720 "type": "string" 18721 }, 18722 "id": { 18723 "type": "integer" 18724 }, 18725 "avatar_url": { 18726 "type": "string" 18727 }, 18728 "gravatar_id": { 18729 "type": "string" 18730 }, 18731 "url": { 18732 "type": "string" 18733 } 18734 }, 18735 "type": "object" 18736 }, 18737 "created_at": { 18738 "type": "timestamp" 18739 }, 18740 "id": { 18741 "type": "integer" 18742 } 18743 }, 18744 "type": "object" 18745 } 18746 ] 18747 } 18748 example: | 18749 [ 18750 { 18751 "type": "Event", 18752 "public": true, 18753 "payload": { 18754 18755 }, 18756 "repo": { 18757 "id": 3, 18758 "name": "octocat/Hello-World", 18759 "url": "https://api.github.com/repos/octocat/Hello-World" 18760 }, 18761 "actor": { 18762 "login": "octocat", 18763 "id": 1, 18764 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 18765 "gravatar_id": "somehexcode", 18766 "url": "https://api.github.com/users/octocat" 18767 }, 18768 "org": { 18769 "login": "octocat", 18770 "id": 1, 18771 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 18772 "gravatar_id": "somehexcode", 18773 "url": "https://api.github.com/users/octocat" 18774 }, 18775 "created_at": "2011-09-06T17:26:27Z", 18776 "id": "12345" 18777 } 18778 ] 18779 /public: 18780 type: collection 18781 get: 18782 description: List public events that a user has received. 18783 responses: 18784 200: 18785 body: 18786 schema: | 18787 { 18788 "$schema": "http://json-schema.org/draft-03/schema", 18789 "type": "array", 18790 "properties": [ 18791 { 18792 "properties": { 18793 "type": { 18794 "type": "string" 18795 }, 18796 "public": { 18797 "type": "boolean" 18798 }, 18799 "payload": { 18800 "properties": {}, 18801 "type": "object" 18802 }, 18803 "repo": { 18804 "properties": { 18805 "id": { 18806 "type": "integer" 18807 }, 18808 "name": { 18809 "type": "string" 18810 }, 18811 "url": { 18812 "type": "string" 18813 } 18814 }, 18815 "type": "object" 18816 }, 18817 "actor": { 18818 "properties": { 18819 "login": { 18820 "type": "string" 18821 }, 18822 "id": { 18823 "type": "integer" 18824 }, 18825 "avatar_url": { 18826 "type": "string" 18827 }, 18828 "gravatar_id": { 18829 "type": "string" 18830 }, 18831 "url": { 18832 "type": "string" 18833 } 18834 }, 18835 "type": "object" 18836 }, 18837 "org": { 18838 "properties": { 18839 "login": { 18840 "type": "string" 18841 }, 18842 "id": { 18843 "type": "integer" 18844 }, 18845 "avatar_url": { 18846 "type": "string" 18847 }, 18848 "gravatar_id": { 18849 "type": "string" 18850 }, 18851 "url": { 18852 "type": "string" 18853 } 18854 }, 18855 "type": "object" 18856 }, 18857 "created_at": { 18858 "type": "timestamp" 18859 }, 18860 "id": { 18861 "type": "integer" 18862 } 18863 }, 18864 "type": "object" 18865 } 18866 ] 18867 } 18868 example: | 18869 [ 18870 { 18871 "type": "Event", 18872 "public": true, 18873 "payload": { 18874 18875 }, 18876 "repo": { 18877 "id": 3, 18878 "name": "octocat/Hello-World", 18879 "url": "https://api.github.com/repos/octocat/Hello-World" 18880 }, 18881 "actor": { 18882 "login": "octocat", 18883 "id": 1, 18884 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 18885 "gravatar_id": "somehexcode", 18886 "url": "https://api.github.com/users/octocat" 18887 }, 18888 "org": { 18889 "login": "octocat", 18890 "id": 1, 18891 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 18892 "gravatar_id": "somehexcode", 18893 "url": "https://api.github.com/users/octocat" 18894 }, 18895 "created_at": "2011-09-06T17:26:27Z", 18896 "id": "12345" 18897 } 18898 ] 18899 # Orgs 18900 /orgs: 18901 type: collection 18902 get: 18903 description: List all public organizations for a user. 18904 responses: 18905 200: 18906 body: 18907 schema: | 18908 { 18909 "$schema": "http://json-schema.org/draft-03/schema", 18910 "type": "array", 18911 "": [ 18912 { 18913 "login": { 18914 "type": "string" 18915 }, 18916 "id": { 18917 "type": "integer" 18918 }, 18919 "url": { 18920 "type": "string" 18921 }, 18922 "avatar_url": { 18923 "type": "string" 18924 } 18925 } 18926 ] 18927 } 18928 example: | 18929 [ 18930 { 18931 "login": "github", 18932 "id": 1, 18933 "url": "https://api.github.com/orgs/github", 18934 "avatar_url": "https://github.com/images/error/octocat_happy.gif" 18935 } 18936 ] 18937 /events: 18938 type: collection 18939 get: 18940 description: | 18941 List events performed by a user. 18942 If you are authenticated as the given user, you will see your private events. 18943 Otherwise, you'll only see public events. 18944 responses: 18945 200: 18946 body: 18947 schema: | 18948 { 18949 "$schema": "http://json-schema.org/draft-03/schema", 18950 "type": "array", 18951 "properties": [ 18952 { 18953 "properties": { 18954 "type": { 18955 "type": "string" 18956 }, 18957 "public": { 18958 "type": "boolean" 18959 }, 18960 "payload": { 18961 "properties": {}, 18962 "type": "object" 18963 }, 18964 "repo": { 18965 "properties": { 18966 "id": { 18967 "type": "integer" 18968 }, 18969 "name": { 18970 "type": "string" 18971 }, 18972 "url": { 18973 "type": "string" 18974 } 18975 }, 18976 "type": "object" 18977 }, 18978 "actor": { 18979 "properties": { 18980 "login": { 18981 "type": "string" 18982 }, 18983 "id": { 18984 "type": "integer" 18985 }, 18986 "avatar_url": { 18987 "type": "string" 18988 }, 18989 "gravatar_id": { 18990 "type": "string" 18991 }, 18992 "url": { 18993 "type": "string" 18994 } 18995 }, 18996 "type": "object" 18997 }, 18998 "org": { 18999 "properties": { 19000 "login": { 19001 "type": "string" 19002 }, 19003 "id": { 19004 "type": "integer" 19005 }, 19006 "avatar_url": { 19007 "type": "string" 19008 }, 19009 "gravatar_id": { 19010 "type": "string" 19011 }, 19012 "url": { 19013 "type": "string" 19014 } 19015 }, 19016 "type": "object" 19017 }, 19018 "created_at": { 19019 "type": "timestamp" 19020 }, 19021 "id": { 19022 "type": "integer" 19023 } 19024 }, 19025 "type": "object" 19026 } 19027 ] 19028 } 19029 example: | 19030 [ 19031 { 19032 "type": "Event", 19033 "public": true, 19034 "payload": { 19035 19036 }, 19037 "repo": { 19038 "id": 3, 19039 "name": "octocat/Hello-World", 19040 "url": "https://api.github.com/repos/octocat/Hello-World" 19041 }, 19042 "actor": { 19043 "login": "octocat", 19044 "id": 1, 19045 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 19046 "gravatar_id": "somehexcode", 19047 "url": "https://api.github.com/users/octocat" 19048 }, 19049 "org": { 19050 "login": "octocat", 19051 "id": 1, 19052 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 19053 "gravatar_id": "somehexcode", 19054 "url": "https://api.github.com/users/octocat" 19055 }, 19056 "created_at": "2011-09-06T17:26:27Z", 19057 "id": "12345" 19058 } 19059 ] 19060 # Public 19061 /public: 19062 type: collection 19063 get: 19064 description: List public events performed by a user. 19065 responses: 19066 200: 19067 body: 19068 schema: | 19069 { 19070 "$schema": "http://json-schema.org/draft-03/schema", 19071 "type": "array", 19072 "properties": [ 19073 { 19074 "properties": { 19075 "type": { 19076 "type": "string" 19077 }, 19078 "public": { 19079 "type": "boolean" 19080 }, 19081 "payload": { 19082 "properties": {}, 19083 "type": "object" 19084 }, 19085 "repo": { 19086 "properties": { 19087 "id": { 19088 "type": "integer" 19089 }, 19090 "name": { 19091 "type": "string" 19092 }, 19093 "url": { 19094 "type": "string" 19095 } 19096 }, 19097 "type": "object" 19098 }, 19099 "actor": { 19100 "properties": { 19101 "login": { 19102 "type": "string" 19103 }, 19104 "id": { 19105 "type": "integer" 19106 }, 19107 "avatar_url": { 19108 "type": "string" 19109 }, 19110 "gravatar_id": { 19111 "type": "string" 19112 }, 19113 "url": { 19114 "type": "string" 19115 } 19116 }, 19117 "type": "object" 19118 }, 19119 "org": { 19120 "properties": { 19121 "login": { 19122 "type": "string" 19123 }, 19124 "id": { 19125 "type": "integer" 19126 }, 19127 "avatar_url": { 19128 "type": "string" 19129 }, 19130 "gravatar_id": { 19131 "type": "string" 19132 }, 19133 "url": { 19134 "type": "string" 19135 } 19136 }, 19137 "type": "object" 19138 }, 19139 "created_at": { 19140 "type": "timestamp" 19141 }, 19142 "id": { 19143 "type": "integer" 19144 } 19145 }, 19146 "type": "object" 19147 } 19148 ] 19149 } 19150 example: | 19151 [ 19152 { 19153 "type": "Event", 19154 "public": true, 19155 "payload": { 19156 19157 }, 19158 "repo": { 19159 "id": 3, 19160 "name": "octocat/Hello-World", 19161 "url": "https://api.github.com/repos/octocat/Hello-World" 19162 }, 19163 "actor": { 19164 "login": "octocat", 19165 "id": 1, 19166 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 19167 "gravatar_id": "somehexcode", 19168 "url": "https://api.github.com/users/octocat" 19169 }, 19170 "org": { 19171 "login": "octocat", 19172 "id": 1, 19173 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 19174 "gravatar_id": "somehexcode", 19175 "url": "https://api.github.com/users/octocat" 19176 }, 19177 "created_at": "2011-09-06T17:26:27Z", 19178 "id": "12345" 19179 } 19180 ] 19181 # Orgs events 19182 /orgs/{orgId}: 19183 uriParameters: 19184 orgId: 19185 type: integer 19186 type: collection 19187 get: 19188 description: List events for an organization. 19189 responses: 19190 200: 19191 body: 19192 schema: | 19193 { 19194 "$schema": "http://json-schema.org/draft-03/schema", 19195 "type": "array", 19196 "properties": [ 19197 { 19198 "properties": { 19199 "type": { 19200 "type": "string" 19201 }, 19202 "public": { 19203 "type": "boolean" 19204 }, 19205 "payload": { 19206 "properties": {}, 19207 "type": "object" 19208 }, 19209 "repo": { 19210 "properties": { 19211 "id": { 19212 "type": "integer" 19213 }, 19214 "name": { 19215 "type": "string" 19216 }, 19217 "url": { 19218 "type": "string" 19219 } 19220 }, 19221 "type": "object" 19222 }, 19223 "actor": { 19224 "properties": { 19225 "login": { 19226 "type": "string" 19227 }, 19228 "id": { 19229 "type": "integer" 19230 }, 19231 "avatar_url": { 19232 "type": "string" 19233 }, 19234 "gravatar_id": { 19235 "type": "string" 19236 }, 19237 "url": { 19238 "type": "string" 19239 } 19240 }, 19241 "type": "object" 19242 }, 19243 "org": { 19244 "properties": { 19245 "login": { 19246 "type": "string" 19247 }, 19248 "id": { 19249 "type": "integer" 19250 }, 19251 "avatar_url": { 19252 "type": "string" 19253 }, 19254 "gravatar_id": { 19255 "type": "string" 19256 }, 19257 "url": { 19258 "type": "string" 19259 } 19260 }, 19261 "type": "object" 19262 }, 19263 "created_at": { 19264 "type": "timestamp" 19265 }, 19266 "id": { 19267 "type": "integer" 19268 } 19269 }, 19270 "type": "object" 19271 } 19272 ] 19273 } 19274 example: | 19275 [ 19276 { 19277 "type": "Event", 19278 "public": true, 19279 "payload": { 19280 19281 }, 19282 "repo": { 19283 "id": 3, 19284 "name": "octocat/Hello-World", 19285 "url": "https://api.github.com/repos/octocat/Hello-World" 19286 }, 19287 "actor": { 19288 "login": "octocat", 19289 "id": 1, 19290 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 19291 "gravatar_id": "somehexcode", 19292 "url": "https://api.github.com/users/octocat" 19293 }, 19294 "org": { 19295 "login": "octocat", 19296 "id": 1, 19297 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 19298 "gravatar_id": "somehexcode", 19299 "url": "https://api.github.com/users/octocat" 19300 }, 19301 "created_at": "2011-09-06T17:26:27Z", 19302 "id": "12345" 19303 } 19304 ] 19305 /starred: 19306 type: collection 19307 get: 19308 description: List repositories being starred. 19309 queryParameters: 19310 sort: 19311 enum: 19312 - created 19313 - updated 19314 default: created 19315 direction: 19316 enum: 19317 - asc 19318 - desc 19319 default: desc 19320 responses: 19321 200: 19322 body: 19323 schema: | 19324 { 19325 "$schema": "http://json-schema.org/draft-03/schema", 19326 "type": "array", 19327 "": [ 19328 { 19329 "properties": { 19330 "id": { 19331 "type": "integer" 19332 }, 19333 "owner": { 19334 "properties": { 19335 "login": { 19336 "type": "string" 19337 }, 19338 "id": { 19339 "type": "integer" 19340 }, 19341 "avatar_url": { 19342 "type": "string" 19343 }, 19344 "gravatar_id": { 19345 "type": "string" 19346 }, 19347 "url": { 19348 "type": "string" 19349 } 19350 }, 19351 "type": "object" 19352 }, 19353 "name": { 19354 "type": "string" 19355 }, 19356 "full_name": { 19357 "type": "string" 19358 }, 19359 "description": { 19360 "type": "string" 19361 }, 19362 "private": { 19363 "type": "boolean" 19364 }, 19365 "fork": { 19366 "type": "boolean" 19367 }, 19368 "url": { 19369 "type": "string" 19370 }, 19371 "html_url": { 19372 "type": "string" 19373 }, 19374 "clone_url": { 19375 "type": "string" 19376 }, 19377 "ssh_url": { 19378 "type": "string" 19379 }, 19380 "svn_url": { 19381 "type": "string" 19382 }, 19383 "mirror_url": { 19384 "type": "string" 19385 }, 19386 "homepage": { 19387 "type": "string" 19388 }, 19389 "language": { 19390 "type": "string" 19391 }, 19392 "forks": { 19393 "type": "integer" 19394 }, 19395 "forks_count": { 19396 "type": "integer" 19397 }, 19398 "watchers": { 19399 "type": "integer" 19400 }, 19401 "watchers_count": { 19402 "type": "integer" 19403 }, 19404 "size": { 19405 "type": "integer" 19406 }, 19407 "master_branch": { 19408 "type": "string" 19409 }, 19410 "open_issues": { 19411 "type": "integer" 19412 }, 19413 "open_issues_count": { 19414 "type": "integer" 19415 }, 19416 "pushed_at": { 19417 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 19418 "type": "string" 19419 }, 19420 "created_at": { 19421 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 19422 "type": "string" 19423 }, 19424 "updated_at": { 19425 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 19426 "type": "string" 19427 } 19428 }, 19429 "type": "object" 19430 } 19431 ] 19432 } 19433 example: | 19434 [ 19435 { 19436 "id": 1296269, 19437 "owner": { 19438 "login": "octocat", 19439 "id": 1, 19440 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 19441 "gravatar_id": "somehexcode", 19442 "url": "https://api.github.com/users/octocat" 19443 }, 19444 "name": "Hello-World", 19445 "full_name": "octocat/Hello-World", 19446 "description": "This your first repo!", 19447 "private": false, 19448 "fork": false, 19449 "url": "https://api.github.com/repos/octocat/Hello-World", 19450 "html_url": "https://github.com/octocat/Hello-World", 19451 "clone_url": "https://github.com/octocat/Hello-World.git", 19452 "git_url": "git://github.com/octocat/Hello-World.git", 19453 "ssh_url": "git@github.com:octocat/Hello-World.git", 19454 "svn_url": "https://svn.github.com/octocat/Hello-World", 19455 "mirror_url": "git://git.example.com/octocat/Hello-World", 19456 "homepage": "https://github.com", 19457 "language": null, 19458 "forks": 9, 19459 "forks_count": 9, 19460 "watchers": 80, 19461 "watchers_count": 80, 19462 "size": 108, 19463 "master_branch": "master", 19464 "open_issues": 0, 19465 "open_issues_count": 0, 19466 "pushed_at": "2011-01-26T19:06:43Z", 19467 "created_at": "2011-01-26T19:01:12Z", 19468 "updated_at": "2011-01-26T19:14:43Z" 19469 } 19470 ] 19471 /subscriptions: 19472 type: collection 19473 get: 19474 description: List repositories being watched by a user. 19475 responses: 19476 200: 19477 body: 19478 schema: | 19479 { 19480 "$schema": "http://json-schema.org/draft-03/schema", 19481 "type": "array", 19482 "properties": [ 19483 { 19484 "properties": { 19485 "id": { 19486 "type": "integer" 19487 }, 19488 "owner": { 19489 "properties": { 19490 "login": { 19491 "type": "string" 19492 }, 19493 "id": { 19494 "type": "integer" 19495 }, 19496 "avatar_url": { 19497 "type": "string" 19498 }, 19499 "gravatar_id": { 19500 "type": "string" 19501 }, 19502 "url": { 19503 "type": "string" 19504 } 19505 }, 19506 "type": "object" 19507 }, 19508 "name": { 19509 "type": "string" 19510 }, 19511 "full_name": { 19512 "type": "string" 19513 }, 19514 "description": { 19515 "type": "string" 19516 }, 19517 "private": { 19518 "type": "boolean" 19519 }, 19520 "fork": { 19521 "type": "boolean" 19522 }, 19523 "url": { 19524 "type": "string" 19525 }, 19526 "html_url": { 19527 "type": "string" 19528 }, 19529 "clone_url": { 19530 "type": "string" 19531 }, 19532 "git_url": { 19533 "type": "string" 19534 }, 19535 "ssh_url": { 19536 "type": "string" 19537 }, 19538 "svn_url": { 19539 "type": "string" 19540 }, 19541 "mirror_url": { 19542 "type": "string" 19543 }, 19544 "homepage": { 19545 "type": "string" 19546 }, 19547 "language": { 19548 "type": "string" 19549 }, 19550 "forks": { 19551 "type": "integer" 19552 }, 19553 "forks_count": { 19554 "type": "integer" 19555 }, 19556 "watchers": { 19557 "type": "integer" 19558 }, 19559 "watchers_count": { 19560 "type": "integer" 19561 }, 19562 "size": { 19563 "type": "integer" 19564 }, 19565 "master_branch": { 19566 "type": "integer" 19567 }, 19568 "open_issues": { 19569 "type": "integer" 19570 }, 19571 "open_issues_count": { 19572 "type": "integer" 19573 }, 19574 "pushed_at": { 19575 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 19576 "type": "string" 19577 }, 19578 "created_at": { 19579 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 19580 "type": "string" 19581 }, 19582 "updated_at": { 19583 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 19584 "type": "string" 19585 } 19586 }, 19587 "type": "object" 19588 } 19589 ] 19590 } 19591 example: | 19592 [ 19593 { 19594 "id": 1296269, 19595 "owner": { 19596 "login": "octocat", 19597 "id": 1, 19598 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 19599 "gravatar_id": "somehexcode", 19600 "url": "https://api.github.com/users/octocat" 19601 }, 19602 "name": "Hello-World", 19603 "full_name": "octocat/Hello-World", 19604 "description": "This your first repo!", 19605 "private": false, 19606 "fork": false, 19607 "url": "https://api.github.com/repos/octocat/Hello-World", 19608 "html_url": "https://github.com/octocat/Hello-World", 19609 "clone_url": "https://github.com/octocat/Hello-World.git", 19610 "git_url": "git://github.com/octocat/Hello-World.git", 19611 "ssh_url": "git@github.com:octocat/Hello-World.git", 19612 "svn_url": "https://svn.github.com/octocat/Hello-World", 19613 "mirror_url": "git://git.example.com/octocat/Hello-World", 19614 "homepage": "https://github.com", 19615 "language": null, 19616 "forks": 9, 19617 "forks_count": 9, 19618 "watchers": 80, 19619 "watchers_count": 80, 19620 "size": 108, 19621 "master_branch": "master", 19622 "open_issues": 0, 19623 "open_issues_count": 0, 19624 "pushed_at": "2011-01-26T19:06:43Z", 19625 "created_at": "2011-01-26T19:01:12Z", 19626 "updated_at": "2011-01-26T19:14:43Z" 19627 } 19628 ] 19629 /emails: 19630 type: collection 19631 get: 19632 description: | 19633 List email addresses for a user. 19634 In the final version of the API, this method will return an array of hashes 19635 with extended information for each email address indicating if the address 19636 has been verified and if it's the user's primary email address for GitHub. 19637 Until API v3 is finalized, use the application/vnd.github.v3 media type to 19638 get other response format. 19639 responses: 19640 200: 19641 body: 19642 application/json: 19643 schema: | 19644 { 19645 "$schema": "http://json-schema.org/draft-03/schema", 19646 "type": "array", 19647 "": [ 19648 { 19649 "type": "string" 19650 } 19651 ] 19652 } 19653 example: | 19654 [ 19655 "octocat@github.com", 19656 "support@github.com" 19657 ] 19658 application/vnd.github.v3: 19659 schema: | 19660 { 19661 "$schema": "http://json-schema.org/draft-03/schema", 19662 "type": "array", 19663 "": [ 19664 { 19665 "properties": { 19666 "email": { 19667 "type": "string" 19668 }, 19669 "verified": { 19670 "type": "boolean" 19671 }, 19672 "primary": { 19673 "type": "boolean" 19674 } 19675 }, 19676 "type": "object" 19677 } 19678 ] 19679 } 19680 example: | 19681 [ 19682 { 19683 "email": "octocat@github.com", 19684 "verified": true, 19685 "primary": true 19686 } 19687 ] 19688 post: 19689 description: | 19690 Add email address(es). 19691 You can post a single email address or an array of addresses. 19692 delete: 19693 description: | 19694 Delete email address(es). 19695 You can include a single email address or an array of addresses. 19696 body: 19697 application/json: 19698 schema: | 19699 { 19700 "$schema": "http://json-schema.org/draft-03/schema", 19701 "type": "array", 19702 "": [ 19703 { 19704 "type": "string" 19705 } 19706 ] 19707 } 19708 /following: 19709 type: collection 19710 get: 19711 description: List who the authenticated user is following. 19712 responses: 19713 200: 19714 body: 19715 schema: | 19716 { 19717 "$schema": "http://json-schema.org/draft-03/schema", 19718 "type": "array", 19719 "list": [ 19720 { 19721 "properties": { 19722 "login": { 19723 "type": "string" 19724 }, 19725 "id": { 19726 "type": "integer" 19727 }, 19728 "avatar_url": { 19729 "type": "string" 19730 }, 19731 "gravatar_id": { 19732 "type": "string" 19733 }, 19734 "url": { 19735 "type": "string" 19736 } 19737 }, 19738 "type": "object" 19739 } 19740 ] 19741 } 19742 example: | 19743 [ 19744 { 19745 "login": "octocat", 19746 "id": 1, 19747 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 19748 "gravatar_id": "somehexcode", 19749 "url": "https://api.github.com/users/octocat" 19750 } 19751 ] 19752 /{userId}: 19753 uriParameters: 19754 userId: 19755 type: integer 19756 type: base 19757 get: 19758 description: Check if you are following a user. 19759 responses: 19760 204: 19761 description: Response if you are following this user. 19762 404: 19763 description: Response if you are not following this user. 19764 put: 19765 description: | 19766 Follow a user. 19767 Following a user requires the user to be logged in and authenticated with 19768 basic auth or OAuth with the user:follow scope. 19769 responses: 19770 204: 19771 description: You are now following the user. 19772 delete: 19773 description: | 19774 Unfollow a user. 19775 Unfollowing a user requires the user to be logged in and authenticated with 19776 basic auth or OAuth with the user:follow scope. 19777 responses: 19778 204: 19779 description: User unfollowed. 19780 /keys: 19781 type: collection 19782 get: 19783 description: | 19784 List your public keys. 19785 Lists the current user's keys. Management of public keys via the API requires 19786 that you are authenticated through basic auth, or OAuth with the 'user' scope. 19787 responses: 19788 200: 19789 body: 19790 schema: | 19791 { 19792 "$schema": "http://json-schema.org/draft-03/schema", 19793 "type": "array", 19794 "": [ 19795 { 19796 "properties": { 19797 "id": { 19798 "type": "integer" 19799 }, 19800 "key": { 19801 "type": "string" 19802 }, 19803 "url": { 19804 "type": "string" 19805 }, 19806 "title": { 19807 "type": "string" 19808 } 19809 }, 19810 "type": "object" 19811 } 19812 ] 19813 } 19814 example: | 19815 [ 19816 { 19817 "id": 1, 19818 "key": "ssh-rsa AAA...", 19819 "url": "https://api.github.com/user/keys/1", 19820 "title": "octocat@octomac" 19821 } 19822 ] 19823 post: 19824 description: Create a public key. 19825 body: 19826 application/json: 19827 schema: | 19828 { 19829 "$schema": "http://json-schema.org/draft-03/schema", 19830 "type": "object", 19831 "properties": { 19832 "title": { 19833 "type": "string" 19834 }, 19835 "key": { 19836 "type": "string" 19837 } 19838 } 19839 } 19840 responses: 19841 201: 19842 body: 19843 schema: | 19844 { 19845 "$schema": "http://json-schema.org/draft-03/schema", 19846 "type": "object", 19847 "properties": { 19848 "id": { 19849 "type": "integer" 19850 }, 19851 "key": { 19852 "type": "string" 19853 }, 19854 "url": { 19855 "type": "string" 19856 }, 19857 "title": { 19858 "type": "string" 19859 } 19860 } 19861 } 19862 example: | 19863 { 19864 "id": 1, 19865 "key": "ssh-rsa AAA...", 19866 "url": "https://api.github.com/user/keys/1", 19867 "title": "octocat@octomac" 19868 } 19869 /{keyId}: 19870 uriParameters: 19871 keyId: 19872 type: integer 19873 type: item 19874 get: 19875 description: Get a single public key. 19876 responses: 19877 200: 19878 body: 19879 schema: | 19880 { 19881 "$schema": "http://json-schema.org/draft-03/schema", 19882 "type": "object", 19883 "properties": { 19884 "id": { 19885 "type": "integer" 19886 }, 19887 "key": { 19888 "type": "string" 19889 }, 19890 "url": { 19891 "type": "string" 19892 }, 19893 "title": { 19894 "type": "string" 19895 } 19896 } 19897 } 19898 example: | 19899 { 19900 "id": 1, 19901 "key": "ssh-rsa AAA...", 19902 "url": "https://api.github.com/user/keys/1", 19903 "title": "octocat@octomac" 19904 } 19905 patch: 19906 description: Update a public key. 19907 body: 19908 application/json: 19909 schema: | 19910 { 19911 "$schema": "http://json-schema.org/draft-03/schema", 19912 "type": "object", 19913 "properties": { 19914 "title": { 19915 "type": "string" 19916 }, 19917 "key": { 19918 "type": "string" 19919 } 19920 } 19921 } 19922 responses: 19923 200: 19924 body: 19925 schema: | 19926 { 19927 "$schema": "http://json-schema.org/draft-03/schema", 19928 "type": "object", 19929 "properties": { 19930 "id": { 19931 "type": "integer" 19932 }, 19933 "key": { 19934 "type": "string" 19935 }, 19936 "url": { 19937 "type": "string" 19938 }, 19939 "title": { 19940 "type": "string" 19941 } 19942 } 19943 } 19944 example: | 19945 { 19946 "id": 1, 19947 "key": "ssh-rsa AAA...", 19948 "url": "https://api.github.com/user/keys/1", 19949 "title": "octocat@octomac" 19950 } 19951 delete: 19952 description: Delete a public key. 19953 /starred: 19954 type: collection 19955 get: 19956 description: List repositories being starred by the authenticated user. 19957 queryParameters: 19958 sort: 19959 enum: 19960 - created 19961 - updated 19962 default: created 19963 direction: 19964 enum: 19965 - asc 19966 - desc 19967 default: desc 19968 responses: 19969 200: 19970 body: 19971 schema: | 19972 { 19973 "$schema": "http://json-schema.org/draft-03/schema", 19974 "type": "array", 19975 "": [ 19976 { 19977 "properties": { 19978 "id": { 19979 "type": "integer" 19980 }, 19981 "owner": { 19982 "properties": { 19983 "login": { 19984 "type": "string" 19985 }, 19986 "id": { 19987 "type": "integer" 19988 }, 19989 "avatar_url": { 19990 "type": "string" 19991 }, 19992 "gravatar_id": { 19993 "type": "string" 19994 }, 19995 "url": { 19996 "type": "string" 19997 } 19998 }, 19999 "type": "object" 20000 }, 20001 "name": { 20002 "type": "string" 20003 }, 20004 "full_name": { 20005 "type": "string" 20006 }, 20007 "description": { 20008 "type": "string" 20009 }, 20010 "private": { 20011 "type": "boolean" 20012 }, 20013 "fork": { 20014 "type": "boolean" 20015 }, 20016 "url": { 20017 "type": "string" 20018 }, 20019 "html_url": { 20020 "type": "string" 20021 }, 20022 "clone_url": { 20023 "type": "string" 20024 }, 20025 "ssh_url": { 20026 "type": "string" 20027 }, 20028 "svn_url": { 20029 "type": "string" 20030 }, 20031 "mirror_url": { 20032 "type": "string" 20033 }, 20034 "homepage": { 20035 "type": "string" 20036 }, 20037 "language": { 20038 "type": "string" 20039 }, 20040 "forks": { 20041 "type": "integer" 20042 }, 20043 "forks_count": { 20044 "type": "integer" 20045 }, 20046 "watchers": { 20047 "type": "integer" 20048 }, 20049 "watchers_count": { 20050 "type": "integer" 20051 }, 20052 "size": { 20053 "type": "integer" 20054 }, 20055 "master_branch": { 20056 "type": "string" 20057 }, 20058 "open_issues": { 20059 "type": "integer" 20060 }, 20061 "open_issues_count": { 20062 "type": "integer" 20063 }, 20064 "pushed_at": { 20065 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 20066 "type": "string" 20067 }, 20068 "created_at": { 20069 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 20070 "type": "string" 20071 }, 20072 "updated_at": { 20073 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 20074 "type": "string" 20075 } 20076 }, 20077 "type": "object" 20078 } 20079 ] 20080 } 20081 example: | 20082 [ 20083 { 20084 "id": 1296269, 20085 "owner": { 20086 "login": "octocat", 20087 "id": 1, 20088 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 20089 "gravatar_id": "somehexcode", 20090 "url": "https://api.github.com/users/octocat" 20091 }, 20092 "name": "Hello-World", 20093 "full_name": "octocat/Hello-World", 20094 "description": "This your first repo!", 20095 "private": false, 20096 "fork": false, 20097 "url": "https://api.github.com/repos/octocat/Hello-World", 20098 "html_url": "https://github.com/octocat/Hello-World", 20099 "clone_url": "https://github.com/octocat/Hello-World.git", 20100 "git_url": "git://github.com/octocat/Hello-World.git", 20101 "ssh_url": "git@github.com:octocat/Hello-World.git", 20102 "svn_url": "https://svn.github.com/octocat/Hello-World", 20103 "mirror_url": "git://git.example.com/octocat/Hello-World", 20104 "homepage": "https://github.com", 20105 "language": null, 20106 "forks": 9, 20107 "forks_count": 9, 20108 "watchers": 80, 20109 "watchers_count": 80, 20110 "size": 108, 20111 "master_branch": "master", 20112 "open_issues": 0, 20113 "open_issues_count": 0, 20114 "pushed_at": "2011-01-26T19:06:43Z", 20115 "created_at": "2011-01-26T19:01:12Z", 20116 "updated_at": "2011-01-26T19:14:43Z" 20117 } 20118 ] 20119 /{ownerId}/{repoId}: 20120 type: base 20121 get: 20122 description: Check if you are starring a repository. 20123 responses: 20124 204: 20125 description: This repository is starred by you. 20126 404: 20127 description: This repository is not starred by you. 20128 put: 20129 description: Star a repository. 20130 responses: 20131 204: 20132 description: Repository starred. 20133 delete: 20134 description: Unstar a repository 20135 responses: 20136 204: 20137 description: Unstarred. 20138 /subscriptions: 20139 type: collection 20140 get: 20141 description: List repositories being watched by the authenticated user. 20142 responses: 20143 200: 20144 body: 20145 schema: | 20146 { 20147 "$schema": "http://json-schema.org/draft-03/schema", 20148 "type": "array", 20149 "properties": [ 20150 { 20151 "properties": { 20152 "id": { 20153 "type": "integer" 20154 }, 20155 "owner": { 20156 "properties": { 20157 "login": { 20158 "type": "string" 20159 }, 20160 "id": { 20161 "type": "integer" 20162 }, 20163 "avatar_url": { 20164 "type": "string" 20165 }, 20166 "gravatar_id": { 20167 "type": "string" 20168 }, 20169 "url": { 20170 "type": "string" 20171 } 20172 }, 20173 "type": "object" 20174 }, 20175 "name": { 20176 "type": "string" 20177 }, 20178 "full_name": { 20179 "type": "string" 20180 }, 20181 "description": { 20182 "type": "string" 20183 }, 20184 "private": { 20185 "type": "boolean" 20186 }, 20187 "fork": { 20188 "type": "boolean" 20189 }, 20190 "url": { 20191 "type": "string" 20192 }, 20193 "html_url": { 20194 "type": "string" 20195 }, 20196 "clone_url": { 20197 "type": "string" 20198 }, 20199 "git_url": { 20200 "type": "string" 20201 }, 20202 "ssh_url": { 20203 "type": "string" 20204 }, 20205 "svn_url": { 20206 "type": "string" 20207 }, 20208 "mirror_url": { 20209 "type": "string" 20210 }, 20211 "homepage": { 20212 "type": "string" 20213 }, 20214 "language": { 20215 "type": "string" 20216 }, 20217 "forks": { 20218 "type": "integer" 20219 }, 20220 "forks_count": { 20221 "type": "integer" 20222 }, 20223 "watchers": { 20224 "type": "integer" 20225 }, 20226 "watchers_count": { 20227 "type": "integer" 20228 }, 20229 "size": { 20230 "type": "integer" 20231 }, 20232 "master_branch": { 20233 "type": "integer" 20234 }, 20235 "open_issues": { 20236 "type": "integer" 20237 }, 20238 "open_issues_count": { 20239 "type": "integer" 20240 }, 20241 "pushed_at": { 20242 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 20243 "type": "string" 20244 }, 20245 "created_at": { 20246 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 20247 "type": "string" 20248 }, 20249 "updated_at": { 20250 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 20251 "type": "string" 20252 } 20253 }, 20254 "type": "object" 20255 } 20256 ] 20257 } 20258 example: | 20259 [ 20260 { 20261 "id": 1296269, 20262 "owner": { 20263 "login": "octocat", 20264 "id": 1, 20265 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 20266 "gravatar_id": "somehexcode", 20267 "url": "https://api.github.com/users/octocat" 20268 }, 20269 "name": "Hello-World", 20270 "full_name": "octocat/Hello-World", 20271 "description": "This your first repo!", 20272 "private": false, 20273 "fork": false, 20274 "url": "https://api.github.com/repos/octocat/Hello-World", 20275 "html_url": "https://github.com/octocat/Hello-World", 20276 "clone_url": "https://github.com/octocat/Hello-World.git", 20277 "git_url": "git://github.com/octocat/Hello-World.git", 20278 "ssh_url": "git@github.com:octocat/Hello-World.git", 20279 "svn_url": "https://svn.github.com/octocat/Hello-World", 20280 "mirror_url": "git://git.example.com/octocat/Hello-World", 20281 "homepage": "https://github.com", 20282 "language": null, 20283 "forks": 9, 20284 "forks_count": 9, 20285 "watchers": 80, 20286 "watchers_count": 80, 20287 "size": 108, 20288 "master_branch": "master", 20289 "open_issues": 0, 20290 "open_issues_count": 0, 20291 "pushed_at": "2011-01-26T19:06:43Z", 20292 "created_at": "2011-01-26T19:01:12Z", 20293 "updated_at": "2011-01-26T19:14:43Z" 20294 } 20295 ] 20296 /{ownerId}/{repoId}: 20297 type: base 20298 uriParameters: 20299 ownerId: 20300 description: Id of the owner. 20301 type: integer 20302 repoId: 20303 description: Id of repository. 20304 type: integer 20305 get: 20306 description: Check if you are watching a repository. 20307 responses: 20308 204: 20309 description: Repository is watched by you. 20310 404: 20311 description: Repository is not watched by you. 20312 put: 20313 description: Watch a repository. 20314 responses: 20315 204: 20316 description: Repository is watched. 20317 delete: 20318 description: Stop watching a repository 20319 responses: 20320 204: 20321 description: Unwatched. 20322 /issues: 20323 type: collection 20324 get: 20325 is: [ filterable ] 20326 description: | 20327 List issues. 20328 List all issues across owned and member repositories for the authenticated 20329 user. 20330 responses: 20331 200: 20332 body: 20333 schema: | 20334 { 20335 "$schema": "http://json-schema.org/draft-03/schema", 20336 "type": "array", 20337 "issues": [ 20338 { 20339 "properties": { 20340 "url": { 20341 "type": "string" 20342 }, 20343 "html_url": { 20344 "type": "string" 20345 }, 20346 "number": { 20347 "type": "integer" 20348 }, 20349 "state": { 20350 "enum": [ 20351 "open", 20352 "closed" 20353 ] 20354 }, 20355 "title": { 20356 "type": "string" 20357 }, 20358 "body": { 20359 "type": "string" 20360 }, 20361 "user": { 20362 "properties": { 20363 "login": { 20364 "type": "string" 20365 }, 20366 "id": { 20367 "type": "integer" 20368 }, 20369 "avatar_url": { 20370 "type": "string" 20371 }, 20372 "gravatar_id": { 20373 "type": "string" 20374 }, 20375 "url": { 20376 "type": "string" 20377 } 20378 }, 20379 "type": "object" 20380 }, 20381 "labels": [ 20382 { 20383 "properties": { 20384 "url": { 20385 "type": "string" 20386 }, 20387 "name": { 20388 "type": "string" 20389 }, 20390 "color": { 20391 "type": "string" 20392 } 20393 }, 20394 "type": "object" 20395 } 20396 ], 20397 "type": "array", 20398 "assignee": { 20399 "properties": { 20400 "login": { 20401 "type": "string" 20402 }, 20403 "id": { 20404 "type": "integer" 20405 }, 20406 "avatar_url": { 20407 "type": "string" 20408 }, 20409 "gravatar_id": { 20410 "type": "string" 20411 }, 20412 "url": { 20413 "type": "string" 20414 } 20415 }, 20416 "type": "object" 20417 }, 20418 "milestone": { 20419 "properties": { 20420 "url": { 20421 "type": "string" 20422 }, 20423 "number": { 20424 "type": "integer" 20425 }, 20426 "state": { 20427 "enum": [ 20428 "open", 20429 "closed" 20430 ] 20431 }, 20432 "title": { 20433 "type": "string" 20434 }, 20435 "description": { 20436 "type": "string" 20437 }, 20438 "creator": { 20439 "properties": { 20440 "login": { 20441 "type": "string" 20442 }, 20443 "id": { 20444 "type": "integer" 20445 }, 20446 "avatar_url": { 20447 "type": "string" 20448 }, 20449 "gravatar_id": { 20450 "type": "string" 20451 }, 20452 "url": { 20453 "type": "string" 20454 } 20455 }, 20456 "type": "object" 20457 }, 20458 "open_issues": { 20459 "type": "integer" 20460 }, 20461 "closed_issues": { 20462 "type": "integer" 20463 }, 20464 "created_at": { 20465 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 20466 "type": "string" 20467 }, 20468 "due_on": { 20469 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 20470 "type": "string" 20471 } 20472 }, 20473 "type": "object" 20474 }, 20475 "comments": { 20476 "type": "integer" 20477 }, 20478 "pull_request": { 20479 "properties": { 20480 "html_url": { 20481 "type": "string" 20482 }, 20483 "diff_url": { 20484 "type": "string" 20485 }, 20486 "patch_url": { 20487 "type": "string" 20488 } 20489 }, 20490 "type": "object" 20491 }, 20492 "closed_at": { 20493 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 20494 "type": "string" 20495 }, 20496 "created_at": { 20497 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 20498 "type": "string" 20499 }, 20500 "updated_at": { 20501 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 20502 "type": "string" 20503 } 20504 }, 20505 "type": "object" 20506 } 20507 ] 20508 } 20509 example: | 20510 [ 20511 { 20512 "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", 20513 "html_url": "https://github.com/octocat/Hello-World/issues/1347", 20514 "number": 1347, 20515 "state": "open", 20516 "title": "Found a bug", 20517 "body": "I'm having a problem with this.", 20518 "user": { 20519 "login": "octocat", 20520 "id": 1, 20521 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 20522 "gravatar_id": "somehexcode", 20523 "url": "https://api.github.com/users/octocat" 20524 }, 20525 "labels": [ 20526 { 20527 "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", 20528 "name": "bug", 20529 "color": "f29513" 20530 } 20531 ], 20532 "assignee": { 20533 "login": "octocat", 20534 "id": 1, 20535 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 20536 "gravatar_id": "somehexcode", 20537 "url": "https://api.github.com/users/octocat" 20538 }, 20539 "milestone": { 20540 "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", 20541 "number": 1, 20542 "state": "open", 20543 "title": "v1.0", 20544 "description": "", 20545 "creator": { 20546 "login": "octocat", 20547 "id": 1, 20548 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 20549 "gravatar_id": "somehexcode", 20550 "url": "https://api.github.com/users/octocat" 20551 }, 20552 "open_issues": 4, 20553 "closed_issues": 8, 20554 "created_at": "2011-04-10T20:09:31Z", 20555 "due_on": null 20556 }, 20557 "comments": 0, 20558 "pull_request": { 20559 "html_url": "https://github.com/octocat/Hello-World/issues/1347", 20560 "diff_url": "https://github.com/octocat/Hello-World/issues/1347.diff", 20561 "patch_url": "https://github.com/octocat/Hello-World/issues/1347.patch" 20562 }, 20563 "closed_at": null, 20564 "created_at": "2011-04-22T13:33:48Z", 20565 "updated_at": "2011-04-22T13:33:48Z" 20566 } 20567 ] 20568 /repos: 20569 type: collection 20570 get: 20571 description: | 20572 List repositories for the authenticated user. Note that this does not include 20573 repositories owned by organizations which the user can access. You can list 20574 user organizations and list organization repositories separately. 20575 queryParameters: 20576 type: 20577 enum: 20578 - all 20579 - public 20580 - private 20581 - forks 20582 - sources 20583 - member 20584 default: all 20585 responses: 20586 200: 20587 body: 20588 schema: | 20589 { 20590 "$schema": "http://json-schema.org/draft-03/schema", 20591 "type": "object", 20592 "properties": { 20593 "": [ 20594 { 20595 "properties": { 20596 "id": { 20597 "type": "integer" 20598 }, 20599 "owner": { 20600 "properties": { 20601 "login": { 20602 "type": "string" 20603 }, 20604 "id": { 20605 "type": "integer" 20606 }, 20607 "avatar_url": { 20608 "type": "string" 20609 }, 20610 "gravatar_id": { 20611 "type": "string" 20612 }, 20613 "url": { 20614 "type": "string" 20615 } 20616 }, 20617 "type": "object" 20618 }, 20619 "name": { 20620 "type": "string" 20621 }, 20622 "full_name": { 20623 "type": "string" 20624 }, 20625 "description": { 20626 "type": "string" 20627 }, 20628 "private": { 20629 "type": "boolean" 20630 }, 20631 "fork": { 20632 "type": "boolean" 20633 }, 20634 "url": { 20635 "type": "string" 20636 }, 20637 "html_url": { 20638 "type": "string" 20639 }, 20640 "clone_url": { 20641 "type": "string" 20642 }, 20643 "git_url": { 20644 "type": "string" 20645 }, 20646 "ssh_url": { 20647 "type": "string" 20648 }, 20649 "svn_url": { 20650 "type": "string" 20651 }, 20652 "mirror_url": { 20653 "type": "string" 20654 }, 20655 "homepage": { 20656 "type": "string" 20657 }, 20658 "language": { 20659 "type": "string" 20660 }, 20661 "forks": { 20662 "type": "integer" 20663 }, 20664 "forks_count": { 20665 "type": "integer" 20666 }, 20667 "watchers": { 20668 "type": "integer" 20669 }, 20670 "watchers_count": { 20671 "type": "integer" 20672 }, 20673 "size": { 20674 "type": "integer" 20675 }, 20676 "master_branch": { 20677 "type": "string" 20678 }, 20679 "open_issues": { 20680 "type": "integer" 20681 }, 20682 "open_issues_count": { 20683 "type": "integer" 20684 }, 20685 "pushed_at": { 20686 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 20687 "type": "string" 20688 }, 20689 "created_at": { 20690 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 20691 "type": "string" 20692 }, 20693 "updated_at": { 20694 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 20695 "type": "string" 20696 } 20697 }, 20698 "type": "object" 20699 } 20700 ] 20701 } 20702 } 20703 example: | 20704 [ 20705 { 20706 "id": 1296269, 20707 "owner": { 20708 "login": "octocat", 20709 "id": 1, 20710 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 20711 "gravatar_id": "somehexcode", 20712 "url": "https://api.github.com/users/octocat" 20713 }, 20714 "name": "Hello-World", 20715 "full_name": "octocat/Hello-World", 20716 "description": "This your first repo!", 20717 "private": false, 20718 "fork": true, 20719 "url": "https://api.github.com/repos/octocat/Hello-World", 20720 "html_url": "https://github.com/octocat/Hello-World", 20721 "clone_url": "https://github.com/octocat/Hello-World.git", 20722 "git_url": "git://github.com/octocat/Hello-World.git", 20723 "ssh_url": "git@github.com:octocat/Hello-World.git", 20724 "svn_url": "https://svn.github.com/octocat/Hello-World", 20725 "mirror_url": "git://git.example.com/octocat/Hello-World", 20726 "homepage": "https://github.com", 20727 "language": null, 20728 "forks": 9, 20729 "forks_count": 9, 20730 "watchers": 80, 20731 "watchers_count": 80, 20732 "size": 108, 20733 "master_branch": "master", 20734 "open_issues": 0, 20735 "open_issues_count": 0, 20736 "pushed_at": "2011-01-26T19:06:43Z", 20737 "created_at": "2011-01-26T19:01:12Z", 20738 "updated_at": "2011-01-26T19:14:43Z" 20739 } 20740 ] 20741 post: 20742 description: | 20743 Create a new repository for the authenticated user. OAuth users must supply 20744 repo scope. 20745 body: 20746 application/json: 20747 schema: | 20748 { 20749 "$schema": "http://json-schema.org/draft-03/schema", 20750 "type": "object", 20751 "properties": { 20752 "name": { 20753 "type": "string" 20754 }, 20755 "description": { 20756 "type": "string" 20757 }, 20758 "homepage": { 20759 "type": "string" 20760 }, 20761 "private": { 20762 "description": "True to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account.", 20763 "type": "boolean" 20764 }, 20765 "has_issues": { 20766 "description": "True to enable issues for this repository, false to disable them. Default is true.", 20767 "type": "boolean" 20768 }, 20769 "has_wiki": { 20770 "description": "True to enable the wiki for this repository, false to disable it. Default is true.", 20771 "type": "boolean" 20772 }, 20773 "has_downloads": { 20774 "description": "True to enable downloads for this repository, false to disable them. Default is true.", 20775 "type": "boolean" 20776 }, 20777 "team_id": { 20778 "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repo in an organization.", 20779 "type": "integer" 20780 }, 20781 "auto_init": { 20782 "description": "True to create an initial commit with empty README. Default is false.", 20783 "type": "boolean" 20784 }, 20785 "gitignore_template": { 20786 "description": "Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\" Ignored if auto_init parameter is not provided. ", 20787 "type": "string" 20788 } 20789 }, 20790 "required": [ "name" ] 20791 } 20792 responses: 20793 201: 20794 body: 20795 schema: | 20796 { 20797 "$schema": "http://json-schema.org/draft-03/schema", 20798 "type": "object", 20799 "properties": { 20800 "": [ 20801 { 20802 "properties": { 20803 "id": { 20804 "type": "integer" 20805 }, 20806 "owner": { 20807 "properties": { 20808 "login": { 20809 "type": "string" 20810 }, 20811 "id": { 20812 "type": "integer" 20813 }, 20814 "avatar_url": { 20815 "type": "string" 20816 }, 20817 "gravatar_id": { 20818 "type": "string" 20819 }, 20820 "url": { 20821 "type": "string" 20822 } 20823 }, 20824 "type": "object" 20825 }, 20826 "name": { 20827 "type": "string" 20828 }, 20829 "full_name": { 20830 "type": "string" 20831 }, 20832 "description": { 20833 "type": "string" 20834 }, 20835 "private": { 20836 "type": "boolean" 20837 }, 20838 "fork": { 20839 "type": "boolean" 20840 }, 20841 "url": { 20842 "type": "string" 20843 }, 20844 "html_url": { 20845 "type": "string" 20846 }, 20847 "clone_url": { 20848 "type": "string" 20849 }, 20850 "git_url": { 20851 "type": "string" 20852 }, 20853 "ssh_url": { 20854 "type": "string" 20855 }, 20856 "svn_url": { 20857 "type": "string" 20858 }, 20859 "mirror_url": { 20860 "type": "string" 20861 }, 20862 "homepage": { 20863 "type": "string" 20864 }, 20865 "language": { 20866 "type": "string" 20867 }, 20868 "forks": { 20869 "type": "integer" 20870 }, 20871 "forks_count": { 20872 "type": "integer" 20873 }, 20874 "watchers": { 20875 "type": "integer" 20876 }, 20877 "watchers_count": { 20878 "type": "integer" 20879 }, 20880 "size": { 20881 "type": "integer" 20882 }, 20883 "master_branch": { 20884 "type": "string" 20885 }, 20886 "open_issues": { 20887 "type": "integer" 20888 }, 20889 "open_issues_count": { 20890 "type": "integer" 20891 }, 20892 "pushed_at": { 20893 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 20894 "type": "string" 20895 }, 20896 "created_at": { 20897 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 20898 "type": "string" 20899 }, 20900 "updated_at": { 20901 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 20902 "type": "string" 20903 } 20904 }, 20905 "type": "object" 20906 } 20907 ] 20908 } 20909 } 20910 example: | 20911 [ 20912 { 20913 "id": 1296269, 20914 "owner": { 20915 "login": "octocat", 20916 "id": 1, 20917 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 20918 "gravatar_id": "somehexcode", 20919 "url": "https://api.github.com/users/octocat" 20920 }, 20921 "name": "Hello-World", 20922 "full_name": "octocat/Hello-World", 20923 "description": "This your first repo!", 20924 "private": false, 20925 "fork": true, 20926 "url": "https://api.github.com/repos/octocat/Hello-World", 20927 "html_url": "https://github.com/octocat/Hello-World", 20928 "clone_url": "https://github.com/octocat/Hello-World.git", 20929 "git_url": "git://github.com/octocat/Hello-World.git", 20930 "ssh_url": "git@github.com:octocat/Hello-World.git", 20931 "svn_url": "https://svn.github.com/octocat/Hello-World", 20932 "mirror_url": "git://git.example.com/octocat/Hello-World", 20933 "homepage": "https://github.com", 20934 "language": null, 20935 "forks": 9, 20936 "forks_count": 9, 20937 "watchers": 80, 20938 "watchers_count": 80, 20939 "size": 108, 20940 "master_branch": "master", 20941 "open_issues": 0, 20942 "open_issues_count": 0, 20943 "pushed_at": "2011-01-26T19:06:43Z", 20944 "created_at": "2011-01-26T19:01:12Z", 20945 "updated_at": "2011-01-26T19:14:43Z" 20946 } 20947 ] 20948/users: 20949 type: collection 20950 get: 20951 description: | 20952 Get all users. 20953 This provides a dump of every user, in the order that they signed up for GitHub. 20954 Note: Pagination is powered exclusively by the since parameter. Use the Link 20955 header to get the URL for the next page of users. 20956 queryParameters: 20957 since: 20958 description: The integer ID of the last User that you've seen. 20959 type: integer 20960 responses: 20961 200: 20962 body: 20963 schema: | 20964 { 20965 "$schema": "http://json-schema.org/draft-03/schema", 20966 "type": "array", 20967 "list": [ 20968 { 20969 "properties": { 20970 "login": { 20971 "type": "string" 20972 }, 20973 "id": { 20974 "type": "integer" 20975 }, 20976 "avatar_url": { 20977 "type": "string" 20978 }, 20979 "gravatar_id": { 20980 "type": "string" 20981 }, 20982 "url": { 20983 "type": "string" 20984 } 20985 }, 20986 "type": "object" 20987 } 20988 ] 20989 } 20990 example: | 20991 [ 20992 { 20993 "login": "octocat", 20994 "id": 1, 20995 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 20996 "gravatar_id": "somehexcode", 20997 "url": "https://api.github.com/users/octocat" 20998 } 20999 ] 21000 /{userId}: 21001 uriParameters: 21002 userId: 21003 type: integer 21004 type: collection 21005 get: 21006 description: List a user's followers. 21007 responses: 21008 200: 21009 body: 21010 schema: | 21011 { 21012 "$schema": "http://json-schema.org/draft-03/schema", 21013 "type": "array", 21014 "list": [ 21015 { 21016 "properties": { 21017 "login": { 21018 "type": "string" 21019 }, 21020 "id": { 21021 "type": "integer" 21022 }, 21023 "avatar_url": { 21024 "type": "string" 21025 }, 21026 "gravatar_id": { 21027 "type": "string" 21028 }, 21029 "url": { 21030 "type": "string" 21031 } 21032 }, 21033 "type": "object" 21034 } 21035 ] 21036 } 21037 example: | 21038 [ 21039 { 21040 "login": "octocat", 21041 "id": 1, 21042 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 21043 "gravatar_id": "somehexcode", 21044 "url": "https://api.github.com/users/octocat" 21045 } 21046 ] 21047 # Followers 21048 /following/{targetUserId}: 21049 uriParameters: 21050 targetUserId: 21051 type: integer 21052 type: base 21053 get: 21054 description: Check if one user follows another. 21055 responses: 21056 204: 21057 description: Response if user follows target user. 21058 404: 21059 description: Response if user does not follow target user. 21060 # Keys 21061 /keys: 21062 type: collection 21063 get: 21064 description: | 21065 List public keys for a user. 21066 Lists the verified public keys for a user. This is accessible by anyone. 21067 responses: 21068 200: 21069 body: 21070 schema: | 21071 { 21072 "$schema": "http://json-schema.org/draft-03/schema", 21073 "type": "array", 21074 "": [ 21075 { 21076 "id": { 21077 "type": "integer" 21078 }, 21079 "key": { 21080 "type": "string" 21081 } 21082 } 21083 ] 21084 } 21085 example: | 21086 [ 21087 { 21088 "id": 1, 21089 "key": "ssh-rsa AAA..." 21090 } 21091 ] 21092 # Gists 21093 /gists: 21094 type: collection 21095 get: 21096 securedBy: [ null, oauth_2_0 ] 21097 description: List a user's gists. 21098 queryParameters: 21099 since: 21100 description: | 21101 Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. 21102 Only gists updated at or after this time are returned. 21103 type: string 21104 responses: 21105 200: 21106 body: 21107 schema: | 21108 { 21109 "$schema": "http://json-schema.org/draft-03/schema", 21110 "type": "array", 21111 "gists": [ 21112 { 21113 "type": "object", 21114 "properties": { 21115 "url": { 21116 "type": "string" 21117 }, 21118 "id": { 21119 "type": "string" 21120 }, 21121 "description": { 21122 "type": "string" 21123 }, 21124 "public": { 21125 "type": "boolean" 21126 }, 21127 "user": { 21128 "properties": { 21129 "login": { 21130 "type": "string" 21131 }, 21132 "id": { 21133 "type": "integer" 21134 }, 21135 "avatar_url": { 21136 "type": "string" 21137 }, 21138 "gravatar_id": { 21139 "type": "string" 21140 }, 21141 "url": { 21142 "type": "string" 21143 } 21144 }, 21145 "type": "object" 21146 }, 21147 "files": { 21148 "properties": { 21149 "ring.erl": { 21150 "properties": { 21151 "size": { 21152 "type": "integer" 21153 }, 21154 "filename": { 21155 "type": "string" 21156 }, 21157 "raw_url": { 21158 "type": "string" 21159 } 21160 }, 21161 "type": "object" 21162 } 21163 }, 21164 "type": "object" 21165 }, 21166 "comments": { 21167 "type": "integer" 21168 }, 21169 "comments_url": { 21170 "type": "string" 21171 }, 21172 "html_url": { 21173 "type": "string" 21174 }, 21175 "git_pull_url": { 21176 "type": "string" 21177 }, 21178 "git_push_url": { 21179 "type": "string" 21180 }, 21181 "created_at": { 21182 "type": "string" 21183 } 21184 } 21185 } 21186 ] 21187 } 21188 example: | 21189 [ 21190 { 21191 "url": "https://api.github.com/gists/20c98223d9b59e1d48e5", 21192 "id": "1", 21193 "description": "description of gist", 21194 "public": true, 21195 "user": { 21196 "login": "octocat", 21197 "id": 1, 21198 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 21199 "gravatar_id": "somehexcode", 21200 "url": "https://api.github.com/users/octocat" 21201 }, 21202 "files": { 21203 "ring.erl": { 21204 "size": 932, 21205 "filename": "ring.erl", 21206 "raw_url": "https://gist.github.com/raw/365370/8c4d2d43d178df44f4c03a7f2ac0ff512853564e/ring.erl" 21207 } 21208 }, 21209 "comments": 0, 21210 "comments_url": "https://api.github.com/gists/19d18b30e8af75090307/comments/", 21211 "html_url": "https://gist.github.com/1", 21212 "git_pull_url": "git://gist.github.com/1.git", 21213 "git_push_url": "git@gist.github.com:1.git", 21214 "created_at": "2010-04-14T02:15:15Z" 21215 } 21216 ] 21217 /orgs: 21218 type: collection 21219 get: 21220 description: List all public organizations for a user. 21221 responses: 21222 200: 21223 body: 21224 schema: | 21225 { 21226 "$schema": "http://json-schema.org/draft-03/schema", 21227 "type": "array", 21228 "": [ 21229 { 21230 "login": { 21231 "type": "string" 21232 }, 21233 "id": { 21234 "type": "integer" 21235 }, 21236 "url": { 21237 "type": "string" 21238 }, 21239 "avatar_url": { 21240 "type": "string" 21241 } 21242 } 21243 ] 21244 } 21245 example: | 21246 [ 21247 { 21248 "login": "github", 21249 "id": 1, 21250 "url": "https://api.github.com/orgs/github", 21251 "avatar_url": "https://github.com/images/error/octocat_happy.gif" 21252 } 21253 ] 21254 /repos: 21255 type: collection 21256 get: 21257 description: List public repositories for the specified user. 21258 queryParameters: 21259 type: 21260 enum: 21261 - all 21262 - public 21263 - private 21264 - forks 21265 - sources 21266 - member 21267 default: all 21268 responses: 21269 200: 21270 body: 21271 schema: | 21272 { 21273 "$schema": "http://json-schema.org/draft-03/schema", 21274 "type": "object", 21275 "properties": { 21276 "": [ 21277 { 21278 "properties": { 21279 "id": { 21280 "type": "integer" 21281 }, 21282 "owner": { 21283 "properties": { 21284 "login": { 21285 "type": "string" 21286 }, 21287 "id": { 21288 "type": "integer" 21289 }, 21290 "avatar_url": { 21291 "type": "string" 21292 }, 21293 "gravatar_id": { 21294 "type": "string" 21295 }, 21296 "url": { 21297 "type": "string" 21298 } 21299 }, 21300 "type": "object" 21301 }, 21302 "name": { 21303 "type": "string" 21304 }, 21305 "full_name": { 21306 "type": "string" 21307 }, 21308 "description": { 21309 "type": "string" 21310 }, 21311 "private": { 21312 "type": "boolean" 21313 }, 21314 "fork": { 21315 "type": "boolean" 21316 }, 21317 "url": { 21318 "type": "string" 21319 }, 21320 "html_url": { 21321 "type": "string" 21322 }, 21323 "clone_url": { 21324 "type": "string" 21325 }, 21326 "git_url": { 21327 "type": "string" 21328 }, 21329 "ssh_url": { 21330 "type": "string" 21331 }, 21332 "svn_url": { 21333 "type": "string" 21334 }, 21335 "mirror_url": { 21336 "type": "string" 21337 }, 21338 "homepage": { 21339 "type": "string" 21340 }, 21341 "language": { 21342 "type": "string" 21343 }, 21344 "forks": { 21345 "type": "integer" 21346 }, 21347 "forks_count": { 21348 "type": "integer" 21349 }, 21350 "watchers": { 21351 "type": "integer" 21352 }, 21353 "watchers_count": { 21354 "type": "integer" 21355 }, 21356 "size": { 21357 "type": "integer" 21358 }, 21359 "master_branch": { 21360 "type": "string" 21361 }, 21362 "open_issues": { 21363 "type": "integer" 21364 }, 21365 "open_issues_count": { 21366 "type": "integer" 21367 }, 21368 "pushed_at": { 21369 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 21370 "type": "string" 21371 }, 21372 "created_at": { 21373 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 21374 "type": "string" 21375 }, 21376 "updated_at": { 21377 "description": "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ", 21378 "type": "string" 21379 } 21380 }, 21381 "type": "object" 21382 } 21383 ] 21384 } 21385 } 21386 example: | 21387 [ 21388 { 21389 "id": 1296269, 21390 "owner": { 21391 "login": "octocat", 21392 "id": 1, 21393 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 21394 "gravatar_id": "somehexcode", 21395 "url": "https://api.github.com/users/octocat" 21396 }, 21397 "name": "Hello-World", 21398 "full_name": "octocat/Hello-World", 21399 "description": "This your first repo!", 21400 "private": false, 21401 "fork": true, 21402 "url": "https://api.github.com/repos/octocat/Hello-World", 21403 "html_url": "https://github.com/octocat/Hello-World", 21404 "clone_url": "https://github.com/octocat/Hello-World.git", 21405 "git_url": "git://github.com/octocat/Hello-World.git", 21406 "ssh_url": "git@github.com:octocat/Hello-World.git", 21407 "svn_url": "https://svn.github.com/octocat/Hello-World", 21408 "mirror_url": "git://git.example.com/octocat/Hello-World", 21409 "homepage": "https://github.com", 21410 "language": null, 21411 "forks": 9, 21412 "forks_count": 9, 21413 "watchers": 80, 21414 "watchers_count": 80, 21415 "size": 108, 21416 "master_branch": "master", 21417 "open_issues": 0, 21418 "open_issues_count": 0, 21419 "pushed_at": "2011-01-26T19:06:43Z", 21420 "created_at": "2011-01-26T19:01:12Z", 21421 "updated_at": "2011-01-26T19:14:43Z" 21422 } 21423 ] 21424/gitignore/templates: 21425 type: collection 21426 get: 21427 description: | 21428 Listing available templates. 21429 List all templates available to pass as an option when creating a repository. 21430 responses: 21431 200: 21432 body: 21433 schema: | 21434 { 21435 "$schema": "http://json-schema.org/draft-03/schema", 21436 "type": "array", 21437 "": [ 21438 { 21439 "type": "string" 21440 } 21441 ] 21442 } 21443 example: | 21444 [ 21445 "Actionscript", 21446 "Android", 21447 "AppceleratorTitanium", 21448 "Autotools", 21449 "Bancha", 21450 "C", 21451 "C++" 21452 ] 21453 /{language}: 21454 type: item 21455 uriParameters: 21456 language: 21457 type: string 21458 get: 21459 description: Get a single template. 21460 responses: 21461 200: 21462 body: 21463 schema: | 21464 { 21465 "$schema": "http://json-schema.org/draft-03/schema", 21466 "type": "object", 21467 "properties": { 21468 "name": { 21469 "type": "string" 21470 }, 21471 "source": { 21472 "type": "string" 21473 } 21474 } 21475 } 21476 example: | 21477 { 21478 "name": "C", 21479 "source": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" 21480 } 21481/markdown: 21482 type: base 21483 post: 21484 body: 21485 application/json: 21486 schema: | 21487 { 21488 "$schema": "http://json-schema.org/draft-03/schema", 21489 "type": "object", 21490 "properties": { 21491 "text": { 21492 "description": "The Markdown text to render", 21493 "type": "string" 21494 }, 21495 "mode": { 21496 "enum": [ 21497 "markdown", 21498 "gfm" 21499 ] 21500 }, 21501 "context": { 21502 "description": "The repository context, only taken into account when rendering as gfm.", 21503 "type": "string" 21504 } 21505 }, 21506 "required": [ 21507 "text" 21508 ] 21509 } 21510 responses: 21511 200: 21512 body: 21513 text/html: 21514 example: | 21515 <p>Hello world <a href="http://github.com/github/linguist/issues/1" class="issue-link" title="This is a simple issue">github/linguist#1</a> <strong>cool</strong>, and <a href="http://github.com/github/gollum/issues/1" class="issue-link" title="This is another issue">#1</a>!</p> 21516 /raw: 21517 type: base 21518 post: 21519 body: 21520 text/plain: 21521 example: | 21522 <p>Hello world github/linguist#1 <strong>cool</strong>, and #1!</p> 21523 responses: 21524 200: 21525 body: 21526 text/html: 21527 example: | 21528 <p>Hello world github/linguist#1 <strong>cool</strong>, and #1!</p> 21529/networks/{ownerId}/{repoId}/events: 21530 type: collection 21531 uriParameters: 21532 ownerId: 21533 description: Id of the owner. 21534 type: integer 21535 repoId: 21536 description: Id of repository. 21537 type: integer 21538 get: 21539 description: List public events for a network of repositories. 21540 responses: 21541 200: 21542 body: 21543 schema: | 21544 { 21545 "$schema": "http://json-schema.org/draft-03/schema", 21546 "type": "array", 21547 "properties": [ 21548 { 21549 "properties": { 21550 "type": { 21551 "type": "string" 21552 }, 21553 "public": { 21554 "type": "boolean" 21555 }, 21556 "payload": { 21557 "properties": {}, 21558 "type": "object" 21559 }, 21560 "repo": { 21561 "properties": { 21562 "id": { 21563 "type": "integer" 21564 }, 21565 "name": { 21566 "type": "string" 21567 }, 21568 "url": { 21569 "type": "string" 21570 } 21571 }, 21572 "type": "object" 21573 }, 21574 "actor": { 21575 "properties": { 21576 "login": { 21577 "type": "string" 21578 }, 21579 "id": { 21580 "type": "integer" 21581 }, 21582 "avatar_url": { 21583 "type": "string" 21584 }, 21585 "gravatar_id": { 21586 "type": "string" 21587 }, 21588 "url": { 21589 "type": "string" 21590 } 21591 }, 21592 "type": "object" 21593 }, 21594 "org": { 21595 "properties": { 21596 "login": { 21597 "type": "string" 21598 }, 21599 "id": { 21600 "type": "integer" 21601 }, 21602 "avatar_url": { 21603 "type": "string" 21604 }, 21605 "gravatar_id": { 21606 "type": "string" 21607 }, 21608 "url": { 21609 "type": "string" 21610 } 21611 }, 21612 "type": "object" 21613 }, 21614 "created_at": { 21615 "type": "timestamp" 21616 }, 21617 "id": { 21618 "type": "integer" 21619 } 21620 }, 21621 "type": "object" 21622 } 21623 ] 21624 } 21625 example: | 21626 [ 21627 { 21628 "type": "Event", 21629 "public": true, 21630 "payload": { 21631 21632 }, 21633 "repo": { 21634 "id": 3, 21635 "name": "octocat/Hello-World", 21636 "url": "https://api.github.com/repos/octocat/Hello-World" 21637 }, 21638 "actor": { 21639 "login": "octocat", 21640 "id": 1, 21641 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 21642 "gravatar_id": "somehexcode", 21643 "url": "https://api.github.com/users/octocat" 21644 }, 21645 "org": { 21646 "login": "octocat", 21647 "id": 1, 21648 "avatar_url": "https://github.com/images/error/octocat_happy.gif", 21649 "gravatar_id": "somehexcode", 21650 "url": "https://api.github.com/users/octocat" 21651 }, 21652 "created_at": "2011-09-06T17:26:27Z", 21653 "id": "12345" 21654 } 21655 ] 21656
