1{ 2 "consumes": [ 3 "application/json", 4 "text/plain" 5 ], 6 "produces": [ 7 "application/json", 8 "text/html" 9 ], 10 "schemes": [ 11 "http", 12 "https" 13 ], 14 "swagger": "2.0", 15 "info": { 16 "description": "This documentation describes the Gitea API.", 17 "title": "Gitea API.", 18 "license": { 19 "name": "MIT", 20 "url": "http://opensource.org/licenses/MIT" 21 }, 22 "version": "1.1.1" 23 }, 24 "basePath": "/api/v1", 25 "paths": { 26 "/admin/users": { 27 "post": { 28 "consumes": [ 29 "application/json" 30 ], 31 "produces": [ 32 "application/json" 33 ], 34 "tags": [ 35 "admin" 36 ], 37 "summary": "Create a user", 38 "operationId": "adminCreateUser", 39 "parameters": [ 40 { 41 "name": "body", 42 "in": "body", 43 "schema": { 44 "$ref": "#/definitions/CreateUserOption" 45 } 46 } 47 ], 48 "responses": { 49 "201": { 50 "$ref": "#/responses/User" 51 }, 52 "403": { 53 "$ref": "#/responses/forbidden" 54 }, 55 "422": { 56 "$ref": "#/responses/validationError" 57 } 58 } 59 } 60 }, 61 "/admin/users/{username}": { 62 "delete": { 63 "produces": [ 64 "application/json" 65 ], 66 "tags": [ 67 "admin" 68 ], 69 "summary": "Delete a user", 70 "operationId": "adminDeleteUser", 71 "parameters": [ 72 { 73 "type": "string", 74 "description": "username of user to delete", 75 "name": "username", 76 "in": "path", 77 "required": true 78 } 79 ], 80 "responses": { 81 "204": { 82 "$ref": "#/responses/empty" 83 }, 84 "403": { 85 "$ref": "#/responses/forbidden" 86 }, 87 "422": { 88 "$ref": "#/responses/validationError" 89 } 90 } 91 }, 92 "patch": { 93 "consumes": [ 94 "application/json" 95 ], 96 "produces": [ 97 "application/json" 98 ], 99 "tags": [ 100 "admin" 101 ], 102 "summary": "Edit an existing user", 103 "operationId": "adminEditUser", 104 "parameters": [ 105 { 106 "type": "string", 107 "description": "username of user to edit", 108 "name": "username", 109 "in": "path", 110 "required": true 111 }, 112 { 113 "name": "body", 114 "in": "body", 115 "schema": { 116 "$ref": "#/definitions/EditUserOption" 117 } 118 } 119 ], 120 "responses": { 121 "200": { 122 "$ref": "#/responses/User" 123 }, 124 "403": { 125 "$ref": "#/responses/forbidden" 126 }, 127 "422": { 128 "$ref": "#/responses/validationError" 129 } 130 } 131 } 132 }, 133 "/admin/users/{username}/keys": { 134 "post": { 135 "consumes": [ 136 "application/json" 137 ], 138 "produces": [ 139 "application/json" 140 ], 141 "tags": [ 142 "admin" 143 ], 144 "summary": "Add a public key on behalf of a user", 145 "operationId": "adminCreatePublicKey", 146 "parameters": [ 147 { 148 "type": "string", 149 "description": "username of the user", 150 "name": "username", 151 "in": "path", 152 "required": true 153 } 154 ], 155 "responses": { 156 "201": { 157 "$ref": "#/responses/PublicKey" 158 }, 159 "403": { 160 "$ref": "#/responses/forbidden" 161 }, 162 "422": { 163 "$ref": "#/responses/validationError" 164 } 165 } 166 } 167 }, 168 "/admin/users/{username}/keys/{id}": { 169 "delete": { 170 "produces": [ 171 "application/json" 172 ], 173 "tags": [ 174 "admin" 175 ], 176 "summary": "Delete a user's public key", 177 "operationId": "adminDeleteUserPublicKey", 178 "parameters": [ 179 { 180 "type": "string", 181 "description": "username of user", 182 "name": "username", 183 "in": "path", 184 "required": true 185 }, 186 { 187 "type": "integer", 188 "description": "id of the key to delete", 189 "name": "id", 190 "in": "path", 191 "required": true 192 } 193 ], 194 "responses": { 195 "204": { 196 "$ref": "#/responses/empty" 197 }, 198 "403": { 199 "$ref": "#/responses/forbidden" 200 }, 201 "404": { 202 "$ref": "#/responses/notFound" 203 } 204 } 205 } 206 }, 207 "/admin/users/{username}/orgs": { 208 "post": { 209 "consumes": [ 210 "application/json" 211 ], 212 "produces": [ 213 "application/json" 214 ], 215 "tags": [ 216 "admin" 217 ], 218 "summary": "Create an organization", 219 "operationId": "adminCreateOrg", 220 "parameters": [ 221 { 222 "type": "string", 223 "description": "username of the user that will own the created organization", 224 "name": "username", 225 "in": "path", 226 "required": true 227 } 228 ], 229 "responses": { 230 "201": { 231 "$ref": "#/responses/Organization" 232 }, 233 "403": { 234 "$ref": "#/responses/forbidden" 235 }, 236 "422": { 237 "$ref": "#/responses/validationError" 238 } 239 } 240 } 241 }, 242 "/admin/users/{username}/repos": { 243 "post": { 244 "consumes": [ 245 "application/json" 246 ], 247 "produces": [ 248 "application/json" 249 ], 250 "tags": [ 251 "admin" 252 ], 253 "summary": "Create a repository on behalf a user", 254 "operationId": "adminCreateRepo", 255 "parameters": [ 256 { 257 "type": "string", 258 "description": "username of the user. This user will own the created repository", 259 "name": "username", 260 "in": "path", 261 "required": true 262 } 263 ], 264 "responses": { 265 "201": { 266 "$ref": "#/responses/Repository" 267 }, 268 "403": { 269 "$ref": "#/responses/forbidden" 270 }, 271 "422": { 272 "$ref": "#/responses/validationError" 273 } 274 } 275 } 276 }, 277 "/markdown": { 278 "post": { 279 "consumes": [ 280 "application/json" 281 ], 282 "produces": [ 283 "text/html" 284 ], 285 "tags": [ 286 "miscellaneous" 287 ], 288 "summary": "Render a markdown document as HTML", 289 "operationId": "renderMarkdown", 290 "parameters": [ 291 { 292 "name": "body", 293 "in": "body", 294 "schema": { 295 "$ref": "#/definitions/MarkdownOption" 296 } 297 } 298 ], 299 "responses": { 300 "200": { 301 "$ref": "#/responses/MarkdownRender" 302 }, 303 "422": { 304 "$ref": "#/responses/validationError" 305 } 306 } 307 } 308 }, 309 "/markdown/raw": { 310 "post": { 311 "consumes": [ 312 "text/plain" 313 ], 314 "produces": [ 315 "text/html" 316 ], 317 "tags": [ 318 "miscellaneous" 319 ], 320 "summary": "Render raw markdown as HTML", 321 "operationId": "renderMarkdownRaw", 322 "parameters": [ 323 { 324 "description": "Request body to render", 325 "name": "body", 326 "in": "body", 327 "required": true, 328 "schema": { 329 "type": "string" 330 } 331 } 332 ], 333 "responses": { 334 "200": { 335 "$ref": "#/responses/MarkdownRender" 336 }, 337 "422": { 338 "$ref": "#/responses/validationError" 339 } 340 } 341 } 342 }, 343 "/org/{org}/repos": { 344 "post": { 345 "consumes": [ 346 "application/json" 347 ], 348 "produces": [ 349 "application/json" 350 ], 351 "tags": [ 352 "organization" 353 ], 354 "summary": "Create a repository in an organization", 355 "operationId": "createOrgRepo", 356 "parameters": [ 357 { 358 "type": "string", 359 "description": "name of organization", 360 "name": "org", 361 "in": "path", 362 "required": true 363 }, 364 { 365 "name": "body", 366 "in": "body", 367 "schema": { 368 "$ref": "#/definitions/CreateRepoOption" 369 } 370 } 371 ], 372 "responses": { 373 "201": { 374 "$ref": "#/responses/Repository" 375 }, 376 "403": { 377 "$ref": "#/responses/forbidden" 378 }, 379 "422": { 380 "$ref": "#/responses/validationError" 381 } 382 } 383 } 384 }, 385 "/orgs/{org}": { 386 "get": { 387 "produces": [ 388 "application/json" 389 ], 390 "tags": [ 391 "organization" 392 ], 393 "summary": "Get an organization", 394 "operationId": "orgGet", 395 "parameters": [ 396 { 397 "type": "string", 398 "description": "name of the organization to get", 399 "name": "org", 400 "in": "path", 401 "required": true 402 } 403 ], 404 "responses": { 405 "200": { 406 "$ref": "#/responses/Organization" 407 } 408 } 409 }, 410 "patch": { 411 "consumes": [ 412 "application/json" 413 ], 414 "produces": [ 415 "application/json" 416 ], 417 "tags": [ 418 "organization" 419 ], 420 "summary": "Edit an organization", 421 "operationId": "orgEdit", 422 "parameters": [ 423 { 424 "type": "string", 425 "description": "name of the organization to edit", 426 "name": "org", 427 "in": "path", 428 "required": true 429 }, 430 { 431 "name": "body", 432 "in": "body", 433 "schema": { 434 "$ref": "#/definitions/EditOrgOption" 435 } 436 } 437 ], 438 "responses": { 439 "200": { 440 "$ref": "#/responses/Organization" 441 } 442 } 443 } 444 }, 445 "/orgs/{org}/hooks": { 446 "get": { 447 "produces": [ 448 "application/json" 449 ], 450 "tags": [ 451 "organization" 452 ], 453 "summary": "List an organization's webhooks", 454 "operationId": "orgListHooks", 455 "parameters": [ 456 { 457 "type": "string", 458 "description": "name of the organization", 459 "name": "org", 460 "in": "path", 461 "required": true 462 } 463 ], 464 "responses": { 465 "200": { 466 "$ref": "#/responses/HookList" 467 } 468 } 469 } 470 }, 471 "/orgs/{org}/hooks/": { 472 "post": { 473 "consumes": [ 474 "application/json" 475 ], 476 "produces": [ 477 "application/json" 478 ], 479 "tags": [ 480 "organization" 481 ], 482 "summary": "Create a hook", 483 "operationId": "orgCreateHook", 484 "parameters": [ 485 { 486 "type": "string", 487 "description": "name of the organization", 488 "name": "org", 489 "in": "path", 490 "required": true 491 } 492 ], 493 "responses": { 494 "201": { 495 "$ref": "#/responses/Hook" 496 } 497 } 498 } 499 }, 500 "/orgs/{org}/hooks/{id}": { 501 "get": { 502 "produces": [ 503 "application/json" 504 ], 505 "tags": [ 506 "organization" 507 ], 508 "summary": "Get a hook", 509 "operationId": "orgGetHook", 510 "parameters": [ 511 { 512 "type": "string", 513 "description": "name of the organization", 514 "name": "org", 515 "in": "path", 516 "required": true 517 }, 518 { 519 "type": "integer", 520 "description": "id of the hook to get", 521 "name": "id", 522 "in": "path", 523 "required": true 524 } 525 ], 526 "responses": { 527 "200": { 528 "$ref": "#/responses/Hook" 529 } 530 } 531 }, 532 "delete": { 533 "produces": [ 534 "application/json" 535 ], 536 "tags": [ 537 "organization" 538 ], 539 "summary": "Delete a hook", 540 "operationId": "orgDeleteHook", 541 "parameters": [ 542 { 543 "type": "string", 544 "description": "name of the organization", 545 "name": "org", 546 "in": "path", 547 "required": true 548 }, 549 { 550 "type": "integer", 551 "description": "id of the hook to delete", 552 "name": "id", 553 "in": "path", 554 "required": true 555 } 556 ], 557 "responses": { 558 "204": { 559 "$ref": "#/responses/empty" 560 } 561 } 562 }, 563 "patch": { 564 "consumes": [ 565 "application/json" 566 ], 567 "produces": [ 568 "application/json" 569 ], 570 "tags": [ 571 "organization" 572 ], 573 "summary": "Update a hook", 574 "operationId": "orgEditHook", 575 "parameters": [ 576 { 577 "type": "string", 578 "description": "name of the organization", 579 "name": "org", 580 "in": "path", 581 "required": true 582 }, 583 { 584 "type": "integer", 585 "description": "id of the hook to update", 586 "name": "id", 587 "in": "path", 588 "required": true 589 } 590 ], 591 "responses": { 592 "200": { 593 "$ref": "#/responses/Hook" 594 } 595 } 596 } 597 }, 598 "/orgs/{org}/members": { 599 "get": { 600 "produces": [ 601 "application/json" 602 ], 603 "tags": [ 604 "organization" 605 ], 606 "summary": "List an organization's members", 607 "operationId": "orgListMembers", 608 "parameters": [ 609 { 610 "type": "string", 611 "description": "name of the organization", 612 "name": "org", 613 "in": "path", 614 "required": true 615 } 616 ], 617 "responses": { 618 "200": { 619 "$ref": "#/responses/UserList" 620 } 621 } 622 } 623 }, 624 "/orgs/{org}/members/{username}": { 625 "get": { 626 "tags": [ 627 "organization" 628 ], 629 "summary": "Check if a user is a member of an organization", 630 "operationId": "orgIsMember", 631 "parameters": [ 632 { 633 "type": "string", 634 "description": "name of the organization", 635 "name": "org", 636 "in": "path", 637 "required": true 638 }, 639 { 640 "type": "string", 641 "description": "username of the user", 642 "name": "username", 643 "in": "path", 644 "required": true 645 } 646 ], 647 "responses": { 648 "204": { 649 "description": "user is a member", 650 "schema": { 651 "$ref": "#/responses/empty" 652 } 653 }, 654 "404": { 655 "description": "user is not a member", 656 "schema": { 657 "$ref": "#/responses/empty" 658 } 659 } 660 } 661 }, 662 "delete": { 663 "produces": [ 664 "application/json" 665 ], 666 "tags": [ 667 "organization" 668 ], 669 "summary": "Remove a member from an organization", 670 "operationId": "orgDeleteMember", 671 "parameters": [ 672 { 673 "type": "string", 674 "description": "name of the organization", 675 "name": "org", 676 "in": "path", 677 "required": true 678 }, 679 { 680 "type": "string", 681 "description": "username of the user", 682 "name": "username", 683 "in": "path", 684 "required": true 685 } 686 ], 687 "responses": { 688 "204": { 689 "description": "member removed", 690 "schema": { 691 "$ref": "#/responses/empty" 692 } 693 } 694 } 695 } 696 }, 697 "/orgs/{org}/public_members": { 698 "get": { 699 "produces": [ 700 "application/json" 701 ], 702 "tags": [ 703 "organization" 704 ], 705 "summary": "List an organization's public members", 706 "operationId": "orgListPublicMembers", 707 "parameters": [ 708 { 709 "type": "string", 710 "description": "name of the organization", 711 "name": "org", 712 "in": "path", 713 "required": true 714 } 715 ], 716 "responses": { 717 "200": { 718 "$ref": "#/responses/UserList" 719 } 720 } 721 } 722 }, 723 "/orgs/{org}/public_members/{username}": { 724 "get": { 725 "tags": [ 726 "organization" 727 ], 728 "summary": "Check if a user is a public member of an organization", 729 "operationId": "orgIsPublicMember", 730 "parameters": [ 731 { 732 "type": "string", 733 "description": "name of the organization", 734 "name": "org", 735 "in": "path", 736 "required": true 737 }, 738 { 739 "type": "string", 740 "description": "username of the user", 741 "name": "username", 742 "in": "path", 743 "required": true 744 } 745 ], 746 "responses": { 747 "204": { 748 "description": "user is a public member", 749 "schema": { 750 "$ref": "#/responses/empty" 751 } 752 }, 753 "404": { 754 "description": "user is not a public member", 755 "schema": { 756 "$ref": "#/responses/empty" 757 } 758 } 759 } 760 }, 761 "put": { 762 "produces": [ 763 "application/json" 764 ], 765 "tags": [ 766 "organization" 767 ], 768 "summary": "Publicize a user's membership", 769 "operationId": "orgPublicizeMember", 770 "parameters": [ 771 { 772 "type": "string", 773 "description": "name of the organization", 774 "name": "org", 775 "in": "path", 776 "required": true 777 }, 778 { 779 "type": "string", 780 "description": "username of the user", 781 "name": "username", 782 "in": "path", 783 "required": true 784 } 785 ], 786 "responses": { 787 "204": { 788 "description": "membership publicized", 789 "schema": { 790 "$ref": "#/responses/empty" 791 } 792 } 793 } 794 }, 795 "delete": { 796 "produces": [ 797 "application/json" 798 ], 799 "tags": [ 800 "organization" 801 ], 802 "summary": "Conceal a user's membership", 803 "operationId": "orgConcealMember", 804 "parameters": [ 805 { 806 "type": "string", 807 "description": "name of the organization", 808 "name": "org", 809 "in": "path", 810 "required": true 811 }, 812 { 813 "type": "string", 814 "description": "username of the user", 815 "name": "username", 816 "in": "path", 817 "required": true 818 } 819 ], 820 "responses": { 821 "204": { 822 "$ref": "#/responses/empty" 823 } 824 } 825 } 826 }, 827 "/orgs/{org}/repos": { 828 "get": { 829 "produces": [ 830 "application/json" 831 ], 832 "tags": [ 833 "organization" 834 ], 835 "summary": "List an organization's repos", 836 "operationId": "orgListRepos", 837 "parameters": [ 838 { 839 "type": "string", 840 "description": "name of the organization", 841 "name": "org", 842 "in": "path", 843 "required": true 844 } 845 ], 846 "responses": { 847 "200": { 848 "$ref": "#/responses/RepositoryList" 849 } 850 } 851 } 852 }, 853 "/orgs/{org}/teams": { 854 "get": { 855 "produces": [ 856 "application/json" 857 ], 858 "tags": [ 859 "organization" 860 ], 861 "summary": "List an organization's teams", 862 "operationId": "orgListTeams", 863 "parameters": [ 864 { 865 "type": "string", 866 "description": "name of the organization", 867 "name": "org", 868 "in": "path", 869 "required": true 870 } 871 ], 872 "responses": { 873 "200": { 874 "$ref": "#/responses/TeamList" 875 } 876 } 877 }, 878 "post": { 879 "consumes": [ 880 "application/json" 881 ], 882 "produces": [ 883 "application/json" 884 ], 885 "tags": [ 886 "organization" 887 ], 888 "summary": "Create a team", 889 "operationId": "orgCreateTeam", 890 "parameters": [ 891 { 892 "type": "string", 893 "description": "name of the organization", 894 "name": "org", 895 "in": "path", 896 "required": true 897 }, 898 { 899 "name": "body", 900 "in": "body", 901 "schema": { 902 "$ref": "#/definitions/CreateTeamOption" 903 } 904 } 905 ], 906 "responses": { 907 "201": { 908 "$ref": "#/responses/Team" 909 } 910 } 911 } 912 }, 913 "/repos/migrate": { 914 "post": { 915 "consumes": [ 916 "application/json" 917 ], 918 "produces": [ 919 "application/json" 920 ], 921 "tags": [ 922 "repository" 923 ], 924 "summary": "Migrate a remote git repository", 925 "operationId": "repoMigrate", 926 "parameters": [ 927 { 928 "name": "body", 929 "in": "body", 930 "schema": { 931 "$ref": "#/definitions/MigrateRepoForm" 932 } 933 } 934 ], 935 "responses": { 936 "201": { 937 "$ref": "#/responses/Repository" 938 } 939 } 940 } 941 }, 942 "/repos/search": { 943 "get": { 944 "produces": [ 945 "application/json" 946 ], 947 "tags": [ 948 "repository" 949 ], 950 "summary": "Search for repositories", 951 "operationId": "repoSearch", 952 "parameters": [ 953 { 954 "type": "string", 955 "description": "keyword", 956 "name": "q", 957 "in": "query" 958 }, 959 { 960 "type": "integer", 961 "description": "search only for repos that the user with the given id owns or contributes to", 962 "name": "uid", 963 "in": "query" 964 }, 965 { 966 "type": "integer", 967 "description": "page number of results to return (1-based)", 968 "name": "page", 969 "in": "query" 970 }, 971 { 972 "type": "integer", 973 "description": "page size of results, maximum page size is 50", 974 "name": "limit", 975 "in": "query" 976 }, 977 { 978 "type": "string", 979 "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"", 980 "name": "mode", 981 "in": "query" 982 }, 983 { 984 "type": "boolean", 985 "description": "if `uid` is given, search only for repos that the user owns", 986 "name": "exclusive", 987 "in": "query" 988 } 989 ], 990 "responses": { 991 "200": { 992 "$ref": "#/responses/SearchResults" 993 }, 994 "422": { 995 "$ref": "#/responses/validationError" 996 } 997 } 998 } 999 }, 1000 "/repos/{owner}/{repo}": { 1001 "get": { 1002 "produces": [ 1003 "application/json" 1004 ], 1005 "tags": [ 1006 "repository" 1007 ], 1008 "summary": "Get a repository", 1009 "operationId": "repoGet", 1010 "parameters": [ 1011 { 1012 "type": "string", 1013 "description": "owner of the repo", 1014 "name": "owner", 1015 "in": "path", 1016 "required": true 1017 }, 1018 { 1019 "type": "string", 1020 "description": "name of the repo", 1021 "name": "repo", 1022 "in": "path", 1023 "required": true 1024 } 1025 ], 1026 "responses": { 1027 "200": { 1028 "$ref": "#/responses/Repository" 1029 } 1030 } 1031 }, 1032 "delete": { 1033 "produces": [ 1034 "application/json" 1035 ], 1036 "tags": [ 1037 "repository" 1038 ], 1039 "summary": "Delete a repository", 1040 "operationId": "repoDelete", 1041 "parameters": [ 1042 { 1043 "type": "string", 1044 "description": "owner of the repo to delete", 1045 "name": "owner", 1046 "in": "path", 1047 "required": true 1048 }, 1049 { 1050 "type": "string", 1051 "description": "name of the repo to delete", 1052 "name": "repo", 1053 "in": "path", 1054 "required": true 1055 } 1056 ], 1057 "responses": { 1058 "204": { 1059 "$ref": "#/responses/empty" 1060 }, 1061 "403": { 1062 "$ref": "#/responses/forbidden" 1063 } 1064 } 1065 } 1066 }, 1067 "/repos/{owner}/{repo}/archive/{archive}": { 1068 "get": { 1069 "produces": [ 1070 "application/json" 1071 ], 1072 "tags": [ 1073 "repository" 1074 ], 1075 "summary": "Get an archive of a repository", 1076 "operationId": "repoGetArchive", 1077 "parameters": [ 1078 { 1079 "type": "string", 1080 "description": "owner of the repo", 1081 "name": "owner", 1082 "in": "path", 1083 "required": true 1084 }, 1085 { 1086 "type": "string", 1087 "description": "name of the repo", 1088 "name": "repo", 1089 "in": "path", 1090 "required": true 1091 }, 1092 { 1093 "type": "string", 1094 "description": "archive to download, consisting of a git reference and archive", 1095 "name": "archive", 1096 "in": "path", 1097 "required": true 1098 } 1099 ], 1100 "responses": { 1101 "200": { 1102 "description": "success" 1103 } 1104 } 1105 } 1106 }, 1107 "/repos/{owner}/{repo}/branches": { 1108 "get": { 1109 "produces": [ 1110 "application/json" 1111 ], 1112 "tags": [ 1113 "repository" 1114 ], 1115 "summary": "List a repository's branches", 1116 "operationId": "repoListBranches", 1117 "parameters": [ 1118 { 1119 "type": "string", 1120 "description": "owner of the repo", 1121 "name": "owner", 1122 "in": "path", 1123 "required": true 1124 }, 1125 { 1126 "type": "string", 1127 "description": "name of the repo", 1128 "name": "repo", 1129 "in": "path", 1130 "required": true 1131 } 1132 ], 1133 "responses": { 1134 "200": { 1135 "$ref": "#/responses/BranchList" 1136 } 1137 } 1138 } 1139 }, 1140 "/repos/{owner}/{repo}/branches/{branch}": { 1141 "get": { 1142 "produces": [ 1143 "application/json" 1144 ], 1145 "tags": [ 1146 "repository" 1147 ], 1148 "summary": "List a repository's branches", 1149 "operationId": "repoGetBranch", 1150 "parameters": [ 1151 { 1152 "type": "string", 1153 "description": "owner of the repo", 1154 "name": "owner", 1155 "in": "path", 1156 "required": true 1157 }, 1158 { 1159 "type": "string", 1160 "description": "name of the repo", 1161 "name": "repo", 1162 "in": "path", 1163 "required": true 1164 }, 1165 { 1166 "type": "string", 1167 "description": "branch to get", 1168 "name": "branch", 1169 "in": "path", 1170 "required": true 1171 } 1172 ], 1173 "responses": { 1174 "200": { 1175 "$ref": "#/responses/Branch" 1176 } 1177 } 1178 } 1179 }, 1180 "/repos/{owner}/{repo}/collaborators": { 1181 "get": { 1182 "produces": [ 1183 "application/json" 1184 ], 1185 "tags": [ 1186 "repository" 1187 ], 1188 "summary": "List a repository's collaborators", 1189 "operationId": "repoListCollaborators", 1190 "parameters": [ 1191 { 1192 "type": "string", 1193 "description": "owner of the repo", 1194 "name": "owner", 1195 "in": "path", 1196 "required": true 1197 }, 1198 { 1199 "type": "string", 1200 "description": "name of the repo", 1201 "name": "repo", 1202 "in": "path", 1203 "required": true 1204 } 1205 ], 1206 "responses": { 1207 "200": { 1208 "$ref": "#/responses/UserList" 1209 } 1210 } 1211 } 1212 }, 1213 "/repos/{owner}/{repo}/collaborators/{collaborator}": { 1214 "get": { 1215 "produces": [ 1216 "application/json" 1217 ], 1218 "tags": [ 1219 "repository" 1220 ], 1221 "summary": "Check if a user is a collaborator of a repository", 1222 "operationId": "repoCheckCollaborator", 1223 "parameters": [ 1224 { 1225 "type": "string", 1226 "description": "owner of the repo", 1227 "name": "owner", 1228 "in": "path", 1229 "required": true 1230 }, 1231 { 1232 "type": "string", 1233 "description": "name of the repo", 1234 "name": "repo", 1235 "in": "path", 1236 "required": true 1237 }, 1238 { 1239 "type": "string", 1240 "description": "username of the collaborator", 1241 "name": "collaborator", 1242 "in": "path", 1243 "required": true 1244 } 1245 ], 1246 "responses": { 1247 "204": { 1248 "$ref": "#/responses/empty" 1249 }, 1250 "404": { 1251 "$ref": "#/responses/empty" 1252 } 1253 } 1254 }, 1255 "put": { 1256 "produces": [ 1257 "application/json" 1258 ], 1259 "tags": [ 1260 "repository" 1261 ], 1262 "summary": "Add a collaborator to a repository", 1263 "operationId": "repoAddCollaborator", 1264 "parameters": [ 1265 { 1266 "type": "string", 1267 "description": "owner of the repo", 1268 "name": "owner", 1269 "in": "path", 1270 "required": true 1271 }, 1272 { 1273 "type": "string", 1274 "description": "name of the repo", 1275 "name": "repo", 1276 "in": "path", 1277 "required": true 1278 }, 1279 { 1280 "type": "string", 1281 "description": "username of the collaborator to add", 1282 "name": "collaborator", 1283 "in": "path", 1284 "required": true 1285 }, 1286 { 1287 "name": "body", 1288 "in": "body", 1289 "schema": { 1290 "$ref": "#/definitions/AddCollaboratorOption" 1291 } 1292 } 1293 ], 1294 "responses": { 1295 "204": { 1296 "$ref": "#/responses/empty" 1297 } 1298 } 1299 }, 1300 "delete": { 1301 "produces": [ 1302 "application/json" 1303 ], 1304 "tags": [ 1305 "repository" 1306 ], 1307 "summary": "Delete a collaborator from a repository", 1308 "operationId": "repoDeleteCollaborator", 1309 "parameters": [ 1310 { 1311 "type": "string", 1312 "description": "owner of the repo", 1313 "name": "owner", 1314 "in": "path", 1315 "required": true 1316 }, 1317 { 1318 "type": "string", 1319 "description": "name of the repo", 1320 "name": "repo", 1321 "in": "path", 1322 "required": true 1323 }, 1324 { 1325 "type": "string", 1326 "description": "username of the collaborator to delete", 1327 "name": "collaborator", 1328 "in": "path", 1329 "required": true 1330 } 1331 ], 1332 "responses": { 1333 "204": { 1334 "$ref": "#/responses/empty" 1335 } 1336 } 1337 } 1338 }, 1339 "/repos/{owner}/{repo}/commits/{ref}/statuses": { 1340 "get": { 1341 "produces": [ 1342 "application/json" 1343 ], 1344 "tags": [ 1345 "repository" 1346 ], 1347 "summary": "Get a commit's combined status, by branch/tag/commit reference", 1348 "operationId": "repoGetCombinedStatusByRef", 1349 "parameters": [ 1350 { 1351 "type": "string", 1352 "description": "owner of the repo", 1353 "name": "owner", 1354 "in": "path", 1355 "required": true 1356 }, 1357 { 1358 "type": "string", 1359 "description": "name of the repo", 1360 "name": "repo", 1361 "in": "path", 1362 "required": true 1363 }, 1364 { 1365 "type": "string", 1366 "description": "name of branch/tag/commit", 1367 "name": "ref", 1368 "in": "path", 1369 "required": true 1370 } 1371 ], 1372 "responses": { 1373 "200": { 1374 "$ref": "#/responses/Status" 1375 } 1376 } 1377 } 1378 }, 1379 "/repos/{owner}/{repo}/editorconfig/{filepath}": { 1380 "get": { 1381 "produces": [ 1382 "application/json" 1383 ], 1384 "tags": [ 1385 "repository" 1386 ], 1387 "summary": "Get the EditorConfig definitions of a file in a repository", 1388 "operationId": "repoGetEditorConfig", 1389 "parameters": [ 1390 { 1391 "type": "string", 1392 "description": "owner of the repo", 1393 "name": "owner", 1394 "in": "path", 1395 "required": true 1396 }, 1397 { 1398 "type": "string", 1399 "description": "name of the repo", 1400 "name": "repo", 1401 "in": "path", 1402 "required": true 1403 }, 1404 { 1405 "type": "string", 1406 "description": "filepath of file to get", 1407 "name": "filepath", 1408 "in": "path", 1409 "required": true 1410 } 1411 ], 1412 "responses": { 1413 "200": { 1414 "description": "success" 1415 } 1416 } 1417 } 1418 }, 1419 "/repos/{owner}/{repo}/forks": { 1420 "get": { 1421 "produces": [ 1422 "application/json" 1423 ], 1424 "tags": [ 1425 "repository" 1426 ], 1427 "summary": "List a repository's forks", 1428 "operationId": "listForks", 1429 "parameters": [ 1430 { 1431 "type": "string", 1432 "description": "owner of the repo", 1433 "name": "owner", 1434 "in": "path", 1435 "required": true 1436 }, 1437 { 1438 "type": "string", 1439 "description": "name of the repo", 1440 "name": "repo", 1441 "in": "path", 1442 "required": true 1443 } 1444 ], 1445 "responses": { 1446 "200": { 1447 "$ref": "#/responses/RepositoryList" 1448 } 1449 } 1450 }, 1451 "post": { 1452 "produces": [ 1453 "application/json" 1454 ], 1455 "tags": [ 1456 "repository" 1457 ], 1458 "summary": "Fork a repository", 1459 "operationId": "createFork", 1460 "parameters": [ 1461 { 1462 "type": "string", 1463 "description": "owner of the repo to fork", 1464 "name": "owner", 1465 "in": "path", 1466 "required": true 1467 }, 1468 { 1469 "type": "string", 1470 "description": "name of the repo to fork", 1471 "name": "repo", 1472 "in": "path", 1473 "required": true 1474 }, 1475 { 1476 "name": "body", 1477 "in": "body", 1478 "schema": { 1479 "$ref": "#/definitions/CreateForkOption" 1480 } 1481 } 1482 ], 1483 "responses": { 1484 "202": { 1485 "$ref": "#/responses/Repository" 1486 } 1487 } 1488 } 1489 }, 1490 "/repos/{owner}/{repo}/hooks": { 1491 "get": { 1492 "produces": [ 1493 "application/json" 1494 ], 1495 "tags": [ 1496 "repository" 1497 ], 1498 "summary": "List the hooks in a repository", 1499 "operationId": "repoListHooks", 1500 "parameters": [ 1501 { 1502 "type": "string", 1503 "description": "owner of the repo", 1504 "name": "owner", 1505 "in": "path", 1506 "required": true 1507 }, 1508 { 1509 "type": "string", 1510 "description": "name of the repo", 1511 "name": "repo", 1512 "in": "path", 1513 "required": true 1514 } 1515 ], 1516 "responses": { 1517 "200": { 1518 "$ref": "#/responses/HookList" 1519 } 1520 } 1521 }, 1522 "post": { 1523 "consumes": [ 1524 "application/json" 1525 ], 1526 "produces": [ 1527 "application/json" 1528 ], 1529 "tags": [ 1530 "repository" 1531 ], 1532 "summary": "Create a hook", 1533 "operationId": "repoCreateHook", 1534 "parameters": [ 1535 { 1536 "type": "string", 1537 "description": "owner of the repo", 1538 "name": "owner", 1539 "in": "path", 1540 "required": true 1541 }, 1542 { 1543 "type": "string", 1544 "description": "name of the repo", 1545 "name": "repo", 1546 "in": "path", 1547 "required": true 1548 }, 1549 { 1550 "name": "body", 1551 "in": "body", 1552 "schema": { 1553 "$ref": "#/definitions/CreateHookOption" 1554 } 1555 } 1556 ], 1557 "responses": { 1558 "201": { 1559 "$ref": "#/responses/Hook" 1560 } 1561 } 1562 } 1563 }, 1564 "/repos/{owner}/{repo}/hooks/{id}": { 1565 "get": { 1566 "produces": [ 1567 "application/json" 1568 ], 1569 "tags": [ 1570 "repository" 1571 ], 1572 "summary": "Get a hook", 1573 "operationId": "repoGetHook", 1574 "parameters": [ 1575 { 1576 "type": "string", 1577 "description": "owner of the repo", 1578 "name": "owner", 1579 "in": "path", 1580 "required": true 1581 }, 1582 { 1583 "type": "string", 1584 "description": "name of the repo", 1585 "name": "repo", 1586 "in": "path", 1587 "required": true 1588 }, 1589 { 1590 "type": "integer", 1591 "description": "id of the hook to get", 1592 "name": "id", 1593 "in": "path", 1594 "required": true 1595 } 1596 ], 1597 "responses": { 1598 "200": { 1599 "$ref": "#/responses/Hook" 1600 } 1601 } 1602 }, 1603 "delete": { 1604 "produces": [ 1605 "application/json" 1606 ], 1607 "tags": [ 1608 "repository" 1609 ], 1610 "summary": "Delete a hook in a repository", 1611 "operationId": "repoDeleteHook", 1612 "parameters": [ 1613 { 1614 "type": "string", 1615 "description": "owner of the repo", 1616 "name": "owner", 1617 "in": "path", 1618 "required": true 1619 }, 1620 { 1621 "type": "string", 1622 "description": "name of the repo", 1623 "name": "repo", 1624 "in": "path", 1625 "required": true 1626 }, 1627 { 1628 "type": "integer", 1629 "description": "id of the hook to delete", 1630 "name": "id", 1631 "in": "path", 1632 "required": true 1633 } 1634 ], 1635 "responses": { 1636 "204": { 1637 "$ref": "#/responses/empty" 1638 }, 1639 "404": { 1640 "$ref": "#/responses/notFound" 1641 } 1642 } 1643 }, 1644 "patch": { 1645 "produces": [ 1646 "application/json" 1647 ], 1648 "tags": [ 1649 "repository" 1650 ], 1651 "summary": "Edit a hook in a repository", 1652 "operationId": "repoEditHook", 1653 "parameters": [ 1654 { 1655 "type": "string", 1656 "description": "owner of the repo", 1657 "name": "owner", 1658 "in": "path", 1659 "required": true 1660 }, 1661 { 1662 "type": "string", 1663 "description": "name of the repo", 1664 "name": "repo", 1665 "in": "path", 1666 "required": true 1667 }, 1668 { 1669 "type": "integer", 1670 "description": "index of the hook", 1671 "name": "id", 1672 "in": "path", 1673 "required": true 1674 }, 1675 { 1676 "name": "body", 1677 "in": "body", 1678 "schema": { 1679 "$ref": "#/definitions/EditHookOption" 1680 } 1681 } 1682 ], 1683 "responses": { 1684 "200": { 1685 "$ref": "#/responses/Hook" 1686 } 1687 } 1688 } 1689 }, 1690 "/repos/{owner}/{repo}/hooks/{id}/tests": { 1691 "post": { 1692 "produces": [ 1693 "application/json" 1694 ], 1695 "tags": [ 1696 "repository" 1697 ], 1698 "summary": "Test a push webhook", 1699 "operationId": "repoTestHook", 1700 "parameters": [ 1701 { 1702 "type": "string", 1703 "description": "owner of the repo", 1704 "name": "owner", 1705 "in": "path", 1706 "required": true 1707 }, 1708 { 1709 "type": "string", 1710 "description": "name of the repo", 1711 "name": "repo", 1712 "in": "path", 1713 "required": true 1714 }, 1715 { 1716 "type": "integer", 1717 "description": "id of the hook to test", 1718 "name": "id", 1719 "in": "path", 1720 "required": true 1721 } 1722 ], 1723 "responses": { 1724 "204": { 1725 "$ref": "#/responses/empty" 1726 } 1727 } 1728 } 1729 }, 1730 "/repos/{owner}/{repo}/issues": { 1731 "get": { 1732 "produces": [ 1733 "application/json" 1734 ], 1735 "tags": [ 1736 "issue" 1737 ], 1738 "summary": "List a repository's issues", 1739 "operationId": "issueListIssues", 1740 "parameters": [ 1741 { 1742 "type": "string", 1743 "description": "owner of the repo", 1744 "name": "owner", 1745 "in": "path", 1746 "required": true 1747 }, 1748 { 1749 "type": "string", 1750 "description": "name of the repo", 1751 "name": "repo", 1752 "in": "path", 1753 "required": true 1754 }, 1755 { 1756 "type": "string", 1757 "description": "whether issue is open or closed", 1758 "name": "state", 1759 "in": "query" 1760 }, 1761 { 1762 "type": "integer", 1763 "description": "page number of requested issues", 1764 "name": "page", 1765 "in": "query" 1766 }, 1767 { 1768 "type": "string", 1769 "description": "search string", 1770 "name": "q", 1771 "in": "query" 1772 } 1773 ], 1774 "responses": { 1775 "200": { 1776 "$ref": "#/responses/IssueList" 1777 } 1778 } 1779 }, 1780 "post": { 1781 "consumes": [ 1782 "application/json" 1783 ], 1784 "produces": [ 1785 "application/json" 1786 ], 1787 "tags": [ 1788 "issue" 1789 ], 1790 "summary": "Create an issue", 1791 "operationId": "issueCreateIssue", 1792 "parameters": [ 1793 { 1794 "type": "string", 1795 "description": "owner of the repo", 1796 "name": "owner", 1797 "in": "path", 1798 "required": true 1799 }, 1800 { 1801 "type": "string", 1802 "description": "name of the repo", 1803 "name": "repo", 1804 "in": "path", 1805 "required": true 1806 }, 1807 { 1808 "name": "body", 1809 "in": "body", 1810 "schema": { 1811 "$ref": "#/definitions/CreateIssueOption" 1812 } 1813 } 1814 ], 1815 "responses": { 1816 "201": { 1817 "$ref": "#/responses/Issue" 1818 } 1819 } 1820 } 1821 }, 1822 "/repos/{owner}/{repo}/issues/comments": { 1823 "get": { 1824 "produces": [ 1825 "application/json" 1826 ], 1827 "tags": [ 1828 "issue" 1829 ], 1830 "summary": "List all comments in a repository", 1831 "operationId": "issueGetRepoComments", 1832 "parameters": [ 1833 { 1834 "type": "string", 1835 "description": "owner of the repo", 1836 "name": "owner", 1837 "in": "path", 1838 "required": true 1839 }, 1840 { 1841 "type": "string", 1842 "description": "name of the repo", 1843 "name": "repo", 1844 "in": "path", 1845 "required": true 1846 }, 1847 { 1848 "type": "string", 1849 "description": "if provided, only comments updated since the provided time are returned.", 1850 "name": "string", 1851 "in": "query" 1852 } 1853 ], 1854 "responses": { 1855 "200": { 1856 "$ref": "#/responses/CommentList" 1857 } 1858 } 1859 } 1860 }, 1861 "/repos/{owner}/{repo}/issues/comments/{id}": { 1862 "delete": { 1863 "tags": [ 1864 "issue" 1865 ], 1866 "summary": "Delete a comment", 1867 "operationId": "issueDeleteComment", 1868 "parameters": [ 1869 { 1870 "type": "string", 1871 "description": "owner of the repo", 1872 "name": "owner", 1873 "in": "path", 1874 "required": true 1875 }, 1876 { 1877 "type": "string", 1878 "description": "name of the repo", 1879 "name": "repo", 1880 "in": "path", 1881 "required": true 1882 }, 1883 { 1884 "type": "integer", 1885 "description": "id of comment to delete", 1886 "name": "id", 1887 "in": "path", 1888 "required": true 1889 } 1890 ], 1891 "responses": { 1892 "204": { 1893 "$ref": "#/responses/empty" 1894 } 1895 } 1896 }, 1897 "patch": { 1898 "consumes": [ 1899 "application/json" 1900 ], 1901 "produces": [ 1902 "application/json" 1903 ], 1904 "tags": [ 1905 "issue" 1906 ], 1907 "summary": "Edit a comment", 1908 "operationId": "issueEditComment", 1909 "parameters": [ 1910 { 1911 "type": "string", 1912 "description": "owner of the repo", 1913 "name": "owner", 1914 "in": "path", 1915 "required": true 1916 }, 1917 { 1918 "type": "string", 1919 "description": "name of the repo", 1920 "name": "repo", 1921 "in": "path", 1922 "required": true 1923 }, 1924 { 1925 "type": "integer", 1926 "description": "id of the comment to edit", 1927 "name": "id", 1928 "in": "path", 1929 "required": true 1930 }, 1931 { 1932 "name": "body", 1933 "in": "body", 1934 "schema": { 1935 "$ref": "#/definitions/EditIssueCommentOption" 1936 } 1937 } 1938 ], 1939 "responses": { 1940 "200": { 1941 "$ref": "#/responses/Comment" 1942 } 1943 } 1944 } 1945 }, 1946 "/repos/{owner}/{repo}/issues/{id}/times": { 1947 "get": { 1948 "produces": [ 1949 "application/json" 1950 ], 1951 "tags": [ 1952 "issue" 1953 ], 1954 "summary": "List an issue's tracked times", 1955 "operationId": "issueTrackedTimes", 1956 "parameters": [ 1957 { 1958 "type": "string", 1959 "description": "owner of the repo", 1960 "name": "owner", 1961 "in": "path", 1962 "required": true 1963 }, 1964 { 1965 "type": "string", 1966 "description": "name of the repo", 1967 "name": "repo", 1968 "in": "path", 1969 "required": true 1970 }, 1971 { 1972 "type": "integer", 1973 "description": "index of the issue", 1974 "name": "id", 1975 "in": "path", 1976 "required": true 1977 } 1978 ], 1979 "responses": { 1980 "200": { 1981 "$ref": "#/responses/TrackedTimeList" 1982 } 1983 } 1984 }, 1985 "post": { 1986 "consumes": [ 1987 "application/json" 1988 ], 1989 "produces": [ 1990 "application/json" 1991 ], 1992 "tags": [ 1993 "issue" 1994 ], 1995 "summary": "Add a tracked time to a issue", 1996 "operationId": "issueAddTime", 1997 "parameters": [ 1998 { 1999 "type": "string", 2000 "description": "owner of the repo", 2001 "name": "owner", 2002 "in": "path", 2003 "required": true 2004 }, 2005 { 2006 "type": "string", 2007 "description": "name of the repo", 2008 "name": "repo", 2009 "in": "path", 2010 "required": true 2011 }, 2012 { 2013 "type": "integer", 2014 "description": "index of the issue to add tracked time to", 2015 "name": "id", 2016 "in": "path", 2017 "required": true 2018 }, 2019 { 2020 "name": "body", 2021 "in": "body", 2022 "schema": { 2023 "$ref": "#/definitions/AddTimeOption" 2024 } 2025 } 2026 ], 2027 "responses": { 2028 "200": { 2029 "$ref": "#/responses/TrackedTime" 2030 }, 2031 "400": { 2032 "$ref": "#/responses/error" 2033 }, 2034 "403": { 2035 "$ref": "#/responses/error" 2036 } 2037 } 2038 } 2039 }, 2040 "/repos/{owner}/{repo}/issues/{index}": { 2041 "get": { 2042 "produces": [ 2043 "application/json" 2044 ], 2045 "tags": [ 2046 "issue" 2047 ], 2048 "summary": "Get an issue", 2049 "operationId": "issueGetIssue", 2050 "parameters": [ 2051 { 2052 "type": "string", 2053 "description": "owner of the repo", 2054 "name": "owner", 2055 "in": "path", 2056 "required": true 2057 }, 2058 { 2059 "type": "string", 2060 "description": "name of the repo", 2061 "name": "repo", 2062 "in": "path", 2063 "required": true 2064 }, 2065 { 2066 "type": "integer", 2067 "description": "index of the issue to get", 2068 "name": "index", 2069 "in": "path", 2070 "required": true 2071 } 2072 ], 2073 "responses": { 2074 "200": { 2075 "$ref": "#/responses/Issue" 2076 } 2077 } 2078 }, 2079 "patch": { 2080 "consumes": [ 2081 "application/json" 2082 ], 2083 "produces": [ 2084 "application/json" 2085 ], 2086 "tags": [ 2087 "issue" 2088 ], 2089 "summary": "Edit an issue", 2090 "operationId": "issueEditIssue", 2091 "parameters": [ 2092 { 2093 "type": "string", 2094 "description": "owner of the repo", 2095 "name": "owner", 2096 "in": "path", 2097 "required": true 2098 }, 2099 { 2100 "type": "string", 2101 "description": "name of the repo", 2102 "name": "repo", 2103 "in": "path", 2104 "required": true 2105 }, 2106 { 2107 "type": "integer", 2108 "description": "index of the issue to edit", 2109 "name": "index", 2110 "in": "path", 2111 "required": true 2112 }, 2113 { 2114 "name": "body", 2115 "in": "body", 2116 "schema": { 2117 "$ref": "#/definitions/EditIssueOption" 2118 } 2119 } 2120 ], 2121 "responses": { 2122 "201": { 2123 "$ref": "#/responses/Issue" 2124 } 2125 } 2126 } 2127 }, 2128 "/repos/{owner}/{repo}/issues/{index}/comments": { 2129 "get": { 2130 "produces": [ 2131 "application/json" 2132 ], 2133 "tags": [ 2134 "issue" 2135 ], 2136 "summary": "List all comments on an issue", 2137 "operationId": "issueGetComments", 2138 "parameters": [ 2139 { 2140 "type": "string", 2141 "description": "owner of the repo", 2142 "name": "owner", 2143 "in": "path", 2144 "required": true 2145 }, 2146 { 2147 "type": "string", 2148 "description": "name of the repo", 2149 "name": "repo", 2150 "in": "path", 2151 "required": true 2152 }, 2153 { 2154 "type": "integer", 2155 "description": "index of the issue", 2156 "name": "index", 2157 "in": "path", 2158 "required": true 2159 }, 2160 { 2161 "type": "string", 2162 "description": "if provided, only comments updated since the specified time are returned.", 2163 "name": "string", 2164 "in": "query" 2165 } 2166 ], 2167 "responses": { 2168 "200": { 2169 "$ref": "#/responses/CommentList" 2170 } 2171 } 2172 }, 2173 "post": { 2174 "consumes": [ 2175 "application/json" 2176 ], 2177 "produces": [ 2178 "application/json" 2179 ], 2180 "tags": [ 2181 "issue" 2182 ], 2183 "summary": "Add a comment to an issue", 2184 "operationId": "issueCreateComment", 2185 "parameters": [ 2186 { 2187 "type": "string", 2188 "description": "owner of the repo", 2189 "name": "owner", 2190 "in": "path", 2191 "required": true 2192 }, 2193 { 2194 "type": "string", 2195 "description": "name of the repo", 2196 "name": "repo", 2197 "in": "path", 2198 "required": true 2199 }, 2200 { 2201 "type": "integer", 2202 "description": "index of the issue", 2203 "name": "index", 2204 "in": "path", 2205 "required": true 2206 }, 2207 { 2208 "name": "body", 2209 "in": "body", 2210 "schema": { 2211 "$ref": "#/definitions/CreateIssueCommentOption" 2212 } 2213 } 2214 ], 2215 "responses": { 2216 "201": { 2217 "$ref": "#/responses/Comment" 2218 } 2219 } 2220 } 2221 }, 2222 "/repos/{owner}/{repo}/issues/{index}/comments/{id}": { 2223 "delete": { 2224 "tags": [ 2225 "issue" 2226 ], 2227 "summary": "Delete a comment", 2228 "operationId": "issueDeleteCommentDeprecated", 2229 "deprecated": true, 2230 "parameters": [ 2231 { 2232 "type": "string", 2233 "description": "owner of the repo", 2234 "name": "owner", 2235 "in": "path", 2236 "required": true 2237 }, 2238 { 2239 "type": "string", 2240 "description": "name of the repo", 2241 "name": "repo", 2242 "in": "path", 2243 "required": true 2244 }, 2245 { 2246 "type": "integer", 2247 "description": "this parameter is ignored", 2248 "name": "index", 2249 "in": "path", 2250 "required": true 2251 }, 2252 { 2253 "type": "integer", 2254 "description": "id of comment to delete", 2255 "name": "id", 2256 "in": "path", 2257 "required": true 2258 } 2259 ], 2260 "responses": { 2261 "204": { 2262 "$ref": "#/responses/empty" 2263 } 2264 } 2265 }, 2266 "patch": { 2267 "consumes": [ 2268 "application/json" 2269 ], 2270 "produces": [ 2271 "application/json" 2272 ], 2273 "tags": [ 2274 "issue" 2275 ], 2276 "summary": "Edit a comment", 2277 "operationId": "issueEditCommentDeprecated", 2278 "deprecated": true, 2279 "parameters": [ 2280 { 2281 "type": "string", 2282 "description": "owner of the repo", 2283 "name": "owner", 2284 "in": "path", 2285 "required": true 2286 }, 2287 { 2288 "type": "string", 2289 "description": "name of the repo", 2290 "name": "repo", 2291 "in": "path", 2292 "required": true 2293 }, 2294 { 2295 "type": "integer", 2296 "description": "this parameter is ignored", 2297 "name": "index", 2298 "in": "path", 2299 "required": true 2300 }, 2301 { 2302 "type": "integer", 2303 "description": "id of the comment to edit", 2304 "name": "id", 2305 "in": "path", 2306 "required": true 2307 }, 2308 { 2309 "name": "body", 2310 "in": "body", 2311 "schema": { 2312 "$ref": "#/definitions/EditIssueCommentOption" 2313 } 2314 } 2315 ], 2316 "responses": { 2317 "200": { 2318 "$ref": "#/responses/Comment" 2319 } 2320 } 2321 } 2322 }, 2323 "/repos/{owner}/{repo}/issues/{index}/labels": { 2324 "get": { 2325 "produces": [ 2326 "application/json" 2327 ], 2328 "tags": [ 2329 "issue" 2330 ], 2331 "summary": "Get an issue's labels", 2332 "operationId": "issueGetLabels", 2333 "parameters": [ 2334 { 2335 "type": "string", 2336 "description": "owner of the repo", 2337 "name": "owner", 2338 "in": "path", 2339 "required": true 2340 }, 2341 { 2342 "type": "string", 2343 "description": "name of the repo", 2344 "name": "repo", 2345 "in": "path", 2346 "required": true 2347 }, 2348 { 2349 "type": "integer", 2350 "description": "index of the issue", 2351 "name": "index", 2352 "in": "path", 2353 "required": true 2354 } 2355 ], 2356 "responses": { 2357 "200": { 2358 "$ref": "#/responses/LabelList" 2359 }, 2360 "404": { 2361 "$ref": "#/responses/notFound" 2362 } 2363 } 2364 }, 2365 "put": { 2366 "consumes": [ 2367 "application/json" 2368 ], 2369 "produces": [ 2370 "application/json" 2371 ], 2372 "tags": [ 2373 "issue" 2374 ], 2375 "summary": "Replace an issue's labels", 2376 "operationId": "issueReplaceLabels", 2377 "parameters": [ 2378 { 2379 "type": "string", 2380 "description": "owner of the repo", 2381 "name": "owner", 2382 "in": "path", 2383 "required": true 2384 }, 2385 { 2386 "type": "string", 2387 "description": "name of the repo", 2388 "name": "repo", 2389 "in": "path", 2390 "required": true 2391 }, 2392 { 2393 "type": "integer", 2394 "description": "index of the issue", 2395 "name": "index", 2396 "in": "path", 2397 "required": true 2398 }, 2399 { 2400 "name": "body", 2401 "in": "body", 2402 "schema": { 2403 "$ref": "#/definitions/IssueLabelsOption" 2404 } 2405 } 2406 ], 2407 "responses": { 2408 "200": { 2409 "$ref": "#/responses/LabelList" 2410 } 2411 } 2412 }, 2413 "post": { 2414 "consumes": [ 2415 "application/json" 2416 ], 2417 "produces": [ 2418 "application/json" 2419 ], 2420 "tags": [ 2421 "issue" 2422 ], 2423 "summary": "Add a label to an issue", 2424 "operationId": "issueAddLabel", 2425 "parameters": [ 2426 { 2427 "type": "string", 2428 "description": "owner of the repo", 2429 "name": "owner", 2430 "in": "path", 2431 "required": true 2432 }, 2433 { 2434 "type": "string", 2435 "description": "name of the repo", 2436 "name": "repo", 2437 "in": "path", 2438 "required": true 2439 }, 2440 { 2441 "type": "integer", 2442 "description": "index of the issue", 2443 "name": "index", 2444 "in": "path", 2445 "required": true 2446 }, 2447 { 2448 "name": "body", 2449 "in": "body", 2450 "schema": { 2451 "$ref": "#/definitions/IssueLabelsOption" 2452 } 2453 } 2454 ], 2455 "responses": { 2456 "200": { 2457 "$ref": "#/responses/LabelList" 2458 } 2459 } 2460 }, 2461 "delete": { 2462 "produces": [ 2463 "application/json" 2464 ], 2465 "tags": [ 2466 "issue" 2467 ], 2468 "summary": "Remove all labels from an issue", 2469 "operationId": "issueClearLabels", 2470 "parameters": [ 2471 { 2472 "type": "string", 2473 "description": "owner of the repo", 2474 "name": "owner", 2475 "in": "path", 2476 "required": true 2477 }, 2478 { 2479 "type": "string", 2480 "description": "name of the repo", 2481 "name": "repo", 2482 "in": "path", 2483 "required": true 2484 }, 2485 { 2486 "type": "integer", 2487 "description": "index of the issue", 2488 "name": "index", 2489 "in": "path", 2490 "required": true 2491 } 2492 ], 2493 "responses": { 2494 "204": { 2495 "$ref": "#/responses/empty" 2496 } 2497 } 2498 } 2499 }, 2500 "/repos/{owner}/{repo}/issues/{index}/labels/{id}": { 2501 "delete": { 2502 "produces": [ 2503 "application/json" 2504 ], 2505 "tags": [ 2506 "issue" 2507 ], 2508 "summary": "Remove a label from an issue", 2509 "operationId": "issueRemoveLabel", 2510 "parameters": [ 2511 { 2512 "type": "string", 2513 "description": "owner of the repo", 2514 "name": "owner", 2515 "in": "path", 2516 "required": true 2517 }, 2518 { 2519 "type": "string", 2520 "description": "name of the repo", 2521 "name": "repo", 2522 "in": "path", 2523 "required": true 2524 }, 2525 { 2526 "type": "integer", 2527 "description": "index of the issue", 2528 "name": "index", 2529 "in": "path", 2530 "required": true 2531 }, 2532 { 2533 "type": "integer", 2534 "description": "id of the label to remove", 2535 "name": "id", 2536 "in": "path", 2537 "required": true 2538 } 2539 ], 2540 "responses": { 2541 "204": { 2542 "$ref": "#/responses/empty" 2543 } 2544 } 2545 } 2546 }, 2547 "/repos/{owner}/{repo}/keys": { 2548 "get": { 2549 "produces": [ 2550 "application/json" 2551 ], 2552 "tags": [ 2553 "repository" 2554 ], 2555 "summary": "List a repository's keys", 2556 "operationId": "repoListKeys", 2557 "parameters": [ 2558 { 2559 "type": "string", 2560 "description": "owner of the repo", 2561 "name": "owner", 2562 "in": "path", 2563 "required": true 2564 }, 2565 { 2566 "type": "string", 2567 "description": "name of the repo", 2568 "name": "repo", 2569 "in": "path", 2570 "required": true 2571 } 2572 ], 2573 "responses": { 2574 "200": { 2575 "$ref": "#/responses/DeployKeyList" 2576 } 2577 } 2578 }, 2579 "post": { 2580 "consumes": [ 2581 "application/json" 2582 ], 2583 "produces": [ 2584 "application/json" 2585 ], 2586 "tags": [ 2587 "repository" 2588 ], 2589 "summary": "Add a key to a repository", 2590 "operationId": "repoCreateKey", 2591 "parameters": [ 2592 { 2593 "type": "string", 2594 "description": "owner of the repo", 2595 "name": "owner", 2596 "in": "path", 2597 "required": true 2598 }, 2599 { 2600 "type": "string", 2601 "description": "name of the repo", 2602 "name": "repo", 2603 "in": "path", 2604 "required": true 2605 }, 2606 { 2607 "name": "body", 2608 "in": "body", 2609 "schema": { 2610 "$ref": "#/definitions/CreateKeyOption" 2611 } 2612 } 2613 ], 2614 "responses": { 2615 "201": { 2616 "$ref": "#/responses/DeployKey" 2617 } 2618 } 2619 } 2620 }, 2621 "/repos/{owner}/{repo}/keys/{id}": { 2622 "get": { 2623 "produces": [ 2624 "application/json" 2625 ], 2626 "tags": [ 2627 "repository" 2628 ], 2629 "summary": "Get a repository's key by id", 2630 "operationId": "repoGetKey", 2631 "parameters": [ 2632 { 2633 "type": "string", 2634 "description": "owner of the repo", 2635 "name": "owner", 2636 "in": "path", 2637 "required": true 2638 }, 2639 { 2640 "type": "string", 2641 "description": "name of the repo", 2642 "name": "repo", 2643 "in": "path", 2644 "required": true 2645 }, 2646 { 2647 "type": "integer", 2648 "description": "id of the key to get", 2649 "name": "id", 2650 "in": "path", 2651 "required": true 2652 } 2653 ], 2654 "responses": { 2655 "200": { 2656 "$ref": "#/responses/DeployKey" 2657 } 2658 } 2659 }, 2660 "delete": { 2661 "tags": [ 2662 "repository" 2663 ], 2664 "summary": "Delete a key from a repository", 2665 "operationId": "repoDeleteKey", 2666 "parameters": [ 2667 { 2668 "type": "string", 2669 "description": "owner of the repo", 2670 "name": "owner", 2671 "in": "path", 2672 "required": true 2673 }, 2674 { 2675 "type": "string", 2676 "description": "name of the repo", 2677 "name": "repo", 2678 "in": "path", 2679 "required": true 2680 }, 2681 { 2682 "type": "integer", 2683 "description": "id of the key to delete", 2684 "name": "id", 2685 "in": "path", 2686 "required": true 2687 } 2688 ], 2689 "responses": { 2690 "204": { 2691 "$ref": "#/responses/empty" 2692 } 2693 } 2694 } 2695 }, 2696 "/repos/{owner}/{repo}/labels": { 2697 "get": { 2698 "produces": [ 2699 "application/json" 2700 ], 2701 "tags": [ 2702 "issue" 2703 ], 2704 "summary": "Get all of a repository's labels", 2705 "operationId": "issueListLabels", 2706 "parameters": [ 2707 { 2708 "type": "string", 2709 "description": "owner of the repo", 2710 "name": "owner", 2711 "in": "path", 2712 "required": true 2713 }, 2714 { 2715 "type": "string", 2716 "description": "name of the repo", 2717 "name": "repo", 2718 "in": "path", 2719 "required": true 2720 } 2721 ], 2722 "responses": { 2723 "200": { 2724 "$ref": "#/responses/LabelList" 2725 } 2726 } 2727 }, 2728 "post": { 2729 "consumes": [ 2730 "application/json" 2731 ], 2732 "produces": [ 2733 "application/json" 2734 ], 2735 "tags": [ 2736 "issue" 2737 ], 2738 "summary": "Create a label", 2739 "operationId": "issueCreateLabel", 2740 "parameters": [ 2741 { 2742 "type": "string", 2743 "description": "owner of the repo", 2744 "name": "owner", 2745 "in": "path", 2746 "required": true 2747 }, 2748 { 2749 "type": "string", 2750 "description": "name of the repo", 2751 "name": "repo", 2752 "in": "path", 2753 "required": true 2754 }, 2755 { 2756 "name": "body", 2757 "in": "body", 2758 "schema": { 2759 "$ref": "#/definitions/CreateLabelOption" 2760 } 2761 } 2762 ], 2763 "responses": { 2764 "201": { 2765 "$ref": "#/responses/Label" 2766 } 2767 } 2768 } 2769 }, 2770 "/repos/{owner}/{repo}/labels/{id}": { 2771 "get": { 2772 "produces": [ 2773 "application/json" 2774 ], 2775 "tags": [ 2776 "issue" 2777 ], 2778 "summary": "Get a single label", 2779 "operationId": "issueGetLabel", 2780 "parameters": [ 2781 { 2782 "type": "string", 2783 "description": "owner of the repo", 2784 "name": "owner", 2785 "in": "path", 2786 "required": true 2787 }, 2788 { 2789 "type": "string", 2790 "description": "name of the repo", 2791 "name": "repo", 2792 "in": "path", 2793 "required": true 2794 }, 2795 { 2796 "type": "integer", 2797 "description": "id of the label to get", 2798 "name": "id", 2799 "in": "path", 2800 "required": true 2801 } 2802 ], 2803 "responses": { 2804 "200": { 2805 "$ref": "#/responses/Label" 2806 } 2807 } 2808 }, 2809 "delete": { 2810 "tags": [ 2811 "issue" 2812 ], 2813 "summary": "Delete a label", 2814 "operationId": "issueDeleteLabel", 2815 "parameters": [ 2816 { 2817 "type": "string", 2818 "description": "owner of the repo", 2819 "name": "owner", 2820 "in": "path", 2821 "required": true 2822 }, 2823 { 2824 "type": "string", 2825 "description": "name of the repo", 2826 "name": "repo", 2827 "in": "path", 2828 "required": true 2829 }, 2830 { 2831 "type": "integer", 2832 "description": "id of the label to delete", 2833 "name": "id", 2834 "in": "path", 2835 "required": true 2836 } 2837 ], 2838 "responses": { 2839 "204": { 2840 "$ref": "#/responses/empty" 2841 } 2842 } 2843 }, 2844 "patch": { 2845 "consumes": [ 2846 "application/json" 2847 ], 2848 "produces": [ 2849 "application/json" 2850 ], 2851 "tags": [ 2852 "issue" 2853 ], 2854 "summary": "Update a label", 2855 "operationId": "issueEditLabel", 2856 "parameters": [ 2857 { 2858 "type": "string", 2859 "description": "owner of the repo", 2860 "name": "owner", 2861 "in": "path", 2862 "required": true 2863 }, 2864 { 2865 "type": "string", 2866 "description": "name of the repo", 2867 "name": "repo", 2868 "in": "path", 2869 "required": true 2870 }, 2871 { 2872 "type": "integer", 2873 "description": "id of the label to edit", 2874 "name": "id", 2875 "in": "path", 2876 "required": true 2877 }, 2878 { 2879 "name": "body", 2880 "in": "body", 2881 "schema": { 2882 "$ref": "#/definitions/EditLabelOption" 2883 } 2884 } 2885 ], 2886 "responses": { 2887 "200": { 2888 "$ref": "#/responses/Label" 2889 } 2890 } 2891 } 2892 }, 2893 "/repos/{owner}/{repo}/milestones": { 2894 "get": { 2895 "produces": [ 2896 "application/json" 2897 ], 2898 "tags": [ 2899 "issue" 2900 ], 2901 "summary": "Get all of a repository's milestones", 2902 "operationId": "issueGetMilestonesList", 2903 "parameters": [ 2904 { 2905 "type": "string", 2906 "description": "owner of the repo", 2907 "name": "owner", 2908 "in": "path", 2909 "required": true 2910 }, 2911 { 2912 "type": "string", 2913 "description": "name of the repo", 2914 "name": "repo", 2915 "in": "path", 2916 "required": true 2917 } 2918 ], 2919 "responses": { 2920 "200": { 2921 "$ref": "#/responses/MilestoneList" 2922 } 2923 } 2924 }, 2925 "post": { 2926 "consumes": [ 2927 "application/json" 2928 ], 2929 "produces": [ 2930 "application/json" 2931 ], 2932 "tags": [ 2933 "issue" 2934 ], 2935 "summary": "Create a milestone", 2936 "operationId": "issueCreateMilestone", 2937 "parameters": [ 2938 { 2939 "type": "string", 2940 "description": "owner of the repo", 2941 "name": "owner", 2942 "in": "path", 2943 "required": true 2944 }, 2945 { 2946 "type": "string", 2947 "description": "name of the repo", 2948 "name": "repo", 2949 "in": "path", 2950 "required": true 2951 }, 2952 { 2953 "name": "body", 2954 "in": "body", 2955 "schema": { 2956 "$ref": "#/definitions/CreateMilestoneOption" 2957 } 2958 } 2959 ], 2960 "responses": { 2961 "201": { 2962 "$ref": "#/responses/Milestone" 2963 } 2964 } 2965 } 2966 }, 2967 "/repos/{owner}/{repo}/milestones/{id}": { 2968 "get": { 2969 "produces": [ 2970 "application/json" 2971 ], 2972 "tags": [ 2973 "issue" 2974 ], 2975 "summary": "Get a milestone", 2976 "operationId": "issueGetMilestone", 2977 "parameters": [ 2978 { 2979 "type": "string", 2980 "description": "owner of the repo", 2981 "name": "owner", 2982 "in": "path", 2983 "required": true 2984 }, 2985 { 2986 "type": "string", 2987 "description": "name of the repo", 2988 "name": "repo", 2989 "in": "path", 2990 "required": true 2991 }, 2992 { 2993 "type": "integer", 2994 "description": "id of the milestone", 2995 "name": "id", 2996 "in": "path", 2997 "required": true 2998 } 2999 ], 3000 "responses": { 3001 "200": { 3002 "$ref": "#/responses/Milestone" 3003 } 3004 } 3005 }, 3006 "delete": { 3007 "tags": [ 3008 "issue" 3009 ], 3010 "summary": "Delete a milestone", 3011 "operationId": "issueDeleteMilestone", 3012 "parameters": [ 3013 { 3014 "type": "string", 3015 "description": "owner of the repo", 3016 "name": "owner", 3017 "in": "path", 3018 "required": true 3019 }, 3020 { 3021 "type": "string", 3022 "description": "name of the repo", 3023 "name": "repo", 3024 "in": "path", 3025 "required": true 3026 }, 3027 { 3028 "type": "integer", 3029 "description": "id of the milestone to delete", 3030 "name": "id", 3031 "in": "path", 3032 "required": true 3033 } 3034 ], 3035 "responses": { 3036 "204": { 3037 "$ref": "#/responses/empty" 3038 } 3039 } 3040 }, 3041 "patch": { 3042 "consumes": [ 3043 "application/json" 3044 ], 3045 "produces": [ 3046 "application/json" 3047 ], 3048 "tags": [ 3049 "issue" 3050 ], 3051 "summary": "Update a milestone", 3052 "operationId": "issueEditMilestone", 3053 "parameters": [ 3054 { 3055 "type": "string", 3056 "description": "owner of the repo", 3057 "name": "owner", 3058 "in": "path", 3059 "required": true 3060 }, 3061 { 3062 "type": "string", 3063 "description": "name of the repo", 3064 "name": "repo", 3065 "in": "path", 3066 "required": true 3067 }, 3068 { 3069 "type": "integer", 3070 "description": "id of the milestone", 3071 "name": "id", 3072 "in": "path", 3073 "required": true 3074 }, 3075 { 3076 "name": "body", 3077 "in": "body", 3078 "schema": { 3079 "$ref": "#/definitions/EditMilestoneOption" 3080 } 3081 } 3082 ], 3083 "responses": { 3084 "200": { 3085 "$ref": "#/responses/Milestone" 3086 } 3087 } 3088 } 3089 }, 3090 "/repos/{owner}/{repo}/mirror-sync": { 3091 "post": { 3092 "produces": [ 3093 "application/json" 3094 ], 3095 "tags": [ 3096 "repository" 3097 ], 3098 "summary": "Sync a mirrored repository", 3099 "operationId": "repoMirrorSync", 3100 "parameters": [ 3101 { 3102 "type": "string", 3103 "description": "owner of the repo to sync", 3104 "name": "owner", 3105 "in": "path", 3106 "required": true 3107 }, 3108 { 3109 "type": "string", 3110 "description": "name of the repo to sync", 3111 "name": "repo", 3112 "in": "path", 3113 "required": true 3114 } 3115 ], 3116 "responses": { 3117 "200": { 3118 "$ref": "#/responses/empty" 3119 } 3120 } 3121 } 3122 }, 3123 "/repos/{owner}/{repo}/pulls": { 3124 "get": { 3125 "produces": [ 3126 "application/json" 3127 ], 3128 "tags": [ 3129 "repository" 3130 ], 3131 "summary": "List a repo's pull requests", 3132 "operationId": "repoListPullRequests", 3133 "parameters": [ 3134 { 3135 "type": "string", 3136 "description": "owner of the repo", 3137 "name": "owner", 3138 "in": "path", 3139 "required": true 3140 }, 3141 { 3142 "type": "string", 3143 "description": "name of the repo", 3144 "name": "repo", 3145 "in": "path", 3146 "required": true 3147 } 3148 ], 3149 "responses": { 3150 "200": { 3151 "$ref": "#/responses/PullRequestList" 3152 } 3153 } 3154 }, 3155 "post": { 3156 "consumes": [ 3157 "application/json" 3158 ], 3159 "produces": [ 3160 "application/json" 3161 ], 3162 "tags": [ 3163 "repository" 3164 ], 3165 "summary": "Create a pull request", 3166 "operationId": "repoCreatePullRequest", 3167 "parameters": [ 3168 { 3169 "type": "string", 3170 "description": "owner of the repo", 3171 "name": "owner", 3172 "in": "path", 3173 "required": true 3174 }, 3175 { 3176 "type": "string", 3177 "description": "name of the repo", 3178 "name": "repo", 3179 "in": "path", 3180 "required": true 3181 }, 3182 { 3183 "name": "body", 3184 "in": "body", 3185 "schema": { 3186 "$ref": "#/definitions/CreatePullRequestOption" 3187 } 3188 } 3189 ], 3190 "responses": { 3191 "201": { 3192 "$ref": "#/responses/PullRequest" 3193 } 3194 } 3195 } 3196 }, 3197 "/repos/{owner}/{repo}/pulls/{index}": { 3198 "get": { 3199 "produces": [ 3200 "application/json" 3201 ], 3202 "tags": [ 3203 "repository" 3204 ], 3205 "summary": "Get a pull request", 3206 "operationId": "repoGetPullRequest", 3207 "parameters": [ 3208 { 3209 "type": "string", 3210 "description": "owner of the repo", 3211 "name": "owner", 3212 "in": "path", 3213 "required": true 3214 }, 3215 { 3216 "type": "string", 3217 "description": "name of the repo", 3218 "name": "repo", 3219 "in": "path", 3220 "required": true 3221 }, 3222 { 3223 "type": "integer", 3224 "description": "index of the pull request to get", 3225 "name": "index", 3226 "in": "path", 3227 "required": true 3228 } 3229 ], 3230 "responses": { 3231 "200": { 3232 "$ref": "#/responses/PullRequest" 3233 } 3234 } 3235 }, 3236 "patch": { 3237 "consumes": [ 3238 "application/json" 3239 ], 3240 "produces": [ 3241 "application/json" 3242 ], 3243 "tags": [ 3244 "repository" 3245 ], 3246 "summary": "Update a pull request", 3247 "operationId": "repoEditPullRequest", 3248 "parameters": [ 3249 { 3250 "type": "string", 3251 "description": "owner of the repo", 3252 "name": "owner", 3253 "in": "path", 3254 "required": true 3255 }, 3256 { 3257 "type": "string", 3258 "description": "name of the repo", 3259 "name": "repo", 3260 "in": "path", 3261 "required": true 3262 }, 3263 { 3264 "type": "integer", 3265 "description": "index of the pull request to edit", 3266 "name": "index", 3267 "in": "path", 3268 "required": true 3269 }, 3270 { 3271 "name": "body", 3272 "in": "body", 3273 "schema": { 3274 "$ref": "#/definitions/EditPullRequestOption" 3275 } 3276 } 3277 ], 3278 "responses": { 3279 "201": { 3280 "$ref": "#/responses/PullRequest" 3281 } 3282 } 3283 } 3284 }, 3285 "/repos/{owner}/{repo}/pulls/{index}/merge": { 3286 "get": { 3287 "produces": [ 3288 "application/json" 3289 ], 3290 "tags": [ 3291 "repository" 3292 ], 3293 "summary": "Check if a pull request has been merged", 3294 "operationId": "repoPullRequestIsMerged", 3295 "parameters": [ 3296 { 3297 "type": "string", 3298 "description": "owner of the repo", 3299 "name": "owner", 3300 "in": "path", 3301 "required": true 3302 }, 3303 { 3304 "type": "string", 3305 "description": "name of the repo", 3306 "name": "repo", 3307 "in": "path", 3308 "required": true 3309 }, 3310 { 3311 "type": "integer", 3312 "description": "index of the pull request", 3313 "name": "index", 3314 "in": "path", 3315 "required": true 3316 } 3317 ], 3318 "responses": { 3319 "204": { 3320 "description": "pull request has been merged", 3321 "schema": { 3322 "$ref": "#/responses/empty" 3323 } 3324 }, 3325 "404": { 3326 "description": "pull request has not been merged", 3327 "schema": { 3328 "$ref": "#/responses/empty" 3329 } 3330 } 3331 } 3332 }, 3333 "post": { 3334 "produces": [ 3335 "application/json" 3336 ], 3337 "tags": [ 3338 "repository" 3339 ], 3340 "summary": "Merge a pull request", 3341 "operationId": "repoMergePullRequest", 3342 "parameters": [ 3343 { 3344 "type": "string", 3345 "description": "owner of the repo", 3346 "name": "owner", 3347 "in": "path", 3348 "required": true 3349 }, 3350 { 3351 "type": "string", 3352 "description": "name of the repo", 3353 "name": "repo", 3354 "in": "path", 3355 "required": true 3356 }, 3357 { 3358 "type": "integer", 3359 "description": "index of the pull request to merge", 3360 "name": "index", 3361 "in": "path", 3362 "required": true 3363 } 3364 ], 3365 "responses": { 3366 "200": { 3367 "$ref": "#/responses/empty" 3368 }, 3369 "405": { 3370 "$ref": "#/responses/empty" 3371 } 3372 } 3373 } 3374 }, 3375 "/repos/{owner}/{repo}/raw/{filepath}": { 3376 "get": { 3377 "produces": [ 3378 "application/json" 3379 ], 3380 "tags": [ 3381 "repository" 3382 ], 3383 "summary": "Get a file from a repository", 3384 "operationId": "repoGetRawFile", 3385 "parameters": [ 3386 { 3387 "type": "string", 3388 "description": "owner of the repo", 3389 "name": "owner", 3390 "in": "path", 3391 "required": true 3392 }, 3393 { 3394 "type": "string", 3395 "description": "name of the repo", 3396 "name": "repo", 3397 "in": "path", 3398 "required": true 3399 }, 3400 { 3401 "type": "string", 3402 "description": "filepath of the file to get", 3403 "name": "filepath", 3404 "in": "path", 3405 "required": true 3406 } 3407 ], 3408 "responses": { 3409 "200": { 3410 "description": "success" 3411 } 3412 } 3413 } 3414 }, 3415 "/repos/{owner}/{repo}/releases": { 3416 "get": { 3417 "produces": [ 3418 "application/json" 3419 ], 3420 "tags": [ 3421 "repository" 3422 ], 3423 "summary": "List a repo's releases", 3424 "operationId": "repoListReleases", 3425 "parameters": [ 3426 { 3427 "type": "string", 3428 "description": "owner of the repo", 3429 "name": "owner", 3430 "in": "path", 3431 "required": true 3432 }, 3433 { 3434 "type": "string", 3435 "description": "name of the repo", 3436 "name": "repo", 3437 "in": "path", 3438 "required": true 3439 } 3440 ], 3441 "responses": { 3442 "200": { 3443 "$ref": "#/responses/ReleaseList" 3444 } 3445 } 3446 }, 3447 "post": { 3448 "consumes": [ 3449 "application/json" 3450 ], 3451 "produces": [ 3452 "application/json" 3453 ], 3454 "tags": [ 3455 "repository" 3456 ], 3457 "summary": "Create a release", 3458 "operationId": "repoCreateRelease", 3459 "parameters": [ 3460 { 3461 "type": "string", 3462 "description": "owner of the repo", 3463 "name": "owner", 3464 "in": "path", 3465 "required": true 3466 }, 3467 { 3468 "type": "string", 3469 "description": "name of the repo", 3470 "name": "repo", 3471 "in": "path", 3472 "required": true 3473 }, 3474 { 3475 "name": "body", 3476 "in": "body", 3477 "schema": { 3478 "$ref": "#/definitions/CreateReleaseOption" 3479 } 3480 } 3481 ], 3482 "responses": { 3483 "201": { 3484 "$ref": "#/responses/Release" 3485 } 3486 } 3487 } 3488 }, 3489 "/repos/{owner}/{repo}/releases/{id}": { 3490 "get": { 3491 "produces": [ 3492 "application/json" 3493 ], 3494 "tags": [ 3495 "repository" 3496 ], 3497 "summary": "Get a release", 3498 "operationId": "repoGetRelease", 3499 "parameters": [ 3500 { 3501 "type": "string", 3502 "description": "owner of the repo", 3503 "name": "owner", 3504 "in": "path", 3505 "required": true 3506 }, 3507 { 3508 "type": "string", 3509 "description": "name of the repo", 3510 "name": "repo", 3511 "in": "path", 3512 "required": true 3513 }, 3514 { 3515 "type": "integer", 3516 "description": "id of the release to get", 3517 "name": "id", 3518 "in": "path", 3519 "required": true 3520 } 3521 ], 3522 "responses": { 3523 "200": { 3524 "$ref": "#/responses/Release" 3525 } 3526 } 3527 }, 3528 "delete": { 3529 "tags": [ 3530 "repository" 3531 ], 3532 "summary": "Delete a release", 3533 "operationId": "repoDeleteRelease", 3534 "parameters": [ 3535 { 3536 "type": "string", 3537 "description": "owner of the repo", 3538 "name": "owner", 3539 "in": "path", 3540 "required": true 3541 }, 3542 { 3543 "type": "string", 3544 "description": "name of the repo", 3545 "name": "repo", 3546 "in": "path", 3547 "required": true 3548 }, 3549 { 3550 "type": "integer", 3551 "description": "id of the release to delete", 3552 "name": "id", 3553 "in": "path", 3554 "required": true 3555 } 3556 ], 3557 "responses": { 3558 "204": { 3559 "$ref": "#/responses/empty" 3560 } 3561 } 3562 }, 3563 "patch": { 3564 "consumes": [ 3565 "application/json" 3566 ], 3567 "produces": [ 3568 "application/json" 3569 ], 3570 "tags": [ 3571 "repository" 3572 ], 3573 "summary": "Update a release", 3574 "operationId": "repoEditRelease", 3575 "parameters": [ 3576 { 3577 "type": "string", 3578 "description": "owner of the repo", 3579 "name": "owner", 3580 "in": "path", 3581 "required": true 3582 }, 3583 { 3584 "type": "string", 3585 "description": "name of the repo", 3586 "name": "repo", 3587 "in": "path", 3588 "required": true 3589 }, 3590 { 3591 "type": "integer", 3592 "description": "id of the release to edit", 3593 "name": "id", 3594 "in": "path", 3595 "required": true 3596 }, 3597 { 3598 "name": "body", 3599 "in": "body", 3600 "schema": { 3601 "$ref": "#/definitions/EditReleaseOption" 3602 } 3603 } 3604 ], 3605 "responses": { 3606 "200": { 3607 "$ref": "#/responses/Release" 3608 } 3609 } 3610 } 3611 }, 3612 "/repos/{owner}/{repo}/releases/{id}/assets": { 3613 "get": { 3614 "produces": [ 3615 "application/json" 3616 ], 3617 "tags": [ 3618 "repository" 3619 ], 3620 "summary": "List release's attachments", 3621 "operationId": "repoListReleaseAttachments", 3622 "parameters": [ 3623 { 3624 "type": "string", 3625 "description": "owner of the repo", 3626 "name": "owner", 3627 "in": "path", 3628 "required": true 3629 }, 3630 { 3631 "type": "string", 3632 "description": "name of the repo", 3633 "name": "repo", 3634 "in": "path", 3635 "required": true 3636 }, 3637 { 3638 "type": "integer", 3639 "description": "id of the release", 3640 "name": "id", 3641 "in": "path", 3642 "required": true 3643 } 3644 ], 3645 "responses": { 3646 "200": { 3647 "$ref": "#/responses/AttachmentList" 3648 } 3649 } 3650 }, 3651 "post": { 3652 "consumes": [ 3653 "multipart/form-data" 3654 ], 3655 "produces": [ 3656 "application/json" 3657 ], 3658 "tags": [ 3659 "repository" 3660 ], 3661 "summary": "Create a release attachment", 3662 "operationId": "repoCreateReleaseAttachment", 3663 "parameters": [ 3664 { 3665 "type": "string", 3666 "description": "owner of the repo", 3667 "name": "owner", 3668 "in": "path", 3669 "required": true 3670 }, 3671 { 3672 "type": "string", 3673 "description": "name of the repo", 3674 "name": "repo", 3675 "in": "path", 3676 "required": true 3677 }, 3678 { 3679 "type": "integer", 3680 "description": "id of the release", 3681 "name": "id", 3682 "in": "path", 3683 "required": true 3684 }, 3685 { 3686 "type": "string", 3687 "description": "name of the attachment", 3688 "name": "name", 3689 "in": "query" 3690 }, 3691 { 3692 "type": "file", 3693 "description": "attachment to upload", 3694 "name": "attachment", 3695 "in": "formData", 3696 "required": true 3697 } 3698 ], 3699 "responses": { 3700 "201": { 3701 "$ref": "#/responses/Attachment" 3702 } 3703 } 3704 } 3705 }, 3706 "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": { 3707 "get": { 3708 "produces": [ 3709 "application/json" 3710 ], 3711 "tags": [ 3712 "repository" 3713 ], 3714 "summary": "Get a release attachment", 3715 "operationId": "repoGetReleaseAttachment", 3716 "parameters": [ 3717 { 3718 "type": "string", 3719 "description": "owner of the repo", 3720 "name": "owner", 3721 "in": "path", 3722 "required": true 3723 }, 3724 { 3725 "type": "string", 3726 "description": "name of the repo", 3727 "name": "repo", 3728 "in": "path", 3729 "required": true 3730 }, 3731 { 3732 "type": "integer", 3733 "description": "id of the release", 3734 "name": "id", 3735 "in": "path", 3736 "required": true 3737 }, 3738 { 3739 "type": "integer", 3740 "description": "id of the attachment to get", 3741 "name": "attachment_id", 3742 "in": "path", 3743 "required": true 3744 } 3745 ], 3746 "responses": { 3747 "200": { 3748 "$ref": "#/responses/Attachment" 3749 } 3750 } 3751 }, 3752 "delete": { 3753 "produces": [ 3754 "application/json" 3755 ], 3756 "tags": [ 3757 "repository" 3758 ], 3759 "summary": "Delete a release attachment", 3760 "operationId": "repoDeleteReleaseAttachment", 3761 "parameters": [ 3762 { 3763 "type": "string", 3764 "description": "owner of the repo", 3765 "name": "owner", 3766 "in": "path", 3767 "required": true 3768 }, 3769 { 3770 "type": "string", 3771 "description": "name of the repo", 3772 "name": "repo", 3773 "in": "path", 3774 "required": true 3775 }, 3776 { 3777 "type": "integer", 3778 "description": "id of the release", 3779 "name": "id", 3780 "in": "path", 3781 "required": true 3782 }, 3783 { 3784 "type": "integer", 3785 "description": "id of the attachment to delete", 3786 "name": "attachment_id", 3787 "in": "path", 3788 "required": true 3789 } 3790 ], 3791 "responses": { 3792 "204": { 3793 "$ref": "#/responses/empty" 3794 } 3795 } 3796 }, 3797 "patch": { 3798 "consumes": [ 3799 "application/json" 3800 ], 3801 "produces": [ 3802 "application/json" 3803 ], 3804 "tags": [ 3805 "repository" 3806 ], 3807 "summary": "Edit a release attachment", 3808 "operationId": "repoEditReleaseAttachment", 3809 "parameters": [ 3810 { 3811 "type": "string", 3812 "description": "owner of the repo", 3813 "name": "owner", 3814 "in": "path", 3815 "required": true 3816 }, 3817 { 3818 "type": "string", 3819 "description": "name of the repo", 3820 "name": "repo", 3821 "in": "path", 3822 "required": true 3823 }, 3824 { 3825 "type": "integer", 3826 "description": "id of the release", 3827 "name": "id", 3828 "in": "path", 3829 "required": true 3830 }, 3831 { 3832 "type": "integer", 3833 "description": "id of the attachment to edit", 3834 "name": "attachment_id", 3835 "in": "path", 3836 "required": true 3837 }, 3838 { 3839 "name": "body", 3840 "in": "body", 3841 "schema": { 3842 "$ref": "#/definitions/EditAttachmentOptions" 3843 } 3844 } 3845 ], 3846 "responses": { 3847 "201": { 3848 "$ref": "#/responses/Attachment" 3849 } 3850 } 3851 } 3852 }, 3853 "/repos/{owner}/{repo}/stargazers": { 3854 "get": { 3855 "produces": [ 3856 "application/json" 3857 ], 3858 "tags": [ 3859 "repository" 3860 ], 3861 "summary": "List a repo's stargazers", 3862 "operationId": "repoListStargazers", 3863 "parameters": [ 3864 { 3865 "type": "string", 3866 "description": "owner of the repo", 3867 "name": "owner", 3868 "in": "path", 3869 "required": true 3870 }, 3871 { 3872 "type": "string", 3873 "description": "name of the repo", 3874 "name": "repo", 3875 "in": "path", 3876 "required": true 3877 } 3878 ], 3879 "responses": { 3880 "200": { 3881 "$ref": "#/responses/UserList" 3882 } 3883 } 3884 } 3885 }, 3886 "/repos/{owner}/{repo}/statuses/{sha}": { 3887 "get": { 3888 "produces": [ 3889 "application/json" 3890 ], 3891 "tags": [ 3892 "repository" 3893 ], 3894 "summary": "Get a commit's statuses", 3895 "operationId": "repoListStatuses", 3896 "parameters": [ 3897 { 3898 "type": "string", 3899 "description": "owner of the repo", 3900 "name": "owner", 3901 "in": "path", 3902 "required": true 3903 }, 3904 { 3905 "type": "string", 3906 "description": "name of the repo", 3907 "name": "repo", 3908 "in": "path", 3909 "required": true 3910 }, 3911 { 3912 "type": "string", 3913 "description": "sha of the commit", 3914 "name": "sha", 3915 "in": "path", 3916 "required": true 3917 } 3918 ], 3919 "responses": { 3920 "200": { 3921 "$ref": "#/responses/StatusList" 3922 } 3923 } 3924 }, 3925 "post": { 3926 "produces": [ 3927 "application/json" 3928 ], 3929 "tags": [ 3930 "repository" 3931 ], 3932 "summary": "Create a commit status", 3933 "operationId": "repoCreateStatus", 3934 "parameters": [ 3935 { 3936 "type": "string", 3937 "description": "owner of the repo", 3938 "name": "owner", 3939 "in": "path", 3940 "required": true 3941 }, 3942 { 3943 "type": "string", 3944 "description": "name of the repo", 3945 "name": "repo", 3946 "in": "path", 3947 "required": true 3948 }, 3949 { 3950 "type": "string", 3951 "description": "sha of the commit", 3952 "name": "sha", 3953 "in": "path", 3954 "required": true 3955 }, 3956 { 3957 "name": "body", 3958 "in": "body", 3959 "schema": { 3960 "$ref": "#/definitions/CreateStatusOption" 3961 } 3962 } 3963 ], 3964 "responses": { 3965 "200": { 3966 "$ref": "#/responses/StatusList" 3967 } 3968 } 3969 } 3970 }, 3971 "/repos/{owner}/{repo}/subscribers": { 3972 "get": { 3973 "produces": [ 3974 "application/json" 3975 ], 3976 "tags": [ 3977 "repository" 3978 ], 3979 "summary": "List a repo's watchers", 3980 "operationId": "repoListSubscribers", 3981 "parameters": [ 3982 { 3983 "type": "string", 3984 "description": "owner of the repo", 3985 "name": "owner", 3986 "in": "path", 3987 "required": true 3988 }, 3989 { 3990 "type": "string", 3991 "description": "name of the repo", 3992 "name": "repo", 3993 "in": "path", 3994 "required": true 3995 } 3996 ], 3997 "responses": { 3998 "200": { 3999 "$ref": "#/responses/UserList" 4000 } 4001 } 4002 } 4003 }, 4004 "/repos/{owner}/{repo}/subscription": { 4005 "get": { 4006 "tags": [ 4007 "repository" 4008 ], 4009 "summary": "Check if the current user is watching a repo", 4010 "operationId": "userCurrentCheckSubscription", 4011 "parameters": [ 4012 { 4013 "type": "string", 4014 "description": "owner of the repo", 4015 "name": "owner", 4016 "in": "path", 4017 "required": true 4018 }, 4019 { 4020 "type": "string", 4021 "description": "name of the repo", 4022 "name": "repo", 4023 "in": "path", 4024 "required": true 4025 } 4026 ], 4027 "responses": { 4028 "200": { 4029 "$ref": "#/responses/WatchInfo" 4030 } 4031 } 4032 }, 4033 "put": { 4034 "tags": [ 4035 "repository" 4036 ], 4037 "summary": "Watch a repo", 4038 "operationId": "userCurrentPutSubscription", 4039 "parameters": [ 4040 { 4041 "type": "string", 4042 "description": "owner of the repo", 4043 "name": "owner", 4044 "in": "path", 4045 "required": true 4046 }, 4047 { 4048 "type": "string", 4049 "description": "name of the repo", 4050 "name": "repo", 4051 "in": "path", 4052 "required": true 4053 } 4054 ], 4055 "responses": { 4056 "200": { 4057 "$ref": "#/responses/WatchInfo" 4058 } 4059 } 4060 }, 4061 "delete": { 4062 "tags": [ 4063 "repository" 4064 ], 4065 "summary": "Unwatch a repo", 4066 "operationId": "userCurrentDeleteSubscription", 4067 "parameters": [ 4068 { 4069 "type": "string", 4070 "description": "owner of the repo", 4071 "name": "owner", 4072 "in": "path", 4073 "required": true 4074 }, 4075 { 4076 "type": "string", 4077 "description": "name of the repo", 4078 "name": "repo", 4079 "in": "path", 4080 "required": true 4081 } 4082 ], 4083 "responses": { 4084 "204": { 4085 "$ref": "#/responses/empty" 4086 } 4087 } 4088 } 4089 }, 4090 "/repos/{owner}/{repo}/times": { 4091 "get": { 4092 "produces": [ 4093 "application/json" 4094 ], 4095 "tags": [ 4096 "repository" 4097 ], 4098 "summary": "List a repo's tracked times", 4099 "operationId": "repoTrackedTimes", 4100 "parameters": [ 4101 { 4102 "type": "string", 4103 "description": "owner of the repo", 4104 "name": "owner", 4105 "in": "path", 4106 "required": true 4107 }, 4108 { 4109 "type": "string", 4110 "description": "name of the repo", 4111 "name": "repo", 4112 "in": "path", 4113 "required": true 4114 } 4115 ], 4116 "responses": { 4117 "200": { 4118 "$ref": "#/responses/TrackedTimeList" 4119 } 4120 } 4121 } 4122 }, 4123 "/repos/{owner}/{repo}/times/{user}": { 4124 "get": { 4125 "produces": [ 4126 "application/json" 4127 ], 4128 "tags": [ 4129 "user" 4130 ], 4131 "summary": "List a user's tracked times in a repo", 4132 "operationId": "userTrackedTimes", 4133 "parameters": [ 4134 { 4135 "type": "string", 4136 "description": "owner of the repo", 4137 "name": "owner", 4138 "in": "path", 4139 "required": true 4140 }, 4141 { 4142 "type": "string", 4143 "description": "name of the repo", 4144 "name": "repo", 4145 "in": "path", 4146 "required": true 4147 }, 4148 { 4149 "type": "string", 4150 "description": "username of user", 4151 "name": "user", 4152 "in": "path", 4153 "required": true 4154 } 4155 ], 4156 "responses": { 4157 "200": { 4158 "$ref": "#/responses/TrackedTimeList" 4159 } 4160 } 4161 } 4162 }, 4163 "/repositories/{id}": { 4164 "get": { 4165 "produces": [ 4166 "application/json" 4167 ], 4168 "tags": [ 4169 "repository" 4170 ], 4171 "summary": "Get a repository by id", 4172 "operationId": "repoGetByID", 4173 "parameters": [ 4174 { 4175 "type": "integer", 4176 "description": "id of the repo to get", 4177 "name": "id", 4178 "in": "path", 4179 "required": true 4180 } 4181 ], 4182 "responses": { 4183 "200": { 4184 "$ref": "#/responses/Repository" 4185 } 4186 } 4187 } 4188 }, 4189 "/teams/{id}": { 4190 "get": { 4191 "produces": [ 4192 "application/json" 4193 ], 4194 "tags": [ 4195 "organization" 4196 ], 4197 "summary": "Get a team", 4198 "operationId": "orgGetTeam", 4199 "parameters": [ 4200 { 4201 "type": "integer", 4202 "description": "id of the team to get", 4203 "name": "id", 4204 "in": "path", 4205 "required": true 4206 } 4207 ], 4208 "responses": { 4209 "200": { 4210 "$ref": "#/responses/Team" 4211 } 4212 } 4213 }, 4214 "delete": { 4215 "tags": [ 4216 "organization" 4217 ], 4218 "summary": "Delete a team", 4219 "operationId": "orgDeleteTeam", 4220 "parameters": [ 4221 { 4222 "type": "integer", 4223 "description": "id of the team to delete", 4224 "name": "id", 4225 "in": "path", 4226 "required": true 4227 } 4228 ], 4229 "responses": { 4230 "204": { 4231 "description": "team deleted", 4232 "schema": { 4233 "$ref": "#/responses/empty" 4234 } 4235 } 4236 } 4237 }, 4238 "patch": { 4239 "consumes": [ 4240 "application/json" 4241 ], 4242 "produces": [ 4243 "application/json" 4244 ], 4245 "tags": [ 4246 "organization" 4247 ], 4248 "summary": "Edit a team", 4249 "operationId": "orgEditTeam", 4250 "parameters": [ 4251 { 4252 "type": "integer", 4253 "description": "id of the team to edit", 4254 "name": "id", 4255 "in": "path", 4256 "required": true 4257 }, 4258 { 4259 "name": "body", 4260 "in": "body", 4261 "schema": { 4262 "$ref": "#/definitions/EditTeamOption" 4263 } 4264 } 4265 ], 4266 "responses": { 4267 "200": { 4268 "$ref": "#/responses/Team" 4269 } 4270 } 4271 } 4272 }, 4273 "/teams/{id}/members": { 4274 "get": { 4275 "produces": [ 4276 "application/json" 4277 ], 4278 "tags": [ 4279 "organization" 4280 ], 4281 "summary": "List a team's members", 4282 "operationId": "orgListTeamMembers", 4283 "parameters": [ 4284 { 4285 "type": "integer", 4286 "description": "id of the team", 4287 "name": "id", 4288 "in": "path", 4289 "required": true 4290 } 4291 ], 4292 "responses": { 4293 "200": { 4294 "$ref": "#/responses/UserList" 4295 } 4296 } 4297 } 4298 }, 4299 "/teams/{id}/members/{username}": { 4300 "put": { 4301 "produces": [ 4302 "application/json" 4303 ], 4304 "tags": [ 4305 "organization" 4306 ], 4307 "summary": "Add a team member", 4308 "operationId": "orgAddTeamMember", 4309 "parameters": [ 4310 { 4311 "type": "integer", 4312 "description": "id of the team", 4313 "name": "id", 4314 "in": "path", 4315 "required": true 4316 }, 4317 { 4318 "type": "string", 4319 "description": "username of the user to add", 4320 "name": "username", 4321 "in": "path", 4322 "required": true 4323 } 4324 ], 4325 "responses": { 4326 "204": { 4327 "$ref": "#/responses/empty" 4328 } 4329 } 4330 }, 4331 "delete": { 4332 "produces": [ 4333 "application/json" 4334 ], 4335 "tags": [ 4336 "organization" 4337 ], 4338 "summary": "Remove a team member", 4339 "operationId": "orgRemoveTeamMember", 4340 "parameters": [ 4341 { 4342 "type": "integer", 4343 "description": "id of the team", 4344 "name": "id", 4345 "in": "path", 4346 "required": true 4347 }, 4348 { 4349 "type": "string", 4350 "description": "username of the user to remove", 4351 "name": "username", 4352 "in": "path", 4353 "required": true 4354 } 4355 ], 4356 "responses": { 4357 "204": { 4358 "$ref": "#/responses/empty" 4359 } 4360 } 4361 } 4362 }, 4363 "/teams/{id}/repos": { 4364 "get": { 4365 "produces": [ 4366 "application/json" 4367 ], 4368 "tags": [ 4369 "organization" 4370 ], 4371 "summary": "List a team's repos", 4372 "operationId": "orgListTeamRepos", 4373 "parameters": [ 4374 { 4375 "type": "integer", 4376 "description": "id of the team", 4377 "name": "id", 4378 "in": "path", 4379 "required": true 4380 } 4381 ], 4382 "responses": { 4383 "200": { 4384 "$ref": "#/responses/RepositoryList" 4385 } 4386 } 4387 } 4388 }, 4389 "/teams/{id}/repos/{org}/{repo}": { 4390 "put": { 4391 "produces": [ 4392 "application/json" 4393 ], 4394 "tags": [ 4395 "organization" 4396 ], 4397 "summary": "Add a repository to a team", 4398 "operationId": "orgAddTeamRepository", 4399 "parameters": [ 4400 { 4401 "type": "integer", 4402 "description": "id of the team", 4403 "name": "id", 4404 "in": "path", 4405 "required": true 4406 }, 4407 { 4408 "type": "string", 4409 "description": "organization that owns the repo to add", 4410 "name": "org", 4411 "in": "path", 4412 "required": true 4413 }, 4414 { 4415 "type": "string", 4416 "description": "name of the repo to add", 4417 "name": "repo", 4418 "in": "path", 4419 "required": true 4420 } 4421 ], 4422 "responses": { 4423 "204": { 4424 "$ref": "#/responses/empty" 4425 } 4426 } 4427 }, 4428 "delete": { 4429 "description": "This does not delete the repository, it only removes the repository from the team.", 4430 "produces": [ 4431 "application/json" 4432 ], 4433 "tags": [ 4434 "organization" 4435 ], 4436 "summary": "Remove a repository from a team", 4437 "operationId": "orgRemoveTeamRepository", 4438 "parameters": [ 4439 { 4440 "type": "integer", 4441 "description": "id of the team", 4442 "name": "id", 4443 "in": "path", 4444 "required": true 4445 }, 4446 { 4447 "type": "string", 4448 "description": "organization that owns the repo to remove", 4449 "name": "org", 4450 "in": "path", 4451 "required": true 4452 }, 4453 { 4454 "type": "string", 4455 "description": "name of the repo to remove", 4456 "name": "repo", 4457 "in": "path", 4458 "required": true 4459 } 4460 ], 4461 "responses": { 4462 "204": { 4463 "$ref": "#/responses/empty" 4464 } 4465 } 4466 } 4467 }, 4468 "/topics/search": { 4469 "get": { 4470 "produces": [ 4471 "application/json" 4472 ], 4473 "tags": [ 4474 "repository" 4475 ], 4476 "summary": "search topics via keyword", 4477 "operationId": "topicSearch", 4478 "parameters": [ 4479 { 4480 "type": "string", 4481 "description": "keywords to search", 4482 "name": "q", 4483 "in": "query", 4484 "required": true 4485 } 4486 ], 4487 "responses": { 4488 "200": { 4489 "$ref": "#/responses/Repository" 4490 } 4491 } 4492 } 4493 }, 4494 "/user": { 4495 "get": { 4496 "produces": [ 4497 "application/json" 4498 ], 4499 "tags": [ 4500 "user" 4501 ], 4502 "summary": "Get the authenticated user", 4503 "operationId": "userGetCurrent", 4504 "responses": { 4505 "200": { 4506 "$ref": "#/responses/User" 4507 } 4508 } 4509 } 4510 }, 4511 "/user/emails": { 4512 "get": { 4513 "produces": [ 4514 "application/json" 4515 ], 4516 "tags": [ 4517 "user" 4518 ], 4519 "summary": "List the authenticated user's email addresses", 4520 "operationId": "userListEmails", 4521 "responses": { 4522 "200": { 4523 "$ref": "#/responses/EmailList" 4524 } 4525 } 4526 }, 4527 "post": { 4528 "produces": [ 4529 "application/json" 4530 ], 4531 "tags": [ 4532 "user" 4533 ], 4534 "summary": "Add email addresses", 4535 "operationId": "userAddEmail", 4536 "parameters": [ 4537 { 4538 "name": "body", 4539 "in": "body", 4540 "schema": { 4541 "$ref": "#/definitions/CreateEmailOption" 4542 } 4543 } 4544 ], 4545 "responses": { 4546 "201": { 4547 "$ref": "#/responses/EmailList" 4548 } 4549 } 4550 }, 4551 "delete": { 4552 "produces": [ 4553 "application/json" 4554 ], 4555 "tags": [ 4556 "user" 4557 ], 4558 "summary": "Delete email addresses", 4559 "operationId": "userDeleteEmail", 4560 "parameters": [ 4561 { 4562 "name": "body", 4563 "in": "body", 4564 "schema": { 4565 "$ref": "#/definitions/DeleteEmailOption" 4566 } 4567 } 4568 ], 4569 "responses": { 4570 "204": { 4571 "$ref": "#/responses/empty" 4572 } 4573 } 4574 } 4575 }, 4576 "/user/followers": { 4577 "get": { 4578 "produces": [ 4579 "application/json" 4580 ], 4581 "tags": [ 4582 "user" 4583 ], 4584 "summary": "List the authenticated user's followers", 4585 "operationId": "userCurrentListFollowers", 4586 "responses": { 4587 "200": { 4588 "$ref": "#/responses/UserList" 4589 } 4590 } 4591 } 4592 }, 4593 "/user/following": { 4594 "get": { 4595 "produces": [ 4596 "application/json" 4597 ], 4598 "tags": [ 4599 "user" 4600 ], 4601 "summary": "List the users that the authenticated user is following", 4602 "operationId": "userCurrentListFollowing", 4603 "responses": { 4604 "200": { 4605 "$ref": "#/responses/UserList" 4606 } 4607 } 4608 } 4609 }, 4610 "/user/following/{username}": { 4611 "get": { 4612 "tags": [ 4613 "user" 4614 ], 4615 "summary": "Check whether a user is followed by the authenticated user", 4616 "operationId": "userCurrentCheckFollowing", 4617 "parameters": [ 4618 { 4619 "type": "string", 4620 "description": "username of followed user", 4621 "name": "username", 4622 "in": "path", 4623 "required": true 4624 } 4625 ], 4626 "responses": { 4627 "204": { 4628 "$ref": "#/responses/empty" 4629 }, 4630 "404": { 4631 "$ref": "#/responses/notFound" 4632 } 4633 } 4634 }, 4635 "put": { 4636 "tags": [ 4637 "user" 4638 ], 4639 "summary": "Follow a user", 4640 "operationId": "userCurrentPutFollow", 4641 "parameters": [ 4642 { 4643 "type": "string", 4644 "description": "username of user to follow", 4645 "name": "username", 4646 "in": "path", 4647 "required": true 4648 } 4649 ], 4650 "responses": { 4651 "204": { 4652 "$ref": "#/responses/empty" 4653 } 4654 } 4655 }, 4656 "delete": { 4657 "tags": [ 4658 "user" 4659 ], 4660 "summary": "Unfollow a user", 4661 "operationId": "userCurrentDeleteFollow", 4662 "parameters": [ 4663 { 4664 "type": "string", 4665 "description": "username of user to unfollow", 4666 "name": "username", 4667 "in": "path", 4668 "required": true 4669 } 4670 ], 4671 "responses": { 4672 "204": { 4673 "$ref": "#/responses/empty" 4674 } 4675 } 4676 } 4677 }, 4678 "/user/gpg_keys": { 4679 "get": { 4680 "produces": [ 4681 "application/json" 4682 ], 4683 "tags": [ 4684 "user" 4685 ], 4686 "summary": "List the authenticated user's GPG keys", 4687 "operationId": "userCurrentListGPGKeys", 4688 "responses": { 4689 "200": { 4690 "$ref": "#/responses/GPGKeyList" 4691 } 4692 } 4693 }, 4694 "post": { 4695 "consumes": [ 4696 "application/json" 4697 ], 4698 "produces": [ 4699 "application/json" 4700 ], 4701 "tags": [ 4702 "user" 4703 ], 4704 "summary": "Create a GPG key", 4705 "operationId": "userCurrentPostGPGKey", 4706 "parameters": [ 4707 { 4708 "name": "Form", 4709 "in": "body", 4710 "schema": { 4711 "$ref": "#/definitions/CreateGPGKeyOption" 4712 } 4713 } 4714 ], 4715 "responses": { 4716 "201": { 4717 "$ref": "#/responses/GPGKey" 4718 }, 4719 "422": { 4720 "$ref": "#/responses/validationError" 4721 } 4722 } 4723 } 4724 }, 4725 "/user/gpg_keys/{id}": { 4726 "get": { 4727 "produces": [ 4728 "application/json" 4729 ], 4730 "tags": [ 4731 "user" 4732 ], 4733 "summary": "Get a GPG key", 4734 "operationId": "userCurrentGetGPGKey", 4735 "parameters": [ 4736 { 4737 "type": "integer", 4738 "description": "id of key to get", 4739 "name": "id", 4740 "in": "path", 4741 "required": true 4742 } 4743 ], 4744 "responses": { 4745 "200": { 4746 "$ref": "#/responses/GPGKey" 4747 }, 4748 "404": { 4749 "$ref": "#/responses/notFound" 4750 } 4751 } 4752 }, 4753 "delete": { 4754 "produces": [ 4755 "application/json" 4756 ], 4757 "tags": [ 4758 "user" 4759 ], 4760 "summary": "Remove a GPG key", 4761 "operationId": "userCurrentDeleteGPGKey", 4762 "parameters": [ 4763 { 4764 "type": "integer", 4765 "description": "id of key to delete", 4766 "name": "id", 4767 "in": "path", 4768 "required": true 4769 } 4770 ], 4771 "responses": { 4772 "204": { 4773 "$ref": "#/responses/empty" 4774 }, 4775 "403": { 4776 "$ref": "#/responses/forbidden" 4777 } 4778 } 4779 } 4780 }, 4781 "/user/keys": { 4782 "get": { 4783 "produces": [ 4784 "application/json" 4785 ], 4786 "tags": [ 4787 "user" 4788 ], 4789 "summary": "List the authenticated user's public keys", 4790 "operationId": "userCurrentListKeys", 4791 "responses": { 4792 "200": { 4793 "$ref": "#/responses/PublicKeyList" 4794 } 4795 } 4796 }, 4797 "post": { 4798 "consumes": [ 4799 "application/json" 4800 ], 4801 "produces": [ 4802 "application/json" 4803 ], 4804 "tags": [ 4805 "user" 4806 ], 4807 "summary": "Create a public key", 4808 "operationId": "userCurrentPostKey", 4809 "parameters": [ 4810 { 4811 "name": "body", 4812 "in": "body", 4813 "schema": { 4814 "$ref": "#/definitions/CreateKeyOption" 4815 } 4816 } 4817 ], 4818 "responses": { 4819 "201": { 4820 "$ref": "#/responses/PublicKey" 4821 }, 4822 "422": { 4823 "$ref": "#/responses/validationError" 4824 } 4825 } 4826 } 4827 }, 4828 "/user/keys/{id}": { 4829 "get": { 4830 "produces": [ 4831 "application/json" 4832 ], 4833 "tags": [ 4834 "user" 4835 ], 4836 "summary": "Get a public key", 4837 "operationId": "userCurrentGetKey", 4838 "parameters": [ 4839 { 4840 "type": "integer", 4841 "description": "id of key to get", 4842 "name": "id", 4843 "in": "path", 4844 "required": true 4845 } 4846 ], 4847 "responses": { 4848 "200": { 4849 "$ref": "#/responses/PublicKey" 4850 }, 4851 "404": { 4852 "$ref": "#/responses/notFound" 4853 } 4854 } 4855 }, 4856 "delete": { 4857 "produces": [ 4858 "application/json" 4859 ], 4860 "tags": [ 4861 "user" 4862 ], 4863 "summary": "Delete a public key", 4864 "operationId": "userCurrentDeleteKey", 4865 "parameters": [ 4866 { 4867 "type": "integer", 4868 "description": "id of key to delete", 4869 "name": "id", 4870 "in": "path", 4871 "required": true 4872 } 4873 ], 4874 "responses": { 4875 "204": { 4876 "$ref": "#/responses/empty" 4877 }, 4878 "403": { 4879 "$ref": "#/responses/forbidden" 4880 }, 4881 "404": { 4882 "$ref": "#/responses/notFound" 4883 } 4884 } 4885 } 4886 }, 4887 "/user/orgs": { 4888 "get": { 4889 "produces": [ 4890 "application/json" 4891 ], 4892 "tags": [ 4893 "organization" 4894 ], 4895 "summary": "List the current user's organizations", 4896 "operationId": "orgListCurrentUserOrgs", 4897 "responses": { 4898 "200": { 4899 "$ref": "#/responses/OrganizationList" 4900 } 4901 } 4902 } 4903 }, 4904 "/user/repos": { 4905 "get": { 4906 "produces": [ 4907 "application/json" 4908 ], 4909 "tags": [ 4910 "user" 4911 ], 4912 "summary": "List the repos that the authenticated user owns or has access to", 4913 "operationId": "userCurrentListRepos", 4914 "responses": { 4915 "200": { 4916 "$ref": "#/responses/RepositoryList" 4917 } 4918 } 4919 }, 4920 "post": { 4921 "consumes": [ 4922 "application/json" 4923 ], 4924 "produces": [ 4925 "application/json" 4926 ], 4927 "tags": [ 4928 "repository", 4929 "user" 4930 ], 4931 "summary": "Create a repository", 4932 "operationId": "createCurrentUserRepo", 4933 "parameters": [ 4934 { 4935 "name": "body", 4936 "in": "body", 4937 "schema": { 4938 "$ref": "#/definitions/CreateRepoOption" 4939 } 4940 } 4941 ], 4942 "responses": { 4943 "201": { 4944 "$ref": "#/responses/Repository" 4945 } 4946 } 4947 } 4948 }, 4949 "/user/starred": { 4950 "get": { 4951 "produces": [ 4952 "application/json" 4953 ], 4954 "tags": [ 4955 "user" 4956 ], 4957 "summary": "The repos that the authenticated user has starred", 4958 "operationId": "userCurrentListStarred", 4959 "responses": { 4960 "200": { 4961 "$ref": "#/responses/RepositoryList" 4962 } 4963 } 4964 } 4965 }, 4966 "/user/starred/{owner}/{repo}": { 4967 "get": { 4968 "tags": [ 4969 "user" 4970 ], 4971 "summary": "Whether the authenticated is starring the repo", 4972 "operationId": "userCurrentCheckStarring", 4973 "parameters": [ 4974 { 4975 "type": "string", 4976 "description": "owner of the repo", 4977 "name": "owner", 4978 "in": "path", 4979 "required": true 4980 }, 4981 { 4982 "type": "string", 4983 "description": "name of the repo", 4984 "name": "repo", 4985 "in": "path", 4986 "required": true 4987 } 4988 ], 4989 "responses": { 4990 "204": { 4991 "$ref": "#/responses/empty" 4992 }, 4993 "404": { 4994 "$ref": "#/responses/notFound" 4995 } 4996 } 4997 }, 4998 "put": { 4999 "tags": [ 5000 "user" 5001 ], 5002 "summary": "Star the given repo", 5003 "operationId": "userCurrentPutStar", 5004 "parameters": [ 5005 { 5006 "type": "string", 5007 "description": "owner of the repo to star", 5008 "name": "owner", 5009 "in": "path", 5010 "required": true 5011 }, 5012 { 5013 "type": "string", 5014 "description": "name of the repo to star", 5015 "name": "repo", 5016 "in": "path", 5017 "required": true 5018 } 5019 ], 5020 "responses": { 5021 "204": { 5022 "$ref": "#/responses/empty" 5023 } 5024 } 5025 }, 5026 "delete": { 5027 "tags": [ 5028 "user" 5029 ], 5030 "summary": "Unstar the given repo", 5031 "operationId": "userCurrentDeleteStar", 5032 "parameters": [ 5033 { 5034 "type": "string", 5035 "description": "owner of the repo to unstar", 5036 "name": "owner", 5037 "in": "path", 5038 "required": true 5039 }, 5040 { 5041 "type": "string", 5042 "description": "name of the repo to unstar", 5043 "name": "repo", 5044 "in": "path", 5045 "required": true 5046 } 5047 ], 5048 "responses": { 5049 "204": { 5050 "$ref": "#/responses/empty" 5051 } 5052 } 5053 } 5054 }, 5055 "/user/subscriptions": { 5056 "get": { 5057 "produces": [ 5058 "application/json" 5059 ], 5060 "tags": [ 5061 "user" 5062 ], 5063 "summary": "List repositories watched by the authenticated user", 5064 "operationId": "userCurrentListSubscriptions", 5065 "responses": { 5066 "200": { 5067 "$ref": "#/responses/RepositoryList" 5068 } 5069 } 5070 } 5071 }, 5072 "/user/times": { 5073 "get": { 5074 "produces": [ 5075 "application/json" 5076 ], 5077 "tags": [ 5078 "user" 5079 ], 5080 "summary": "List the current user's tracked times", 5081 "operationId": "userCurrentTrackedTimes", 5082 "responses": { 5083 "200": { 5084 "$ref": "#/responses/TrackedTimeList" 5085 } 5086 } 5087 } 5088 }, 5089 "/user/{username}/orgs": { 5090 "get": { 5091 "produces": [ 5092 "application/json" 5093 ], 5094 "tags": [ 5095 "organization" 5096 ], 5097 "summary": "List a user's organizations", 5098 "operationId": "orgListUserOrgs", 5099 "parameters": [ 5100 { 5101 "type": "string", 5102 "description": "username of user", 5103 "name": "username", 5104 "in": "path", 5105 "required": true 5106 } 5107 ], 5108 "responses": { 5109 "200": { 5110 "$ref": "#/responses/OrganizationList" 5111 } 5112 } 5113 } 5114 }, 5115 "/users/search": { 5116 "get": { 5117 "produces": [ 5118 "application/json" 5119 ], 5120 "tags": [ 5121 "user" 5122 ], 5123 "summary": "Search for users", 5124 "operationId": "userSearch", 5125 "parameters": [ 5126 { 5127 "type": "string", 5128 "description": "keyword", 5129 "name": "q", 5130 "in": "query" 5131 }, 5132 { 5133 "type": "integer", 5134 "description": "maximum number of users to return", 5135 "name": "limit", 5136 "in": "query" 5137 } 5138 ], 5139 "responses": { 5140 "200": { 5141 "$ref": "#/responses/UserList" 5142 } 5143 } 5144 } 5145 }, 5146 "/users/{follower}/following/{followee}": { 5147 "get": { 5148 "tags": [ 5149 "user" 5150 ], 5151 "summary": "Check if one user is following another user", 5152 "operationId": "userCheckFollowing", 5153 "parameters": [ 5154 { 5155 "type": "string", 5156 "description": "username of following user", 5157 "name": "follower", 5158 "in": "path", 5159 "required": true 5160 }, 5161 { 5162 "type": "string", 5163 "description": "username of followed user", 5164 "name": "followee", 5165 "in": "path", 5166 "required": true 5167 } 5168 ], 5169 "responses": { 5170 "204": { 5171 "$ref": "#/responses/empty" 5172 }, 5173 "404": { 5174 "$ref": "#/responses/notFound" 5175 } 5176 } 5177 } 5178 }, 5179 "/users/{username}": { 5180 "get": { 5181 "produces": [ 5182 "application/json" 5183 ], 5184 "tags": [ 5185 "user" 5186 ], 5187 "summary": "Get a user", 5188 "operationId": "userGet", 5189 "parameters": [ 5190 { 5191 "type": "string", 5192 "description": "username of user to get", 5193 "name": "username", 5194 "in": "path", 5195 "required": true 5196 } 5197 ], 5198 "responses": { 5199 "200": { 5200 "$ref": "#/responses/User" 5201 }, 5202 "404": { 5203 "$ref": "#/responses/notFound" 5204 } 5205 } 5206 } 5207 }, 5208 "/users/{username}/followers": { 5209 "get": { 5210 "produces": [ 5211 "application/json" 5212 ], 5213 "tags": [ 5214 "user" 5215 ], 5216 "summary": "List the given user's followers", 5217 "operationId": "userListFollowers", 5218 "parameters": [ 5219 { 5220 "type": "string", 5221 "description": "username of user", 5222 "name": "username", 5223 "in": "path", 5224 "required": true 5225 } 5226 ], 5227 "responses": { 5228 "200": { 5229 "$ref": "#/responses/UserList" 5230 } 5231 } 5232 } 5233 }, 5234 "/users/{username}/following": { 5235 "get": { 5236 "produces": [ 5237 "application/json" 5238 ], 5239 "tags": [ 5240 "user" 5241 ], 5242 "summary": "List the users that the given user is following", 5243 "operationId": "userListFollowing", 5244 "parameters": [ 5245 { 5246 "type": "string", 5247 "description": "username of user", 5248 "name": "username", 5249 "in": "path", 5250 "required": true 5251 } 5252 ], 5253 "responses": { 5254 "200": { 5255 "$ref": "#/responses/UserList" 5256 } 5257 } 5258 } 5259 }, 5260 "/users/{username}/gpg_keys": { 5261 "get": { 5262 "produces": [ 5263 "application/json" 5264 ], 5265 "tags": [ 5266 "user" 5267 ], 5268 "summary": "List the given user's GPG keys", 5269 "operationId": "userListGPGKeys", 5270 "parameters": [ 5271 { 5272 "type": "string", 5273 "description": "username of user", 5274 "name": "username", 5275 "in": "path", 5276 "required": true 5277 } 5278 ], 5279 "responses": { 5280 "200": { 5281 "$ref": "#/responses/GPGKeyList" 5282 } 5283 } 5284 } 5285 }, 5286 "/users/{username}/keys": { 5287 "get": { 5288 "produces": [ 5289 "application/json" 5290 ], 5291 "tags": [ 5292 "user" 5293 ], 5294 "summary": "List the given user's public keys", 5295 "operationId": "userListKeys", 5296 "parameters": [ 5297 { 5298 "type": "string", 5299 "description": "username of user", 5300 "name": "username", 5301 "in": "path", 5302 "required": true 5303 } 5304 ], 5305 "responses": { 5306 "200": { 5307 "$ref": "#/responses/PublicKeyList" 5308 } 5309 } 5310 } 5311 }, 5312 "/users/{username}/repos": { 5313 "get": { 5314 "produces": [ 5315 "application/json" 5316 ], 5317 "tags": [ 5318 "user" 5319 ], 5320 "summary": "List the repos owned by the given user", 5321 "operationId": "userListRepos", 5322 "parameters": [ 5323 { 5324 "type": "string", 5325 "description": "username of user", 5326 "name": "username", 5327 "in": "path", 5328 "required": true 5329 } 5330 ], 5331 "responses": { 5332 "200": { 5333 "$ref": "#/responses/RepositoryList" 5334 } 5335 } 5336 } 5337 }, 5338 "/users/{username}/starred": { 5339 "get": { 5340 "produces": [ 5341 "application/json" 5342 ], 5343 "tags": [ 5344 "user" 5345 ], 5346 "summary": "The repos that the given user has starred", 5347 "operationId": "userListStarred", 5348 "parameters": [ 5349 { 5350 "type": "string", 5351 "description": "username of user", 5352 "name": "username", 5353 "in": "path", 5354 "required": true 5355 } 5356 ], 5357 "responses": { 5358 "200": { 5359 "$ref": "#/responses/RepositoryList" 5360 } 5361 } 5362 } 5363 }, 5364 "/users/{username}/subscriptions": { 5365 "get": { 5366 "produces": [ 5367 "application/json" 5368 ], 5369 "tags": [ 5370 "user" 5371 ], 5372 "summary": "List the repositories watched by a user", 5373 "operationId": "userListSubscriptions", 5374 "parameters": [ 5375 { 5376 "type": "string", 5377 "description": "username of the user", 5378 "name": "username", 5379 "in": "path", 5380 "required": true 5381 } 5382 ], 5383 "responses": { 5384 "200": { 5385 "$ref": "#/responses/RepositoryList" 5386 } 5387 } 5388 } 5389 }, 5390 "/users/{username}/tokens": { 5391 "get": { 5392 "produces": [ 5393 "application/json" 5394 ], 5395 "tags": [ 5396 "user" 5397 ], 5398 "summary": "List the authenticated user's access tokens", 5399 "operationId": "userGetTokens", 5400 "parameters": [ 5401 { 5402 "type": "string", 5403 "description": "username of user", 5404 "name": "username", 5405 "in": "path", 5406 "required": true 5407 } 5408 ], 5409 "responses": { 5410 "200": { 5411 "$ref": "#/responses/AccessTokenList" 5412 } 5413 } 5414 }, 5415 "post": { 5416 "consumes": [ 5417 "application/json" 5418 ], 5419 "produces": [ 5420 "application/json" 5421 ], 5422 "tags": [ 5423 "user" 5424 ], 5425 "summary": "Create an access token", 5426 "operationId": "userCreateToken", 5427 "parameters": [ 5428 { 5429 "type": "string", 5430 "x-go-name": "Name", 5431 "description": "username of user", 5432 "name": "username", 5433 "in": "path", 5434 "required": true 5435 } 5436 ], 5437 "responses": { 5438 "200": { 5439 "$ref": "#/responses/AccessToken" 5440 } 5441 } 5442 } 5443 }, 5444 "/users/{username}/tokens/{token}": { 5445 "delete": { 5446 "produces": [ 5447 "application/json" 5448 ], 5449 "tags": [ 5450 "user" 5451 ], 5452 "summary": "delete an access token", 5453 "operationId": "userDeleteAccessToken", 5454 "parameters": [ 5455 { 5456 "type": "string", 5457 "description": "username of user", 5458 "name": "username", 5459 "in": "path", 5460 "required": true 5461 }, 5462 { 5463 "type": "integer", 5464 "description": "token to be deleted", 5465 "name": "token", 5466 "in": "path", 5467 "required": true 5468 } 5469 ], 5470 "responses": { 5471 "204": { 5472 "$ref": "#/responses/empty" 5473 } 5474 } 5475 } 5476 }, 5477 "/version": { 5478 "get": { 5479 "produces": [ 5480 "application/json" 5481 ], 5482 "tags": [ 5483 "miscellaneous" 5484 ], 5485 "summary": "Returns the version of the Gitea application", 5486 "operationId": "getVersion", 5487 "responses": { 5488 "200": { 5489 "$ref": "#/responses/ServerVersion" 5490 } 5491 } 5492 } 5493 } 5494 }, 5495 "definitions": { 5496 "AddCollaboratorOption": { 5497 "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository", 5498 "type": "object", 5499 "properties": { 5500 "permission": { 5501 "type": "string", 5502 "x-go-name": "Permission" 5503 } 5504 }, 5505 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 5506 }, 5507 "AddTimeOption": { 5508 "description": "AddTimeOption options for adding time to an issue", 5509 "type": "object", 5510 "required": [ 5511 "time" 5512 ], 5513 "properties": { 5514 "time": { 5515 "description": "time in seconds", 5516 "type": "integer", 5517 "format": "int64", 5518 "x-go-name": "Time" 5519 } 5520 }, 5521 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 5522 }, 5523 "Attachment": { 5524 "description": "Attachment a generic attachment", 5525 "type": "object", 5526 "properties": { 5527 "browser_download_url": { 5528 "type": "string", 5529 "x-go-name": "DownloadURL" 5530 }, 5531 "created_at": { 5532 "type": "string", 5533 "format": "date-time", 5534 "x-go-name": "Created" 5535 }, 5536 "download_count": { 5537 "type": "integer", 5538 "format": "int64", 5539 "x-go-name": "DownloadCount" 5540 }, 5541 "id": { 5542 "type": "integer", 5543 "format": "int64", 5544 "x-go-name": "ID" 5545 }, 5546 "name": { 5547 "type": "string", 5548 "x-go-name": "Name" 5549 }, 5550 "size": { 5551 "type": "integer", 5552 "format": "int64", 5553 "x-go-name": "Size" 5554 }, 5555 "uuid": { 5556 "type": "string", 5557 "x-go-name": "UUID" 5558 } 5559 }, 5560 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 5561 }, 5562 "Branch": { 5563 "description": "Branch represents a repository branch", 5564 "type": "object", 5565 "properties": { 5566 "commit": { 5567 "$ref": "#/definitions/PayloadCommit" 5568 }, 5569 "name": { 5570 "type": "string", 5571 "x-go-name": "Name" 5572 } 5573 }, 5574 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 5575 }, 5576 "Comment": { 5577 "description": "Comment represents a comment on a commit or issue", 5578 "type": "object", 5579 "properties": { 5580 "body": { 5581 "type": "string", 5582 "x-go-name": "Body" 5583 }, 5584 "created_at": { 5585 "type": "string", 5586 "format": "date-time", 5587 "x-go-name": "Created" 5588 }, 5589 "html_url": { 5590 "type": "string", 5591 "x-go-name": "HTMLURL" 5592 }, 5593 "id": { 5594 "type": "integer", 5595 "format": "int64", 5596 "x-go-name": "ID" 5597 }, 5598 "issue_url": { 5599 "type": "string", 5600 "x-go-name": "IssueURL" 5601 }, 5602 "pull_request_url": { 5603 "type": "string", 5604 "x-go-name": "PRURL" 5605 }, 5606 "updated_at": { 5607 "type": "string", 5608 "format": "date-time", 5609 "x-go-name": "Updated" 5610 }, 5611 "user": { 5612 "$ref": "#/definitions/User" 5613 } 5614 }, 5615 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 5616 }, 5617 "CreateEmailOption": { 5618 "description": "CreateEmailOption options when creating email addresses", 5619 "type": "object", 5620 "properties": { 5621 "emails": { 5622 "description": "email addresses to add", 5623 "type": "array", 5624 "items": { 5625 "type": "string" 5626 }, 5627 "x-go-name": "Emails" 5628 } 5629 }, 5630 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 5631 }, 5632 "CreateForkOption": { 5633 "description": "CreateForkOption options for creating a fork", 5634 "type": "object", 5635 "properties": { 5636 "organization": { 5637 "description": "organization name, if forking into an organization", 5638 "type": "string", 5639 "x-go-name": "Organization" 5640 } 5641 }, 5642 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 5643 }, 5644 "CreateGPGKeyOption": { 5645 "description": "CreateGPGKeyOption options create user GPG key", 5646 "type": "object", 5647 "required": [ 5648 "armored_public_key" 5649 ], 5650 "properties": { 5651 "armored_public_key": { 5652 "description": "An armored GPG key to add", 5653 "type": "string", 5654 "uniqueItems": true, 5655 "x-go-name": "ArmoredKey" 5656 } 5657 }, 5658 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 5659 }, 5660 "CreateHookOption": { 5661 "description": "CreateHookOption options when create a hook", 5662 "type": "object", 5663 "required": [ 5664 "type", 5665 "config" 5666 ], 5667 "properties": { 5668 "active": { 5669 "type": "boolean", 5670 "default": false, 5671 "x-go-name": "Active" 5672 }, 5673 "config": { 5674 "type": "object", 5675 "additionalProperties": { 5676 "type": "string" 5677 }, 5678 "x-go-name": "Config" 5679 }, 5680 "events": { 5681 "type": "array", 5682 "items": { 5683 "type": "string" 5684 }, 5685 "x-go-name": "Events" 5686 }, 5687 "type": { 5688 "type": "string", 5689 "enum": [ 5690 "gitea", 5691 "gogs", 5692 "slack", 5693 "discord" 5694 ], 5695 "x-go-name": "Type" 5696 } 5697 }, 5698 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 5699 }, 5700 "CreateIssueCommentOption": { 5701 "description": "CreateIssueCommentOption options for creating a comment on an issue", 5702 "type": "object", 5703 "required": [ 5704 "body" 5705 ], 5706 "properties": { 5707 "body": { 5708 "type": "string", 5709 "x-go-name": "Body" 5710 } 5711 }, 5712 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 5713 }, 5714 "CreateIssueOption": { 5715 "description": "CreateIssueOption options to create one issue", 5716 "type": "object", 5717 "required": [ 5718 "title" 5719 ], 5720 "properties": { 5721 "assignee": { 5722 "description": "username of assignee", 5723 "type": "string", 5724 "x-go-name": "Assignee" 5725 }, 5726 "assignees": { 5727 "type": "array", 5728 "items": { 5729 "type": "string" 5730 }, 5731 "x-go-name": "Assignees" 5732 }, 5733 "body": { 5734 "type": "string", 5735 "x-go-name": "Body" 5736 }, 5737 "closed": { 5738 "type": "boolean", 5739 "x-go-name": "Closed" 5740 }, 5741 "due_date": { 5742 "type": "string", 5743 "format": "date-time", 5744 "x-go-name": "Deadline" 5745 }, 5746 "labels": { 5747 "description": "list of label ids", 5748 "type": "array", 5749 "items": { 5750 "type": "integer", 5751 "format": "int64" 5752 }, 5753 "x-go-name": "Labels" 5754 }, 5755 "milestone": { 5756 "description": "milestone id", 5757 "type": "integer", 5758 "format": "int64", 5759 "x-go-name": "Milestone" 5760 }, 5761 "title": { 5762 "type": "string", 5763 "x-go-name": "Title" 5764 } 5765 }, 5766 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 5767 }, 5768 "CreateKeyOption": { 5769 "description": "CreateKeyOption options when creating a key", 5770 "type": "object", 5771 "required": [ 5772 "title", 5773 "key" 5774 ], 5775 "properties": { 5776 "key": { 5777 "description": "An armored SSH key to add", 5778 "type": "string", 5779 "uniqueItems": true, 5780 "x-go-name": "Key" 5781 }, 5782 "read_only": { 5783 "description": "Describe if the key has only read access or read/write", 5784 "type": "boolean", 5785 "x-go-name": "ReadOnly" 5786 }, 5787 "title": { 5788 "description": "Title of the key to add", 5789 "type": "string", 5790 "uniqueItems": true, 5791 "x-go-name": "Title" 5792 } 5793 }, 5794 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 5795 }, 5796 "CreateLabelOption": { 5797 "description": "CreateLabelOption options for creating a label", 5798 "type": "object", 5799 "required": [ 5800 "name", 5801 "color" 5802 ], 5803 "properties": { 5804 "color": { 5805 "type": "string", 5806 "x-go-name": "Color", 5807 "example": "#00aabb" 5808 }, 5809 "name": { 5810 "type": "string", 5811 "x-go-name": "Name" 5812 } 5813 }, 5814 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 5815 }, 5816 "CreateMilestoneOption": { 5817 "description": "CreateMilestoneOption options for creating a milestone", 5818 "type": "object", 5819 "properties": { 5820 "description": { 5821 "type": "string", 5822 "x-go-name": "Description" 5823 }, 5824 "due_on": { 5825 "type": "string", 5826 "format": "date-time", 5827 "x-go-name": "Deadline" 5828 }, 5829 "title": { 5830 "type": "string", 5831 "x-go-name": "Title" 5832 } 5833 }, 5834 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 5835 }, 5836 "CreateOrgOption": { 5837 "description": "CreateOrgOption options for creating an organization", 5838 "type": "object", 5839 "required": [ 5840 "username" 5841 ], 5842 "properties": { 5843 "description": { 5844 "type": "string", 5845 "x-go-name": "Description" 5846 }, 5847 "full_name": { 5848 "type": "string", 5849 "x-go-name": "FullName" 5850 }, 5851 "location": { 5852 "type": "string", 5853 "x-go-name": "Location" 5854 }, 5855 "username": { 5856 "type": "string", 5857 "x-go-name": "UserName" 5858 }, 5859 "website": { 5860 "type": "string", 5861 "x-go-name": "Website" 5862 } 5863 }, 5864 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 5865 }, 5866 "CreatePullRequestOption": { 5867 "description": "CreatePullRequestOption options when creating a pull request", 5868 "type": "object", 5869 "properties": { 5870 "assignee": { 5871 "type": "string", 5872 "x-go-name": "Assignee" 5873 }, 5874 "assignees": { 5875 "type": "array", 5876 "items": { 5877 "type": "string" 5878 }, 5879 "x-go-name": "Assignees" 5880 }, 5881 "base": { 5882 "type": "string", 5883 "x-go-name": "Base" 5884 }, 5885 "body": { 5886 "type": "string", 5887 "x-go-name": "Body" 5888 }, 5889 "due_date": { 5890 "type": "string", 5891 "format": "date-time", 5892 "x-go-name": "Deadline" 5893 }, 5894 "head": { 5895 "type": "string", 5896 "x-go-name": "Head" 5897 }, 5898 "labels": { 5899 "type": "array", 5900 "items": { 5901 "type": "integer", 5902 "format": "int64" 5903 }, 5904 "x-go-name": "Labels" 5905 }, 5906 "milestone": { 5907 "type": "integer", 5908 "format": "int64", 5909 "x-go-name": "Milestone" 5910 }, 5911 "title": { 5912 "type": "string", 5913 "x-go-name": "Title" 5914 } 5915 }, 5916 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 5917 }, 5918 "CreateReleaseOption": { 5919 "description": "CreateReleaseOption options when creating a release", 5920 "type": "object", 5921 "required": [ 5922 "tag_name" 5923 ], 5924 "properties": { 5925 "body": { 5926 "type": "string", 5927 "x-go-name": "Note" 5928 }, 5929 "draft": { 5930 "type": "boolean", 5931 "x-go-name": "IsDraft" 5932 }, 5933 "name": { 5934 "type": "string", 5935 "x-go-name": "Title" 5936 }, 5937 "prerelease": { 5938 "type": "boolean", 5939 "x-go-name": "IsPrerelease" 5940 }, 5941 "tag_name": { 5942 "type": "string", 5943 "x-go-name": "TagName" 5944 }, 5945 "target_commitish": { 5946 "type": "string", 5947 "x-go-name": "Target" 5948 } 5949 }, 5950 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 5951 }, 5952 "CreateRepoOption": { 5953 "description": "CreateRepoOption options when creating repository", 5954 "type": "object", 5955 "required": [ 5956 "name" 5957 ], 5958 "properties": { 5959 "auto_init": { 5960 "description": "Whether the repository should be auto-intialized?", 5961 "type": "boolean", 5962 "x-go-name": "AutoInit" 5963 }, 5964 "description": { 5965 "description": "Description of the repository to create", 5966 "type": "string", 5967 "x-go-name": "Description" 5968 }, 5969 "gitignores": { 5970 "description": "Gitignores to use", 5971 "type": "string", 5972 "x-go-name": "Gitignores" 5973 }, 5974 "license": { 5975 "description": "License to use", 5976 "type": "string", 5977 "x-go-name": "License" 5978 }, 5979 "name": { 5980 "description": "Name of the repository to create", 5981 "type": "string", 5982 "uniqueItems": true, 5983 "x-go-name": "Name" 5984 }, 5985 "private": { 5986 "description": "Whether the repository is private", 5987 "type": "boolean", 5988 "x-go-name": "Private" 5989 }, 5990 "readme": { 5991 "description": "Readme of the repository to create", 5992 "type": "string", 5993 "x-go-name": "Readme" 5994 } 5995 }, 5996 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 5997 }, 5998 "CreateStatusOption": { 5999 "description": "CreateStatusOption holds the information needed to create a new Status for a Commit", 6000 "type": "object", 6001 "properties": { 6002 "context": { 6003 "type": "string", 6004 "x-go-name": "Context" 6005 }, 6006 "description": { 6007 "type": "string", 6008 "x-go-name": "Description" 6009 }, 6010 "state": { 6011 "$ref": "#/definitions/StatusState" 6012 }, 6013 "target_url": { 6014 "type": "string", 6015 "x-go-name": "TargetURL" 6016 } 6017 }, 6018 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6019 }, 6020 "CreateTeamOption": { 6021 "description": "CreateTeamOption options for creating a team", 6022 "type": "object", 6023 "required": [ 6024 "name" 6025 ], 6026 "properties": { 6027 "description": { 6028 "type": "string", 6029 "x-go-name": "Description" 6030 }, 6031 "name": { 6032 "type": "string", 6033 "x-go-name": "Name" 6034 }, 6035 "permission": { 6036 "type": "string", 6037 "enum": [ 6038 "read", 6039 "write", 6040 "admin" 6041 ], 6042 "x-go-name": "Permission" 6043 } 6044 }, 6045 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6046 }, 6047 "CreateUserOption": { 6048 "description": "CreateUserOption create user options", 6049 "type": "object", 6050 "required": [ 6051 "username", 6052 "email", 6053 "password" 6054 ], 6055 "properties": { 6056 "email": { 6057 "type": "string", 6058 "format": "email", 6059 "x-go-name": "Email" 6060 }, 6061 "full_name": { 6062 "type": "string", 6063 "x-go-name": "FullName" 6064 }, 6065 "login_name": { 6066 "type": "string", 6067 "x-go-name": "LoginName" 6068 }, 6069 "password": { 6070 "type": "string", 6071 "x-go-name": "Password" 6072 }, 6073 "send_notify": { 6074 "type": "boolean", 6075 "x-go-name": "SendNotify" 6076 }, 6077 "source_id": { 6078 "type": "integer", 6079 "format": "int64", 6080 "x-go-name": "SourceID" 6081 }, 6082 "username": { 6083 "type": "string", 6084 "x-go-name": "Username" 6085 } 6086 }, 6087 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6088 }, 6089 "DeleteEmailOption": { 6090 "description": "DeleteEmailOption options when deleting email addresses", 6091 "type": "object", 6092 "properties": { 6093 "emails": { 6094 "description": "email addresses to delete", 6095 "type": "array", 6096 "items": { 6097 "type": "string" 6098 }, 6099 "x-go-name": "Emails" 6100 } 6101 }, 6102 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6103 }, 6104 "DeployKey": { 6105 "description": "DeployKey a deploy key", 6106 "type": "object", 6107 "properties": { 6108 "created_at": { 6109 "type": "string", 6110 "format": "date-time", 6111 "x-go-name": "Created" 6112 }, 6113 "id": { 6114 "type": "integer", 6115 "format": "int64", 6116 "x-go-name": "ID" 6117 }, 6118 "key": { 6119 "type": "string", 6120 "x-go-name": "Key" 6121 }, 6122 "read_only": { 6123 "type": "boolean", 6124 "x-go-name": "ReadOnly" 6125 }, 6126 "title": { 6127 "type": "string", 6128 "x-go-name": "Title" 6129 }, 6130 "url": { 6131 "type": "string", 6132 "x-go-name": "URL" 6133 } 6134 }, 6135 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6136 }, 6137 "EditAttachmentOptions": { 6138 "description": "EditAttachmentOptions options for editing attachments", 6139 "type": "object", 6140 "properties": { 6141 "name": { 6142 "type": "string", 6143 "x-go-name": "Name" 6144 } 6145 }, 6146 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6147 }, 6148 "EditHookOption": { 6149 "description": "EditHookOption options when modify one hook", 6150 "type": "object", 6151 "properties": { 6152 "active": { 6153 "type": "boolean", 6154 "x-go-name": "Active" 6155 }, 6156 "config": { 6157 "type": "object", 6158 "additionalProperties": { 6159 "type": "string" 6160 }, 6161 "x-go-name": "Config" 6162 }, 6163 "events": { 6164 "type": "array", 6165 "items": { 6166 "type": "string" 6167 }, 6168 "x-go-name": "Events" 6169 } 6170 }, 6171 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6172 }, 6173 "EditIssueCommentOption": { 6174 "description": "EditIssueCommentOption options for editing a comment", 6175 "type": "object", 6176 "required": [ 6177 "body" 6178 ], 6179 "properties": { 6180 "body": { 6181 "type": "string", 6182 "x-go-name": "Body" 6183 } 6184 }, 6185 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6186 }, 6187 "EditIssueOption": { 6188 "description": "EditIssueOption options for editing an issue", 6189 "type": "object", 6190 "properties": { 6191 "assignee": { 6192 "type": "string", 6193 "x-go-name": "Assignee" 6194 }, 6195 "assignees": { 6196 "type": "array", 6197 "items": { 6198 "type": "string" 6199 }, 6200 "x-go-name": "Assignees" 6201 }, 6202 "body": { 6203 "type": "string", 6204 "x-go-name": "Body" 6205 }, 6206 "due_date": { 6207 "type": "string", 6208 "format": "date-time", 6209 "x-go-name": "Deadline" 6210 }, 6211 "milestone": { 6212 "type": "integer", 6213 "format": "int64", 6214 "x-go-name": "Milestone" 6215 }, 6216 "state": { 6217 "type": "string", 6218 "x-go-name": "State" 6219 }, 6220 "title": { 6221 "type": "string", 6222 "x-go-name": "Title" 6223 } 6224 }, 6225 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6226 }, 6227 "EditLabelOption": { 6228 "description": "EditLabelOption options for editing a label", 6229 "type": "object", 6230 "properties": { 6231 "color": { 6232 "type": "string", 6233 "x-go-name": "Color" 6234 }, 6235 "name": { 6236 "type": "string", 6237 "x-go-name": "Name" 6238 } 6239 }, 6240 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6241 }, 6242 "EditMilestoneOption": { 6243 "description": "EditMilestoneOption options for editing a milestone", 6244 "type": "object", 6245 "properties": { 6246 "description": { 6247 "type": "string", 6248 "x-go-name": "Description" 6249 }, 6250 "due_on": { 6251 "type": "string", 6252 "format": "date-time", 6253 "x-go-name": "Deadline" 6254 }, 6255 "state": { 6256 "type": "string", 6257 "x-go-name": "State" 6258 }, 6259 "title": { 6260 "type": "string", 6261 "x-go-name": "Title" 6262 } 6263 }, 6264 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6265 }, 6266 "EditOrgOption": { 6267 "description": "EditOrgOption options for editing an organization", 6268 "type": "object", 6269 "properties": { 6270 "description": { 6271 "type": "string", 6272 "x-go-name": "Description" 6273 }, 6274 "full_name": { 6275 "type": "string", 6276 "x-go-name": "FullName" 6277 }, 6278 "location": { 6279 "type": "string", 6280 "x-go-name": "Location" 6281 }, 6282 "website": { 6283 "type": "string", 6284 "x-go-name": "Website" 6285 } 6286 }, 6287 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6288 }, 6289 "EditPullRequestOption": { 6290 "description": "EditPullRequestOption options when modify pull request", 6291 "type": "object", 6292 "properties": { 6293 "assignee": { 6294 "type": "string", 6295 "x-go-name": "Assignee" 6296 }, 6297 "assignees": { 6298 "type": "array", 6299 "items": { 6300 "type": "string" 6301 }, 6302 "x-go-name": "Assignees" 6303 }, 6304 "body": { 6305 "type": "string", 6306 "x-go-name": "Body" 6307 }, 6308 "due_date": { 6309 "type": "string", 6310 "format": "date-time", 6311 "x-go-name": "Deadline" 6312 }, 6313 "labels": { 6314 "type": "array", 6315 "items": { 6316 "type": "integer", 6317 "format": "int64" 6318 }, 6319 "x-go-name": "Labels" 6320 }, 6321 "milestone": { 6322 "type": "integer", 6323 "format": "int64", 6324 "x-go-name": "Milestone" 6325 }, 6326 "state": { 6327 "type": "string", 6328 "x-go-name": "State" 6329 }, 6330 "title": { 6331 "type": "string", 6332 "x-go-name": "Title" 6333 } 6334 }, 6335 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6336 }, 6337 "EditReleaseOption": { 6338 "description": "EditReleaseOption options when editing a release", 6339 "type": "object", 6340 "properties": { 6341 "body": { 6342 "type": "string", 6343 "x-go-name": "Note" 6344 }, 6345 "draft": { 6346 "type": "boolean", 6347 "x-go-name": "IsDraft" 6348 }, 6349 "name": { 6350 "type": "string", 6351 "x-go-name": "Title" 6352 }, 6353 "prerelease": { 6354 "type": "boolean", 6355 "x-go-name": "IsPrerelease" 6356 }, 6357 "tag_name": { 6358 "type": "string", 6359 "x-go-name": "TagName" 6360 }, 6361 "target_commitish": { 6362 "type": "string", 6363 "x-go-name": "Target" 6364 } 6365 }, 6366 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6367 }, 6368 "EditTeamOption": { 6369 "description": "EditTeamOption options for editing a team", 6370 "type": "object", 6371 "required": [ 6372 "name" 6373 ], 6374 "properties": { 6375 "description": { 6376 "type": "string", 6377 "x-go-name": "Description" 6378 }, 6379 "name": { 6380 "type": "string", 6381 "x-go-name": "Name" 6382 }, 6383 "permission": { 6384 "type": "string", 6385 "enum": [ 6386 "read", 6387 "write", 6388 "admin" 6389 ], 6390 "x-go-name": "Permission" 6391 } 6392 }, 6393 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6394 }, 6395 "EditUserOption": { 6396 "description": "EditUserOption edit user options", 6397 "type": "object", 6398 "required": [ 6399 "email" 6400 ], 6401 "properties": { 6402 "active": { 6403 "type": "boolean", 6404 "x-go-name": "Active" 6405 }, 6406 "admin": { 6407 "type": "boolean", 6408 "x-go-name": "Admin" 6409 }, 6410 "allow_git_hook": { 6411 "type": "boolean", 6412 "x-go-name": "AllowGitHook" 6413 }, 6414 "allow_import_local": { 6415 "type": "boolean", 6416 "x-go-name": "AllowImportLocal" 6417 }, 6418 "email": { 6419 "type": "string", 6420 "format": "email", 6421 "x-go-name": "Email" 6422 }, 6423 "full_name": { 6424 "type": "string", 6425 "x-go-name": "FullName" 6426 }, 6427 "location": { 6428 "type": "string", 6429 "x-go-name": "Location" 6430 }, 6431 "login_name": { 6432 "type": "string", 6433 "x-go-name": "LoginName" 6434 }, 6435 "max_repo_creation": { 6436 "type": "integer", 6437 "format": "int64", 6438 "x-go-name": "MaxRepoCreation" 6439 }, 6440 "password": { 6441 "type": "string", 6442 "x-go-name": "Password" 6443 }, 6444 "source_id": { 6445 "type": "integer", 6446 "format": "int64", 6447 "x-go-name": "SourceID" 6448 }, 6449 "website": { 6450 "type": "string", 6451 "x-go-name": "Website" 6452 } 6453 }, 6454 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6455 }, 6456 "Email": { 6457 "description": "Email an email address belonging to a user", 6458 "type": "object", 6459 "properties": { 6460 "email": { 6461 "type": "string", 6462 "format": "email", 6463 "x-go-name": "Email" 6464 }, 6465 "primary": { 6466 "type": "boolean", 6467 "x-go-name": "Primary" 6468 }, 6469 "verified": { 6470 "type": "boolean", 6471 "x-go-name": "Verified" 6472 } 6473 }, 6474 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6475 }, 6476 "GPGKey": { 6477 "description": "GPGKey a user GPG key to sign commit and tag in repository", 6478 "type": "object", 6479 "properties": { 6480 "can_certify": { 6481 "type": "boolean", 6482 "x-go-name": "CanCertify" 6483 }, 6484 "can_encrypt_comms": { 6485 "type": "boolean", 6486 "x-go-name": "CanEncryptComms" 6487 }, 6488 "can_encrypt_storage": { 6489 "type": "boolean", 6490 "x-go-name": "CanEncryptStorage" 6491 }, 6492 "can_sign": { 6493 "type": "boolean", 6494 "x-go-name": "CanSign" 6495 }, 6496 "created_at": { 6497 "type": "string", 6498 "format": "date-time", 6499 "x-go-name": "Created" 6500 }, 6501 "emails": { 6502 "type": "array", 6503 "items": { 6504 "$ref": "#/definitions/GPGKeyEmail" 6505 }, 6506 "x-go-name": "Emails" 6507 }, 6508 "expires_at": { 6509 "type": "string", 6510 "format": "date-time", 6511 "x-go-name": "Expires" 6512 }, 6513 "id": { 6514 "type": "integer", 6515 "format": "int64", 6516 "x-go-name": "ID" 6517 }, 6518 "key_id": { 6519 "type": "string", 6520 "x-go-name": "KeyID" 6521 }, 6522 "primary_key_id": { 6523 "type": "string", 6524 "x-go-name": "PrimaryKeyID" 6525 }, 6526 "public_key": { 6527 "type": "string", 6528 "x-go-name": "PublicKey" 6529 }, 6530 "subkeys": { 6531 "type": "array", 6532 "items": { 6533 "$ref": "#/definitions/GPGKey" 6534 }, 6535 "x-go-name": "SubsKey" 6536 } 6537 }, 6538 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6539 }, 6540 "GPGKeyEmail": { 6541 "description": "GPGKeyEmail an email attached to a GPGKey", 6542 "type": "object", 6543 "properties": { 6544 "email": { 6545 "type": "string", 6546 "x-go-name": "Email" 6547 }, 6548 "verified": { 6549 "type": "boolean", 6550 "x-go-name": "Verified" 6551 } 6552 }, 6553 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6554 }, 6555 "Issue": { 6556 "description": "Issue represents an issue in a repository", 6557 "type": "object", 6558 "properties": { 6559 "assignee": { 6560 "$ref": "#/definitions/User" 6561 }, 6562 "assignees": { 6563 "type": "array", 6564 "items": { 6565 "$ref": "#/definitions/User" 6566 }, 6567 "x-go-name": "Assignees" 6568 }, 6569 "body": { 6570 "type": "string", 6571 "x-go-name": "Body" 6572 }, 6573 "closed_at": { 6574 "type": "string", 6575 "format": "date-time", 6576 "x-go-name": "Closed" 6577 }, 6578 "comments": { 6579 "type": "integer", 6580 "format": "int64", 6581 "x-go-name": "Comments" 6582 }, 6583 "created_at": { 6584 "type": "string", 6585 "format": "date-time", 6586 "x-go-name": "Created" 6587 }, 6588 "due_date": { 6589 "type": "string", 6590 "format": "date-time", 6591 "x-go-name": "Deadline" 6592 }, 6593 "id": { 6594 "type": "integer", 6595 "format": "int64", 6596 "x-go-name": "ID" 6597 }, 6598 "labels": { 6599 "type": "array", 6600 "items": { 6601 "$ref": "#/definitions/Label" 6602 }, 6603 "x-go-name": "Labels" 6604 }, 6605 "milestone": { 6606 "$ref": "#/definitions/Milestone" 6607 }, 6608 "number": { 6609 "type": "integer", 6610 "format": "int64", 6611 "x-go-name": "Index" 6612 }, 6613 "pull_request": { 6614 "$ref": "#/definitions/PullRequestMeta" 6615 }, 6616 "state": { 6617 "$ref": "#/definitions/StateType" 6618 }, 6619 "title": { 6620 "type": "string", 6621 "x-go-name": "Title" 6622 }, 6623 "updated_at": { 6624 "type": "string", 6625 "format": "date-time", 6626 "x-go-name": "Updated" 6627 }, 6628 "url": { 6629 "type": "string", 6630 "x-go-name": "URL" 6631 }, 6632 "user": { 6633 "$ref": "#/definitions/User" 6634 } 6635 }, 6636 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6637 }, 6638 "IssueLabelsOption": { 6639 "description": "IssueLabelsOption a collection of labels", 6640 "type": "object", 6641 "properties": { 6642 "labels": { 6643 "description": "list of label IDs", 6644 "type": "array", 6645 "items": { 6646 "type": "integer", 6647 "format": "int64" 6648 }, 6649 "x-go-name": "Labels" 6650 } 6651 }, 6652 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6653 }, 6654 "Label": { 6655 "description": "Label a label to an issue or a pr", 6656 "type": "object", 6657 "properties": { 6658 "color": { 6659 "type": "string", 6660 "x-go-name": "Color", 6661 "example": "00aabb" 6662 }, 6663 "id": { 6664 "type": "integer", 6665 "format": "int64", 6666 "x-go-name": "ID" 6667 }, 6668 "name": { 6669 "type": "string", 6670 "x-go-name": "Name" 6671 }, 6672 "url": { 6673 "type": "string", 6674 "x-go-name": "URL" 6675 } 6676 }, 6677 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6678 }, 6679 "MarkdownOption": { 6680 "description": "MarkdownOption markdown options", 6681 "type": "object", 6682 "properties": { 6683 "Context": { 6684 "description": "Context to render\n\nin: body", 6685 "type": "string" 6686 }, 6687 "Mode": { 6688 "description": "Mode to render\n\nin: body", 6689 "type": "string" 6690 }, 6691 "Text": { 6692 "description": "Text markdown to render\n\nin: body", 6693 "type": "string" 6694 }, 6695 "Wiki": { 6696 "description": "Is it a wiki page ?\n\nin: body", 6697 "type": "boolean" 6698 } 6699 }, 6700 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6701 }, 6702 "MigrateRepoForm": { 6703 "description": "MigrateRepoForm form for migrating repository", 6704 "type": "object", 6705 "required": [ 6706 "clone_addr", 6707 "uid", 6708 "repo_name" 6709 ], 6710 "properties": { 6711 "auth_password": { 6712 "type": "string", 6713 "x-go-name": "AuthPassword" 6714 }, 6715 "auth_username": { 6716 "type": "string", 6717 "x-go-name": "AuthUsername" 6718 }, 6719 "clone_addr": { 6720 "type": "string", 6721 "x-go-name": "CloneAddr" 6722 }, 6723 "description": { 6724 "type": "string", 6725 "x-go-name": "Description" 6726 }, 6727 "mirror": { 6728 "type": "boolean", 6729 "x-go-name": "Mirror" 6730 }, 6731 "private": { 6732 "type": "boolean", 6733 "x-go-name": "Private" 6734 }, 6735 "repo_name": { 6736 "type": "string", 6737 "x-go-name": "RepoName" 6738 }, 6739 "uid": { 6740 "type": "integer", 6741 "format": "int64", 6742 "x-go-name": "UID" 6743 } 6744 }, 6745 "x-go-package": "code.gitea.io/gitea/modules/auth" 6746 }, 6747 "Milestone": { 6748 "description": "Milestone milestone is a collection of issues on one repository", 6749 "type": "object", 6750 "properties": { 6751 "closed_at": { 6752 "type": "string", 6753 "format": "date-time", 6754 "x-go-name": "Closed" 6755 }, 6756 "closed_issues": { 6757 "type": "integer", 6758 "format": "int64", 6759 "x-go-name": "ClosedIssues" 6760 }, 6761 "description": { 6762 "type": "string", 6763 "x-go-name": "Description" 6764 }, 6765 "due_on": { 6766 "type": "string", 6767 "format": "date-time", 6768 "x-go-name": "Deadline" 6769 }, 6770 "id": { 6771 "type": "integer", 6772 "format": "int64", 6773 "x-go-name": "ID" 6774 }, 6775 "open_issues": { 6776 "type": "integer", 6777 "format": "int64", 6778 "x-go-name": "OpenIssues" 6779 }, 6780 "state": { 6781 "$ref": "#/definitions/StateType" 6782 }, 6783 "title": { 6784 "type": "string", 6785 "x-go-name": "Title" 6786 } 6787 }, 6788 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6789 }, 6790 "Organization": { 6791 "description": "Organization represents an organization", 6792 "type": "object", 6793 "properties": { 6794 "avatar_url": { 6795 "type": "string", 6796 "x-go-name": "AvatarURL" 6797 }, 6798 "description": { 6799 "type": "string", 6800 "x-go-name": "Description" 6801 }, 6802 "full_name": { 6803 "type": "string", 6804 "x-go-name": "FullName" 6805 }, 6806 "id": { 6807 "type": "integer", 6808 "format": "int64", 6809 "x-go-name": "ID" 6810 }, 6811 "location": { 6812 "type": "string", 6813 "x-go-name": "Location" 6814 }, 6815 "username": { 6816 "type": "string", 6817 "x-go-name": "UserName" 6818 }, 6819 "website": { 6820 "type": "string", 6821 "x-go-name": "Website" 6822 } 6823 }, 6824 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6825 }, 6826 "PRBranchInfo": { 6827 "description": "PRBranchInfo information about a branch", 6828 "type": "object", 6829 "properties": { 6830 "label": { 6831 "type": "string", 6832 "x-go-name": "Name" 6833 }, 6834 "ref": { 6835 "type": "string", 6836 "x-go-name": "Ref" 6837 }, 6838 "repo": { 6839 "$ref": "#/definitions/Repository" 6840 }, 6841 "repo_id": { 6842 "type": "integer", 6843 "format": "int64", 6844 "x-go-name": "RepoID" 6845 }, 6846 "sha": { 6847 "type": "string", 6848 "x-go-name": "Sha" 6849 } 6850 }, 6851 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6852 }, 6853 "PayloadCommit": { 6854 "description": "PayloadCommit represents a commit", 6855 "type": "object", 6856 "properties": { 6857 "author": { 6858 "$ref": "#/definitions/PayloadUser" 6859 }, 6860 "committer": { 6861 "$ref": "#/definitions/PayloadUser" 6862 }, 6863 "id": { 6864 "description": "sha1 hash of the commit", 6865 "type": "string", 6866 "x-go-name": "ID" 6867 }, 6868 "message": { 6869 "type": "string", 6870 "x-go-name": "Message" 6871 }, 6872 "timestamp": { 6873 "type": "string", 6874 "format": "date-time", 6875 "x-go-name": "Timestamp" 6876 }, 6877 "url": { 6878 "type": "string", 6879 "x-go-name": "URL" 6880 }, 6881 "verification": { 6882 "$ref": "#/definitions/PayloadCommitVerification" 6883 } 6884 }, 6885 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6886 }, 6887 "PayloadCommitVerification": { 6888 "description": "PayloadCommitVerification represents the GPG verification of a commit", 6889 "type": "object", 6890 "properties": { 6891 "payload": { 6892 "type": "string", 6893 "x-go-name": "Payload" 6894 }, 6895 "reason": { 6896 "type": "string", 6897 "x-go-name": "Reason" 6898 }, 6899 "signature": { 6900 "type": "string", 6901 "x-go-name": "Signature" 6902 }, 6903 "verified": { 6904 "type": "boolean", 6905 "x-go-name": "Verified" 6906 } 6907 }, 6908 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6909 }, 6910 "PayloadUser": { 6911 "description": "PayloadUser represents the author or committer of a commit", 6912 "type": "object", 6913 "properties": { 6914 "email": { 6915 "type": "string", 6916 "format": "email", 6917 "x-go-name": "Email" 6918 }, 6919 "name": { 6920 "description": "Full name of the commit author", 6921 "type": "string", 6922 "x-go-name": "Name" 6923 }, 6924 "username": { 6925 "type": "string", 6926 "x-go-name": "UserName" 6927 } 6928 }, 6929 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6930 }, 6931 "Permission": { 6932 "description": "Permission represents a set of permissions", 6933 "type": "object", 6934 "properties": { 6935 "admin": { 6936 "type": "boolean", 6937 "x-go-name": "Admin" 6938 }, 6939 "pull": { 6940 "type": "boolean", 6941 "x-go-name": "Pull" 6942 }, 6943 "push": { 6944 "type": "boolean", 6945 "x-go-name": "Push" 6946 } 6947 }, 6948 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6949 }, 6950 "PublicKey": { 6951 "description": "PublicKey publickey is a user key to push code to repository", 6952 "type": "object", 6953 "properties": { 6954 "created_at": { 6955 "type": "string", 6956 "format": "date-time", 6957 "x-go-name": "Created" 6958 }, 6959 "fingerprint": { 6960 "type": "string", 6961 "x-go-name": "Fingerprint" 6962 }, 6963 "id": { 6964 "type": "integer", 6965 "format": "int64", 6966 "x-go-name": "ID" 6967 }, 6968 "key": { 6969 "type": "string", 6970 "x-go-name": "Key" 6971 }, 6972 "title": { 6973 "type": "string", 6974 "x-go-name": "Title" 6975 }, 6976 "url": { 6977 "type": "string", 6978 "x-go-name": "URL" 6979 } 6980 }, 6981 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 6982 }, 6983 "PullRequest": { 6984 "description": "PullRequest represents a pull request", 6985 "type": "object", 6986 "properties": { 6987 "assignee": { 6988 "$ref": "#/definitions/User" 6989 }, 6990 "assignees": { 6991 "type": "array", 6992 "items": { 6993 "$ref": "#/definitions/User" 6994 }, 6995 "x-go-name": "Assignees" 6996 }, 6997 "base": { 6998 "$ref": "#/definitions/PRBranchInfo" 6999 }, 7000 "body": { 7001 "type": "string", 7002 "x-go-name": "Body" 7003 }, 7004 "closed_at": { 7005 "type": "string", 7006 "format": "date-time", 7007 "x-go-name": "Closed" 7008 }, 7009 "comments": { 7010 "type": "integer", 7011 "format": "int64", 7012 "x-go-name": "Comments" 7013 }, 7014 "created_at": { 7015 "type": "string", 7016 "format": "date-time", 7017 "x-go-name": "Created" 7018 }, 7019 "diff_url": { 7020 "type": "string", 7021 "x-go-name": "DiffURL" 7022 }, 7023 "due_date": { 7024 "type": "string", 7025 "format": "date-time", 7026 "x-go-name": "Deadline" 7027 }, 7028 "head": { 7029 "$ref": "#/definitions/PRBranchInfo" 7030 }, 7031 "html_url": { 7032 "type": "string", 7033 "x-go-name": "HTMLURL" 7034 }, 7035 "id": { 7036 "type": "integer", 7037 "format": "int64", 7038 "x-go-name": "ID" 7039 }, 7040 "labels": { 7041 "type": "array", 7042 "items": { 7043 "$ref": "#/definitions/Label" 7044 }, 7045 "x-go-name": "Labels" 7046 }, 7047 "merge_base": { 7048 "type": "string", 7049 "x-go-name": "MergeBase" 7050 }, 7051 "merge_commit_sha": { 7052 "type": "string", 7053 "x-go-name": "MergedCommitID" 7054 }, 7055 "mergeable": { 7056 "type": "boolean", 7057 "x-go-name": "Mergeable" 7058 }, 7059 "merged": { 7060 "type": "boolean", 7061 "x-go-name": "HasMerged" 7062 }, 7063 "merged_at": { 7064 "type": "string", 7065 "format": "date-time", 7066 "x-go-name": "Merged" 7067 }, 7068 "merged_by": { 7069 "$ref": "#/definitions/User" 7070 }, 7071 "milestone": { 7072 "$ref": "#/definitions/Milestone" 7073 }, 7074 "number": { 7075 "type": "integer", 7076 "format": "int64", 7077 "x-go-name": "Index" 7078 }, 7079 "patch_url": { 7080 "type": "string", 7081 "x-go-name": "PatchURL" 7082 }, 7083 "state": { 7084 "$ref": "#/definitions/StateType" 7085 }, 7086 "title": { 7087 "type": "string", 7088 "x-go-name": "Title" 7089 }, 7090 "updated_at": { 7091 "type": "string", 7092 "format": "date-time", 7093 "x-go-name": "Updated" 7094 }, 7095 "url": { 7096 "type": "string", 7097 "x-go-name": "URL" 7098 }, 7099 "user": { 7100 "$ref": "#/definitions/User" 7101 } 7102 }, 7103 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 7104 }, 7105 "PullRequestMeta": { 7106 "description": "PullRequestMeta PR info if an issue is a PR", 7107 "type": "object", 7108 "properties": { 7109 "merged": { 7110 "type": "boolean", 7111 "x-go-name": "HasMerged" 7112 }, 7113 "merged_at": { 7114 "type": "string", 7115 "format": "date-time", 7116 "x-go-name": "Merged" 7117 } 7118 }, 7119 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 7120 }, 7121 "Release": { 7122 "description": "Release represents a repository release", 7123 "type": "object", 7124 "properties": { 7125 "assets": { 7126 "type": "array", 7127 "items": { 7128 "$ref": "#/definitions/Attachment" 7129 }, 7130 "x-go-name": "Attachments" 7131 }, 7132 "author": { 7133 "$ref": "#/definitions/User" 7134 }, 7135 "body": { 7136 "type": "string", 7137 "x-go-name": "Note" 7138 }, 7139 "created_at": { 7140 "type": "string", 7141 "format": "date-time", 7142 "x-go-name": "CreatedAt" 7143 }, 7144 "draft": { 7145 "type": "boolean", 7146 "x-go-name": "IsDraft" 7147 }, 7148 "id": { 7149 "type": "integer", 7150 "format": "int64", 7151 "x-go-name": "ID" 7152 }, 7153 "name": { 7154 "type": "string", 7155 "x-go-name": "Title" 7156 }, 7157 "prerelease": { 7158 "type": "boolean", 7159 "x-go-name": "IsPrerelease" 7160 }, 7161 "published_at": { 7162 "type": "string", 7163 "format": "date-time", 7164 "x-go-name": "PublishedAt" 7165 }, 7166 "tag_name": { 7167 "type": "string", 7168 "x-go-name": "TagName" 7169 }, 7170 "tarball_url": { 7171 "type": "string", 7172 "x-go-name": "TarURL" 7173 }, 7174 "target_commitish": { 7175 "type": "string", 7176 "x-go-name": "Target" 7177 }, 7178 "url": { 7179 "type": "string", 7180 "x-go-name": "URL" 7181 }, 7182 "zipball_url": { 7183 "type": "string", 7184 "x-go-name": "ZipURL" 7185 } 7186 }, 7187 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 7188 }, 7189 "Repository": { 7190 "description": "Repository represents a repository", 7191 "type": "object", 7192 "properties": { 7193 "clone_url": { 7194 "type": "string", 7195 "x-go-name": "CloneURL" 7196 }, 7197 "created_at": { 7198 "type": "string", 7199 "format": "date-time", 7200 "x-go-name": "Created" 7201 }, 7202 "default_branch": { 7203 "type": "string", 7204 "x-go-name": "DefaultBranch" 7205 }, 7206 "description": { 7207 "type": "string", 7208 "x-go-name": "Description" 7209 }, 7210 "empty": { 7211 "type": "boolean", 7212 "x-go-name": "Empty" 7213 }, 7214 "fork": { 7215 "type": "boolean", 7216 "x-go-name": "Fork" 7217 }, 7218 "forks_count": { 7219 "type": "integer", 7220 "format": "int64", 7221 "x-go-name": "Forks" 7222 }, 7223 "full_name": { 7224 "type": "string", 7225 "x-go-name": "FullName" 7226 }, 7227 "html_url": { 7228 "type": "string", 7229 "x-go-name": "HTMLURL" 7230 }, 7231 "id": { 7232 "type": "integer", 7233 "format": "int64", 7234 "x-go-name": "ID" 7235 }, 7236 "mirror": { 7237 "type": "boolean", 7238 "x-go-name": "Mirror" 7239 }, 7240 "name": { 7241 "type": "string", 7242 "x-go-name": "Name" 7243 }, 7244 "open_issues_count": { 7245 "type": "integer", 7246 "format": "int64", 7247 "x-go-name": "OpenIssues" 7248 }, 7249 "owner": { 7250 "$ref": "#/definitions/User" 7251 }, 7252 "parent": { 7253 "$ref": "#/definitions/Repository" 7254 }, 7255 "permissions": { 7256 "$ref": "#/definitions/Permission" 7257 }, 7258 "private": { 7259 "type": "boolean", 7260 "x-go-name": "Private" 7261 }, 7262 "size": { 7263 "type": "integer", 7264 "format": "int64", 7265 "x-go-name": "Size" 7266 }, 7267 "ssh_url": { 7268 "type": "string", 7269 "x-go-name": "SSHURL" 7270 }, 7271 "stars_count": { 7272 "type": "integer", 7273 "format": "int64", 7274 "x-go-name": "Stars" 7275 }, 7276 "updated_at": { 7277 "type": "string", 7278 "format": "date-time", 7279 "x-go-name": "Updated" 7280 }, 7281 "watchers_count": { 7282 "type": "integer", 7283 "format": "int64", 7284 "x-go-name": "Watchers" 7285 }, 7286 "website": { 7287 "type": "string", 7288 "x-go-name": "Website" 7289 } 7290 }, 7291 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 7292 }, 7293 "SearchResults": { 7294 "description": "SearchResults results of a successful search", 7295 "type": "object", 7296 "properties": { 7297 "data": { 7298 "type": "array", 7299 "items": { 7300 "$ref": "#/definitions/Repository" 7301 }, 7302 "x-go-name": "Data" 7303 }, 7304 "ok": { 7305 "type": "boolean", 7306 "x-go-name": "OK" 7307 } 7308 }, 7309 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 7310 }, 7311 "ServerVersion": { 7312 "description": "ServerVersion wraps the version of the server", 7313 "type": "object", 7314 "properties": { 7315 "version": { 7316 "type": "string", 7317 "x-go-name": "Version" 7318 } 7319 }, 7320 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 7321 }, 7322 "StateType": { 7323 "description": "StateType issue state type", 7324 "type": "string", 7325 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 7326 }, 7327 "Status": { 7328 "description": "Status holds a single Status of a single Commit", 7329 "type": "object", 7330 "properties": { 7331 "context": { 7332 "type": "string", 7333 "x-go-name": "Context" 7334 }, 7335 "created_at": { 7336 "type": "string", 7337 "format": "date-time", 7338 "x-go-name": "Created" 7339 }, 7340 "creator": { 7341 "$ref": "#/definitions/User" 7342 }, 7343 "description": { 7344 "type": "string", 7345 "x-go-name": "Description" 7346 }, 7347 "id": { 7348 "type": "integer", 7349 "format": "int64", 7350 "x-go-name": "ID" 7351 }, 7352 "status": { 7353 "$ref": "#/definitions/StatusState" 7354 }, 7355 "target_url": { 7356 "type": "string", 7357 "x-go-name": "TargetURL" 7358 }, 7359 "updated_at": { 7360 "type": "string", 7361 "format": "date-time", 7362 "x-go-name": "Updated" 7363 }, 7364 "url": { 7365 "type": "string", 7366 "x-go-name": "URL" 7367 } 7368 }, 7369 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 7370 }, 7371 "StatusState": { 7372 "description": "StatusState holds the state of a Status\nIt can be \"pending\", \"success\", \"error\", \"failure\", and \"warning\"", 7373 "type": "string", 7374 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 7375 }, 7376 "Team": { 7377 "description": "Team represents a team in an organization", 7378 "type": "object", 7379 "properties": { 7380 "description": { 7381 "type": "string", 7382 "x-go-name": "Description" 7383 }, 7384 "id": { 7385 "type": "integer", 7386 "format": "int64", 7387 "x-go-name": "ID" 7388 }, 7389 "name": { 7390 "type": "string", 7391 "x-go-name": "Name" 7392 }, 7393 "permission": { 7394 "type": "string", 7395 "enum": [ 7396 "none", 7397 "read", 7398 "write", 7399 "admin", 7400 "owner" 7401 ], 7402 "x-go-name": "Permission" 7403 } 7404 }, 7405 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 7406 }, 7407 "TrackedTime": { 7408 "description": "TrackedTime worked time for an issue / pr", 7409 "type": "object", 7410 "properties": { 7411 "created": { 7412 "type": "string", 7413 "format": "date-time", 7414 "x-go-name": "Created" 7415 }, 7416 "id": { 7417 "type": "integer", 7418 "format": "int64", 7419 "x-go-name": "ID" 7420 }, 7421 "issue_id": { 7422 "type": "integer", 7423 "format": "int64", 7424 "x-go-name": "IssueID" 7425 }, 7426 "time": { 7427 "description": "Time in seconds", 7428 "type": "integer", 7429 "format": "int64", 7430 "x-go-name": "Time" 7431 }, 7432 "user_id": { 7433 "type": "integer", 7434 "format": "int64", 7435 "x-go-name": "UserID" 7436 } 7437 }, 7438 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 7439 }, 7440 "User": { 7441 "description": "User represents a user", 7442 "type": "object", 7443 "properties": { 7444 "avatar_url": { 7445 "description": "URL to the user's avatar", 7446 "type": "string", 7447 "x-go-name": "AvatarURL" 7448 }, 7449 "email": { 7450 "type": "string", 7451 "format": "email", 7452 "x-go-name": "Email" 7453 }, 7454 "full_name": { 7455 "description": "the user's full name", 7456 "type": "string", 7457 "x-go-name": "FullName" 7458 }, 7459 "id": { 7460 "description": "the user's id", 7461 "type": "integer", 7462 "format": "int64", 7463 "x-go-name": "ID" 7464 }, 7465 "language": { 7466 "description": "User locale", 7467 "type": "string", 7468 "x-go-name": "Language" 7469 }, 7470 "login": { 7471 "description": "the user's username", 7472 "type": "string", 7473 "x-go-name": "UserName" 7474 } 7475 }, 7476 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 7477 }, 7478 "WatchInfo": { 7479 "description": "WatchInfo represents an API watch status of one repository", 7480 "type": "object", 7481 "properties": { 7482 "created_at": { 7483 "type": "string", 7484 "format": "date-time", 7485 "x-go-name": "CreatedAt" 7486 }, 7487 "ignored": { 7488 "type": "boolean", 7489 "x-go-name": "Ignored" 7490 }, 7491 "reason": { 7492 "type": "object", 7493 "x-go-name": "Reason" 7494 }, 7495 "repository_url": { 7496 "type": "string", 7497 "x-go-name": "RepositoryURL" 7498 }, 7499 "subscribed": { 7500 "type": "boolean", 7501 "x-go-name": "Subscribed" 7502 }, 7503 "url": { 7504 "type": "string", 7505 "x-go-name": "URL" 7506 } 7507 }, 7508 "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" 7509 } 7510 }, 7511 "responses": { 7512 "AccessToken": { 7513 "description": "AccessToken represents a API access token.", 7514 "headers": { 7515 "id": { 7516 "type": "integer", 7517 "format": "int64" 7518 }, 7519 "name": { 7520 "type": "string" 7521 }, 7522 "sha1": { 7523 "type": "string" 7524 } 7525 } 7526 }, 7527 "AccessTokenList": { 7528 "description": "AccessTokenList represents a list of API access token." 7529 }, 7530 "Attachment": { 7531 "description": "Attachment", 7532 "schema": { 7533 "$ref": "#/definitions/Attachment" 7534 } 7535 }, 7536 "AttachmentList": { 7537 "description": "AttachmentList", 7538 "schema": { 7539 "type": "array", 7540 "items": { 7541 "$ref": "#/definitions/Attachment" 7542 } 7543 } 7544 }, 7545 "Branch": { 7546 "description": "Branch", 7547 "schema": { 7548 "$ref": "#/definitions/Branch" 7549 } 7550 }, 7551 "BranchList": { 7552 "description": "BranchList", 7553 "schema": { 7554 "type": "array", 7555 "items": { 7556 "$ref": "#/definitions/Branch" 7557 } 7558 } 7559 }, 7560 "Comment": { 7561 "description": "Comment", 7562 "schema": { 7563 "$ref": "#/definitions/Comment" 7564 } 7565 }, 7566 "CommentList": { 7567 "description": "CommentList", 7568 "schema": { 7569 "type": "array", 7570 "items": { 7571 "$ref": "#/definitions/Comment" 7572 } 7573 } 7574 }, 7575 "DeployKey": { 7576 "description": "DeployKey", 7577 "schema": { 7578 "$ref": "#/definitions/DeployKey" 7579 } 7580 }, 7581 "DeployKeyList": { 7582 "description": "DeployKeyList", 7583 "schema": { 7584 "type": "array", 7585 "items": { 7586 "$ref": "#/definitions/DeployKey" 7587 } 7588 } 7589 }, 7590 "EmailList": { 7591 "description": "EmailList", 7592 "schema": { 7593 "type": "array", 7594 "items": { 7595 "$ref": "#/definitions/Email" 7596 } 7597 } 7598 }, 7599 "GPGKey": { 7600 "description": "GPGKey", 7601 "schema": { 7602 "$ref": "#/definitions/GPGKey" 7603 } 7604 }, 7605 "GPGKeyList": { 7606 "description": "GPGKeyList", 7607 "schema": { 7608 "type": "array", 7609 "items": { 7610 "$ref": "#/definitions/GPGKey" 7611 } 7612 } 7613 }, 7614 "Hook": { 7615 "description": "Hook", 7616 "schema": { 7617 "type": "array", 7618 "items": { 7619 "$ref": "#/definitions/Branch" 7620 } 7621 } 7622 }, 7623 "HookList": { 7624 "description": "HookList", 7625 "schema": { 7626 "type": "array", 7627 "items": { 7628 "$ref": "#/definitions/Branch" 7629 } 7630 } 7631 }, 7632 "Issue": { 7633 "description": "Issue", 7634 "schema": { 7635 "$ref": "#/definitions/Issue" 7636 } 7637 }, 7638 "IssueList": { 7639 "description": "IssueList", 7640 "schema": { 7641 "type": "array", 7642 "items": { 7643 "$ref": "#/definitions/Issue" 7644 } 7645 } 7646 }, 7647 "Label": { 7648 "description": "Label", 7649 "schema": { 7650 "$ref": "#/definitions/Label" 7651 } 7652 }, 7653 "LabelList": { 7654 "description": "LabelList", 7655 "schema": { 7656 "type": "array", 7657 "items": { 7658 "$ref": "#/definitions/Label" 7659 } 7660 } 7661 }, 7662 "MarkdownRender": { 7663 "description": "MarkdownRender is a rendered markdown document" 7664 }, 7665 "Milestone": { 7666 "description": "Milestone", 7667 "schema": { 7668 "$ref": "#/definitions/Milestone" 7669 } 7670 }, 7671 "MilestoneList": { 7672 "description": "MilestoneList", 7673 "schema": { 7674 "type": "array", 7675 "items": { 7676 "$ref": "#/definitions/Milestone" 7677 } 7678 } 7679 }, 7680 "Organization": { 7681 "description": "Organization", 7682 "schema": { 7683 "$ref": "#/definitions/Organization" 7684 } 7685 }, 7686 "OrganizationList": { 7687 "description": "OrganizationList", 7688 "schema": { 7689 "type": "array", 7690 "items": { 7691 "$ref": "#/definitions/Organization" 7692 } 7693 } 7694 }, 7695 "PublicKey": { 7696 "description": "PublicKey", 7697 "schema": { 7698 "$ref": "#/definitions/PublicKey" 7699 } 7700 }, 7701 "PublicKeyList": { 7702 "description": "PublicKeyList", 7703 "schema": { 7704 "type": "array", 7705 "items": { 7706 "$ref": "#/definitions/PublicKey" 7707 } 7708 } 7709 }, 7710 "PullRequest": { 7711 "description": "PullRequest", 7712 "schema": { 7713 "$ref": "#/definitions/PullRequest" 7714 } 7715 }, 7716 "PullRequestList": { 7717 "description": "PullRequestList", 7718 "schema": { 7719 "type": "array", 7720 "items": { 7721 "$ref": "#/definitions/PullRequest" 7722 } 7723 } 7724 }, 7725 "Release": { 7726 "description": "Release", 7727 "schema": { 7728 "$ref": "#/definitions/Release" 7729 } 7730 }, 7731 "ReleaseList": { 7732 "description": "ReleaseList", 7733 "schema": { 7734 "type": "array", 7735 "items": { 7736 "$ref": "#/definitions/Release" 7737 } 7738 } 7739 }, 7740 "Repository": { 7741 "description": "Repository", 7742 "schema": { 7743 "$ref": "#/definitions/Repository" 7744 } 7745 }, 7746 "RepositoryList": { 7747 "description": "RepositoryList", 7748 "schema": { 7749 "type": "array", 7750 "items": { 7751 "$ref": "#/definitions/Repository" 7752 } 7753 } 7754 }, 7755 "SearchResults": { 7756 "description": "SearchResults", 7757 "schema": { 7758 "$ref": "#/definitions/SearchResults" 7759 } 7760 }, 7761 "ServerVersion": { 7762 "description": "ServerVersion", 7763 "schema": { 7764 "$ref": "#/definitions/ServerVersion" 7765 } 7766 }, 7767 "Status": { 7768 "description": "Status", 7769 "schema": { 7770 "$ref": "#/definitions/Status" 7771 } 7772 }, 7773 "StatusList": { 7774 "description": "StatusList", 7775 "schema": { 7776 "type": "array", 7777 "items": { 7778 "$ref": "#/definitions/Status" 7779 } 7780 } 7781 }, 7782 "Team": { 7783 "description": "Team", 7784 "schema": { 7785 "$ref": "#/definitions/Team" 7786 } 7787 }, 7788 "TeamList": { 7789 "description": "TeamList", 7790 "schema": { 7791 "type": "array", 7792 "items": { 7793 "$ref": "#/definitions/Team" 7794 } 7795 } 7796 }, 7797 "TrackedTime": { 7798 "description": "TrackedTime", 7799 "schema": { 7800 "$ref": "#/definitions/TrackedTime" 7801 } 7802 }, 7803 "TrackedTimeList": { 7804 "description": "TrackedTimeList", 7805 "schema": { 7806 "type": "array", 7807 "items": { 7808 "$ref": "#/definitions/TrackedTime" 7809 } 7810 } 7811 }, 7812 "User": { 7813 "description": "User", 7814 "schema": { 7815 "$ref": "#/definitions/User" 7816 } 7817 }, 7818 "UserList": { 7819 "description": "UserList", 7820 "schema": { 7821 "type": "array", 7822 "items": { 7823 "$ref": "#/definitions/User" 7824 } 7825 } 7826 }, 7827 "WatchInfo": { 7828 "description": "WatchInfo", 7829 "schema": { 7830 "$ref": "#/definitions/WatchInfo" 7831 } 7832 }, 7833 "empty": { 7834 "description": "APIEmpty is an empty response" 7835 }, 7836 "error": { 7837 "description": "APIError is error format response", 7838 "headers": { 7839 "message": { 7840 "type": "string" 7841 }, 7842 "url": { 7843 "type": "string" 7844 } 7845 } 7846 }, 7847 "forbidden": { 7848 "description": "APIForbiddenError is a forbidden error response", 7849 "headers": { 7850 "message": { 7851 "type": "string" 7852 }, 7853 "url": { 7854 "type": "string" 7855 } 7856 } 7857 }, 7858 "notFound": { 7859 "description": "APINotFound is a not found empty response" 7860 }, 7861 "parameterBodies": { 7862 "description": "parameterBodies", 7863 "schema": { 7864 "$ref": "#/definitions/EditAttachmentOptions" 7865 } 7866 }, 7867 "redirect": { 7868 "description": "APIRedirect is a redirect response" 7869 }, 7870 "validationError": { 7871 "description": "APIValidationError is error format response related to input validation", 7872 "headers": { 7873 "message": { 7874 "type": "string" 7875 }, 7876 "url": { 7877 "type": "string" 7878 } 7879 } 7880 } 7881 }, 7882 "securityDefinitions": { 7883 "AccessToken": { 7884 "type": "apiKey", 7885 "name": "access_token", 7886 "in": "query" 7887 }, 7888 "AuthorizationHeaderToken": { 7889 "type": "apiKey", 7890 "name": "Authorization", 7891 "in": "header" 7892 }, 7893 "BasicAuth": { 7894 "type": "basic" 7895 }, 7896 "Token": { 7897 "type": "apiKey", 7898 "name": "token", 7899 "in": "query" 7900 } 7901 }, 7902 "security": [ 7903 { 7904 "BasicAuth": [] 7905 }, 7906 { 7907 "Token": [] 7908 }, 7909 { 7910 "AccessToken": [] 7911 }, 7912 { 7913 "AuthorizationHeaderToken": [] 7914 } 7915 ] 7916} 7917