code.gitea.io/gitea@v1.22.3/templates/swagger/v1_json.tmpl (about) 1 { 2 "consumes": [ 3 "application/json", 4 "text/plain" 5 ], 6 "produces": [ 7 "application/json", 8 "text/html" 9 ], 10 "schemes": [ 11 "https", 12 "http" 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": "{{AppVer | JSEscape}}" 23 }, 24 "basePath": "{{AppSubUrl | JSEscape}}/api/v1", 25 "paths": { 26 "/activitypub/user-id/{user-id}": { 27 "get": { 28 "produces": [ 29 "application/json" 30 ], 31 "tags": [ 32 "activitypub" 33 ], 34 "summary": "Returns the Person actor for a user", 35 "operationId": "activitypubPerson", 36 "parameters": [ 37 { 38 "type": "integer", 39 "description": "user ID of the user", 40 "name": "user-id", 41 "in": "path", 42 "required": true 43 } 44 ], 45 "responses": { 46 "200": { 47 "$ref": "#/responses/ActivityPub" 48 } 49 } 50 } 51 }, 52 "/activitypub/user-id/{user-id}/inbox": { 53 "post": { 54 "produces": [ 55 "application/json" 56 ], 57 "tags": [ 58 "activitypub" 59 ], 60 "summary": "Send to the inbox", 61 "operationId": "activitypubPersonInbox", 62 "parameters": [ 63 { 64 "type": "integer", 65 "description": "user ID of the user", 66 "name": "user-id", 67 "in": "path", 68 "required": true 69 } 70 ], 71 "responses": { 72 "204": { 73 "$ref": "#/responses/empty" 74 } 75 } 76 } 77 }, 78 "/admin/cron": { 79 "get": { 80 "produces": [ 81 "application/json" 82 ], 83 "tags": [ 84 "admin" 85 ], 86 "summary": "List cron tasks", 87 "operationId": "adminCronList", 88 "parameters": [ 89 { 90 "type": "integer", 91 "description": "page number of results to return (1-based)", 92 "name": "page", 93 "in": "query" 94 }, 95 { 96 "type": "integer", 97 "description": "page size of results", 98 "name": "limit", 99 "in": "query" 100 } 101 ], 102 "responses": { 103 "200": { 104 "$ref": "#/responses/CronList" 105 }, 106 "403": { 107 "$ref": "#/responses/forbidden" 108 } 109 } 110 } 111 }, 112 "/admin/cron/{task}": { 113 "post": { 114 "produces": [ 115 "application/json" 116 ], 117 "tags": [ 118 "admin" 119 ], 120 "summary": "Run cron task", 121 "operationId": "adminCronRun", 122 "parameters": [ 123 { 124 "type": "string", 125 "description": "task to run", 126 "name": "task", 127 "in": "path", 128 "required": true 129 } 130 ], 131 "responses": { 132 "204": { 133 "$ref": "#/responses/empty" 134 }, 135 "404": { 136 "$ref": "#/responses/notFound" 137 } 138 } 139 } 140 }, 141 "/admin/emails": { 142 "get": { 143 "produces": [ 144 "application/json" 145 ], 146 "tags": [ 147 "admin" 148 ], 149 "summary": "List all emails", 150 "operationId": "adminGetAllEmails", 151 "parameters": [ 152 { 153 "type": "integer", 154 "description": "page number of results to return (1-based)", 155 "name": "page", 156 "in": "query" 157 }, 158 { 159 "type": "integer", 160 "description": "page size of results", 161 "name": "limit", 162 "in": "query" 163 } 164 ], 165 "responses": { 166 "200": { 167 "$ref": "#/responses/EmailList" 168 }, 169 "403": { 170 "$ref": "#/responses/forbidden" 171 } 172 } 173 } 174 }, 175 "/admin/emails/search": { 176 "get": { 177 "produces": [ 178 "application/json" 179 ], 180 "tags": [ 181 "admin" 182 ], 183 "summary": "Search all emails", 184 "operationId": "adminSearchEmails", 185 "parameters": [ 186 { 187 "type": "string", 188 "description": "keyword", 189 "name": "q", 190 "in": "query" 191 }, 192 { 193 "type": "integer", 194 "description": "page number of results to return (1-based)", 195 "name": "page", 196 "in": "query" 197 }, 198 { 199 "type": "integer", 200 "description": "page size of results", 201 "name": "limit", 202 "in": "query" 203 } 204 ], 205 "responses": { 206 "200": { 207 "$ref": "#/responses/EmailList" 208 }, 209 "403": { 210 "$ref": "#/responses/forbidden" 211 } 212 } 213 } 214 }, 215 "/admin/hooks": { 216 "get": { 217 "produces": [ 218 "application/json" 219 ], 220 "tags": [ 221 "admin" 222 ], 223 "summary": "List system's webhooks", 224 "operationId": "adminListHooks", 225 "parameters": [ 226 { 227 "type": "integer", 228 "description": "page number of results to return (1-based)", 229 "name": "page", 230 "in": "query" 231 }, 232 { 233 "type": "integer", 234 "description": "page size of results", 235 "name": "limit", 236 "in": "query" 237 } 238 ], 239 "responses": { 240 "200": { 241 "$ref": "#/responses/HookList" 242 } 243 } 244 }, 245 "post": { 246 "consumes": [ 247 "application/json" 248 ], 249 "produces": [ 250 "application/json" 251 ], 252 "tags": [ 253 "admin" 254 ], 255 "summary": "Create a hook", 256 "operationId": "adminCreateHook", 257 "parameters": [ 258 { 259 "name": "body", 260 "in": "body", 261 "required": true, 262 "schema": { 263 "$ref": "#/definitions/CreateHookOption" 264 } 265 } 266 ], 267 "responses": { 268 "201": { 269 "$ref": "#/responses/Hook" 270 } 271 } 272 } 273 }, 274 "/admin/hooks/{id}": { 275 "get": { 276 "produces": [ 277 "application/json" 278 ], 279 "tags": [ 280 "admin" 281 ], 282 "summary": "Get a hook", 283 "operationId": "adminGetHook", 284 "parameters": [ 285 { 286 "type": "integer", 287 "format": "int64", 288 "description": "id of the hook to get", 289 "name": "id", 290 "in": "path", 291 "required": true 292 } 293 ], 294 "responses": { 295 "200": { 296 "$ref": "#/responses/Hook" 297 } 298 } 299 }, 300 "delete": { 301 "produces": [ 302 "application/json" 303 ], 304 "tags": [ 305 "admin" 306 ], 307 "summary": "Delete a hook", 308 "operationId": "adminDeleteHook", 309 "parameters": [ 310 { 311 "type": "integer", 312 "format": "int64", 313 "description": "id of the hook to delete", 314 "name": "id", 315 "in": "path", 316 "required": true 317 } 318 ], 319 "responses": { 320 "204": { 321 "$ref": "#/responses/empty" 322 } 323 } 324 }, 325 "patch": { 326 "consumes": [ 327 "application/json" 328 ], 329 "produces": [ 330 "application/json" 331 ], 332 "tags": [ 333 "admin" 334 ], 335 "summary": "Update a hook", 336 "operationId": "adminEditHook", 337 "parameters": [ 338 { 339 "type": "integer", 340 "format": "int64", 341 "description": "id of the hook to update", 342 "name": "id", 343 "in": "path", 344 "required": true 345 }, 346 { 347 "name": "body", 348 "in": "body", 349 "schema": { 350 "$ref": "#/definitions/EditHookOption" 351 } 352 } 353 ], 354 "responses": { 355 "200": { 356 "$ref": "#/responses/Hook" 357 } 358 } 359 } 360 }, 361 "/admin/orgs": { 362 "get": { 363 "produces": [ 364 "application/json" 365 ], 366 "tags": [ 367 "admin" 368 ], 369 "summary": "List all organizations", 370 "operationId": "adminGetAllOrgs", 371 "parameters": [ 372 { 373 "type": "integer", 374 "description": "page number of results to return (1-based)", 375 "name": "page", 376 "in": "query" 377 }, 378 { 379 "type": "integer", 380 "description": "page size of results", 381 "name": "limit", 382 "in": "query" 383 } 384 ], 385 "responses": { 386 "200": { 387 "$ref": "#/responses/OrganizationList" 388 }, 389 "403": { 390 "$ref": "#/responses/forbidden" 391 } 392 } 393 } 394 }, 395 "/admin/runners/registration-token": { 396 "get": { 397 "produces": [ 398 "application/json" 399 ], 400 "tags": [ 401 "admin" 402 ], 403 "summary": "Get an global actions runner registration token", 404 "operationId": "adminGetRunnerRegistrationToken", 405 "responses": { 406 "200": { 407 "$ref": "#/responses/RegistrationToken" 408 } 409 } 410 } 411 }, 412 "/admin/unadopted": { 413 "get": { 414 "produces": [ 415 "application/json" 416 ], 417 "tags": [ 418 "admin" 419 ], 420 "summary": "List unadopted repositories", 421 "operationId": "adminUnadoptedList", 422 "parameters": [ 423 { 424 "type": "integer", 425 "description": "page number of results to return (1-based)", 426 "name": "page", 427 "in": "query" 428 }, 429 { 430 "type": "integer", 431 "description": "page size of results", 432 "name": "limit", 433 "in": "query" 434 }, 435 { 436 "type": "string", 437 "description": "pattern of repositories to search for", 438 "name": "pattern", 439 "in": "query" 440 } 441 ], 442 "responses": { 443 "200": { 444 "$ref": "#/responses/StringSlice" 445 }, 446 "403": { 447 "$ref": "#/responses/forbidden" 448 } 449 } 450 } 451 }, 452 "/admin/unadopted/{owner}/{repo}": { 453 "post": { 454 "produces": [ 455 "application/json" 456 ], 457 "tags": [ 458 "admin" 459 ], 460 "summary": "Adopt unadopted files as a repository", 461 "operationId": "adminAdoptRepository", 462 "parameters": [ 463 { 464 "type": "string", 465 "description": "owner of the repo", 466 "name": "owner", 467 "in": "path", 468 "required": true 469 }, 470 { 471 "type": "string", 472 "description": "name of the repo", 473 "name": "repo", 474 "in": "path", 475 "required": true 476 } 477 ], 478 "responses": { 479 "204": { 480 "$ref": "#/responses/empty" 481 }, 482 "403": { 483 "$ref": "#/responses/forbidden" 484 }, 485 "404": { 486 "$ref": "#/responses/notFound" 487 } 488 } 489 }, 490 "delete": { 491 "produces": [ 492 "application/json" 493 ], 494 "tags": [ 495 "admin" 496 ], 497 "summary": "Delete unadopted files", 498 "operationId": "adminDeleteUnadoptedRepository", 499 "parameters": [ 500 { 501 "type": "string", 502 "description": "owner of the repo", 503 "name": "owner", 504 "in": "path", 505 "required": true 506 }, 507 { 508 "type": "string", 509 "description": "name of the repo", 510 "name": "repo", 511 "in": "path", 512 "required": true 513 } 514 ], 515 "responses": { 516 "204": { 517 "$ref": "#/responses/empty" 518 }, 519 "403": { 520 "$ref": "#/responses/forbidden" 521 } 522 } 523 } 524 }, 525 "/admin/users": { 526 "get": { 527 "produces": [ 528 "application/json" 529 ], 530 "tags": [ 531 "admin" 532 ], 533 "summary": "Search users according filter conditions", 534 "operationId": "adminSearchUsers", 535 "parameters": [ 536 { 537 "type": "integer", 538 "format": "int64", 539 "description": "ID of the user's login source to search for", 540 "name": "source_id", 541 "in": "query" 542 }, 543 { 544 "type": "string", 545 "description": "user's login name to search for", 546 "name": "login_name", 547 "in": "query" 548 }, 549 { 550 "type": "integer", 551 "description": "page number of results to return (1-based)", 552 "name": "page", 553 "in": "query" 554 }, 555 { 556 "type": "integer", 557 "description": "page size of results", 558 "name": "limit", 559 "in": "query" 560 } 561 ], 562 "responses": { 563 "200": { 564 "$ref": "#/responses/UserList" 565 }, 566 "403": { 567 "$ref": "#/responses/forbidden" 568 } 569 } 570 }, 571 "post": { 572 "consumes": [ 573 "application/json" 574 ], 575 "produces": [ 576 "application/json" 577 ], 578 "tags": [ 579 "admin" 580 ], 581 "summary": "Create a user", 582 "operationId": "adminCreateUser", 583 "parameters": [ 584 { 585 "name": "body", 586 "in": "body", 587 "schema": { 588 "$ref": "#/definitions/CreateUserOption" 589 } 590 } 591 ], 592 "responses": { 593 "201": { 594 "$ref": "#/responses/User" 595 }, 596 "400": { 597 "$ref": "#/responses/error" 598 }, 599 "403": { 600 "$ref": "#/responses/forbidden" 601 }, 602 "422": { 603 "$ref": "#/responses/validationError" 604 } 605 } 606 } 607 }, 608 "/admin/users/{username}": { 609 "delete": { 610 "produces": [ 611 "application/json" 612 ], 613 "tags": [ 614 "admin" 615 ], 616 "summary": "Delete a user", 617 "operationId": "adminDeleteUser", 618 "parameters": [ 619 { 620 "type": "string", 621 "description": "username of user to delete", 622 "name": "username", 623 "in": "path", 624 "required": true 625 }, 626 { 627 "type": "boolean", 628 "description": "purge the user from the system completely", 629 "name": "purge", 630 "in": "query" 631 } 632 ], 633 "responses": { 634 "204": { 635 "$ref": "#/responses/empty" 636 }, 637 "403": { 638 "$ref": "#/responses/forbidden" 639 }, 640 "404": { 641 "$ref": "#/responses/notFound" 642 }, 643 "422": { 644 "$ref": "#/responses/validationError" 645 } 646 } 647 }, 648 "patch": { 649 "consumes": [ 650 "application/json" 651 ], 652 "produces": [ 653 "application/json" 654 ], 655 "tags": [ 656 "admin" 657 ], 658 "summary": "Edit an existing user", 659 "operationId": "adminEditUser", 660 "parameters": [ 661 { 662 "type": "string", 663 "description": "username of user to edit", 664 "name": "username", 665 "in": "path", 666 "required": true 667 }, 668 { 669 "name": "body", 670 "in": "body", 671 "schema": { 672 "$ref": "#/definitions/EditUserOption" 673 } 674 } 675 ], 676 "responses": { 677 "200": { 678 "$ref": "#/responses/User" 679 }, 680 "400": { 681 "$ref": "#/responses/error" 682 }, 683 "403": { 684 "$ref": "#/responses/forbidden" 685 }, 686 "422": { 687 "$ref": "#/responses/validationError" 688 } 689 } 690 } 691 }, 692 "/admin/users/{username}/badges": { 693 "get": { 694 "produces": [ 695 "application/json" 696 ], 697 "tags": [ 698 "admin" 699 ], 700 "summary": "List a user's badges", 701 "operationId": "adminListUserBadges", 702 "parameters": [ 703 { 704 "type": "string", 705 "description": "username of user", 706 "name": "username", 707 "in": "path", 708 "required": true 709 } 710 ], 711 "responses": { 712 "200": { 713 "$ref": "#/responses/BadgeList" 714 }, 715 "404": { 716 "$ref": "#/responses/notFound" 717 } 718 } 719 }, 720 "post": { 721 "consumes": [ 722 "application/json" 723 ], 724 "produces": [ 725 "application/json" 726 ], 727 "tags": [ 728 "admin" 729 ], 730 "summary": "Add a badge to a user", 731 "operationId": "adminAddUserBadges", 732 "parameters": [ 733 { 734 "type": "string", 735 "description": "username of user", 736 "name": "username", 737 "in": "path", 738 "required": true 739 }, 740 { 741 "name": "body", 742 "in": "body", 743 "schema": { 744 "$ref": "#/definitions/UserBadgeOption" 745 } 746 } 747 ], 748 "responses": { 749 "204": { 750 "$ref": "#/responses/empty" 751 }, 752 "403": { 753 "$ref": "#/responses/forbidden" 754 } 755 } 756 }, 757 "delete": { 758 "produces": [ 759 "application/json" 760 ], 761 "tags": [ 762 "admin" 763 ], 764 "summary": "Remove a badge from a user", 765 "operationId": "adminDeleteUserBadges", 766 "parameters": [ 767 { 768 "type": "string", 769 "description": "username of user", 770 "name": "username", 771 "in": "path", 772 "required": true 773 }, 774 { 775 "name": "body", 776 "in": "body", 777 "schema": { 778 "$ref": "#/definitions/UserBadgeOption" 779 } 780 } 781 ], 782 "responses": { 783 "204": { 784 "$ref": "#/responses/empty" 785 }, 786 "403": { 787 "$ref": "#/responses/forbidden" 788 }, 789 "422": { 790 "$ref": "#/responses/validationError" 791 } 792 } 793 } 794 }, 795 "/admin/users/{username}/keys": { 796 "post": { 797 "consumes": [ 798 "application/json" 799 ], 800 "produces": [ 801 "application/json" 802 ], 803 "tags": [ 804 "admin" 805 ], 806 "summary": "Add a public key on behalf of a user", 807 "operationId": "adminCreatePublicKey", 808 "parameters": [ 809 { 810 "type": "string", 811 "description": "username of the user", 812 "name": "username", 813 "in": "path", 814 "required": true 815 }, 816 { 817 "name": "key", 818 "in": "body", 819 "schema": { 820 "$ref": "#/definitions/CreateKeyOption" 821 } 822 } 823 ], 824 "responses": { 825 "201": { 826 "$ref": "#/responses/PublicKey" 827 }, 828 "403": { 829 "$ref": "#/responses/forbidden" 830 }, 831 "422": { 832 "$ref": "#/responses/validationError" 833 } 834 } 835 } 836 }, 837 "/admin/users/{username}/keys/{id}": { 838 "delete": { 839 "produces": [ 840 "application/json" 841 ], 842 "tags": [ 843 "admin" 844 ], 845 "summary": "Delete a user's public key", 846 "operationId": "adminDeleteUserPublicKey", 847 "parameters": [ 848 { 849 "type": "string", 850 "description": "username of user", 851 "name": "username", 852 "in": "path", 853 "required": true 854 }, 855 { 856 "type": "integer", 857 "format": "int64", 858 "description": "id of the key to delete", 859 "name": "id", 860 "in": "path", 861 "required": true 862 } 863 ], 864 "responses": { 865 "204": { 866 "$ref": "#/responses/empty" 867 }, 868 "403": { 869 "$ref": "#/responses/forbidden" 870 }, 871 "404": { 872 "$ref": "#/responses/notFound" 873 } 874 } 875 } 876 }, 877 "/admin/users/{username}/orgs": { 878 "post": { 879 "consumes": [ 880 "application/json" 881 ], 882 "produces": [ 883 "application/json" 884 ], 885 "tags": [ 886 "admin" 887 ], 888 "summary": "Create an organization", 889 "operationId": "adminCreateOrg", 890 "parameters": [ 891 { 892 "type": "string", 893 "description": "username of the user that will own the created organization", 894 "name": "username", 895 "in": "path", 896 "required": true 897 }, 898 { 899 "name": "organization", 900 "in": "body", 901 "required": true, 902 "schema": { 903 "$ref": "#/definitions/CreateOrgOption" 904 } 905 } 906 ], 907 "responses": { 908 "201": { 909 "$ref": "#/responses/Organization" 910 }, 911 "403": { 912 "$ref": "#/responses/forbidden" 913 }, 914 "422": { 915 "$ref": "#/responses/validationError" 916 } 917 } 918 } 919 }, 920 "/admin/users/{username}/rename": { 921 "post": { 922 "produces": [ 923 "application/json" 924 ], 925 "tags": [ 926 "admin" 927 ], 928 "summary": "Rename a user", 929 "operationId": "adminRenameUser", 930 "parameters": [ 931 { 932 "type": "string", 933 "description": "existing username of user", 934 "name": "username", 935 "in": "path", 936 "required": true 937 }, 938 { 939 "name": "body", 940 "in": "body", 941 "required": true, 942 "schema": { 943 "$ref": "#/definitions/RenameUserOption" 944 } 945 } 946 ], 947 "responses": { 948 "204": { 949 "$ref": "#/responses/empty" 950 }, 951 "403": { 952 "$ref": "#/responses/forbidden" 953 }, 954 "422": { 955 "$ref": "#/responses/validationError" 956 } 957 } 958 } 959 }, 960 "/admin/users/{username}/repos": { 961 "post": { 962 "consumes": [ 963 "application/json" 964 ], 965 "produces": [ 966 "application/json" 967 ], 968 "tags": [ 969 "admin" 970 ], 971 "summary": "Create a repository on behalf of a user", 972 "operationId": "adminCreateRepo", 973 "parameters": [ 974 { 975 "type": "string", 976 "description": "username of the user. This user will own the created repository", 977 "name": "username", 978 "in": "path", 979 "required": true 980 }, 981 { 982 "name": "repository", 983 "in": "body", 984 "required": true, 985 "schema": { 986 "$ref": "#/definitions/CreateRepoOption" 987 } 988 } 989 ], 990 "responses": { 991 "201": { 992 "$ref": "#/responses/Repository" 993 }, 994 "400": { 995 "$ref": "#/responses/error" 996 }, 997 "403": { 998 "$ref": "#/responses/forbidden" 999 }, 1000 "404": { 1001 "$ref": "#/responses/notFound" 1002 }, 1003 "409": { 1004 "$ref": "#/responses/error" 1005 }, 1006 "422": { 1007 "$ref": "#/responses/validationError" 1008 } 1009 } 1010 } 1011 }, 1012 "/gitignore/templates": { 1013 "get": { 1014 "produces": [ 1015 "application/json" 1016 ], 1017 "tags": [ 1018 "miscellaneous" 1019 ], 1020 "summary": "Returns a list of all gitignore templates", 1021 "operationId": "listGitignoresTemplates", 1022 "responses": { 1023 "200": { 1024 "$ref": "#/responses/GitignoreTemplateList" 1025 } 1026 } 1027 } 1028 }, 1029 "/gitignore/templates/{name}": { 1030 "get": { 1031 "produces": [ 1032 "application/json" 1033 ], 1034 "tags": [ 1035 "miscellaneous" 1036 ], 1037 "summary": "Returns information about a gitignore template", 1038 "operationId": "getGitignoreTemplateInfo", 1039 "parameters": [ 1040 { 1041 "type": "string", 1042 "description": "name of the template", 1043 "name": "name", 1044 "in": "path", 1045 "required": true 1046 } 1047 ], 1048 "responses": { 1049 "200": { 1050 "$ref": "#/responses/GitignoreTemplateInfo" 1051 }, 1052 "404": { 1053 "$ref": "#/responses/notFound" 1054 } 1055 } 1056 } 1057 }, 1058 "/label/templates": { 1059 "get": { 1060 "produces": [ 1061 "application/json" 1062 ], 1063 "tags": [ 1064 "miscellaneous" 1065 ], 1066 "summary": "Returns a list of all label templates", 1067 "operationId": "listLabelTemplates", 1068 "responses": { 1069 "200": { 1070 "$ref": "#/responses/LabelTemplateList" 1071 } 1072 } 1073 } 1074 }, 1075 "/label/templates/{name}": { 1076 "get": { 1077 "produces": [ 1078 "application/json" 1079 ], 1080 "tags": [ 1081 "miscellaneous" 1082 ], 1083 "summary": "Returns all labels in a template", 1084 "operationId": "getLabelTemplateInfo", 1085 "parameters": [ 1086 { 1087 "type": "string", 1088 "description": "name of the template", 1089 "name": "name", 1090 "in": "path", 1091 "required": true 1092 } 1093 ], 1094 "responses": { 1095 "200": { 1096 "$ref": "#/responses/LabelTemplateInfo" 1097 }, 1098 "404": { 1099 "$ref": "#/responses/notFound" 1100 } 1101 } 1102 } 1103 }, 1104 "/licenses": { 1105 "get": { 1106 "produces": [ 1107 "application/json" 1108 ], 1109 "tags": [ 1110 "miscellaneous" 1111 ], 1112 "summary": "Returns a list of all license templates", 1113 "operationId": "listLicenseTemplates", 1114 "responses": { 1115 "200": { 1116 "$ref": "#/responses/LicenseTemplateList" 1117 } 1118 } 1119 } 1120 }, 1121 "/licenses/{name}": { 1122 "get": { 1123 "produces": [ 1124 "application/json" 1125 ], 1126 "tags": [ 1127 "miscellaneous" 1128 ], 1129 "summary": "Returns information about a license template", 1130 "operationId": "getLicenseTemplateInfo", 1131 "parameters": [ 1132 { 1133 "type": "string", 1134 "description": "name of the license", 1135 "name": "name", 1136 "in": "path", 1137 "required": true 1138 } 1139 ], 1140 "responses": { 1141 "200": { 1142 "$ref": "#/responses/LicenseTemplateInfo" 1143 }, 1144 "404": { 1145 "$ref": "#/responses/notFound" 1146 } 1147 } 1148 } 1149 }, 1150 "/markdown": { 1151 "post": { 1152 "consumes": [ 1153 "application/json" 1154 ], 1155 "produces": [ 1156 "text/html" 1157 ], 1158 "tags": [ 1159 "miscellaneous" 1160 ], 1161 "summary": "Render a markdown document as HTML", 1162 "operationId": "renderMarkdown", 1163 "parameters": [ 1164 { 1165 "name": "body", 1166 "in": "body", 1167 "schema": { 1168 "$ref": "#/definitions/MarkdownOption" 1169 } 1170 } 1171 ], 1172 "responses": { 1173 "200": { 1174 "$ref": "#/responses/MarkdownRender" 1175 }, 1176 "422": { 1177 "$ref": "#/responses/validationError" 1178 } 1179 } 1180 } 1181 }, 1182 "/markdown/raw": { 1183 "post": { 1184 "consumes": [ 1185 "text/plain" 1186 ], 1187 "produces": [ 1188 "text/html" 1189 ], 1190 "tags": [ 1191 "miscellaneous" 1192 ], 1193 "summary": "Render raw markdown as HTML", 1194 "operationId": "renderMarkdownRaw", 1195 "parameters": [ 1196 { 1197 "description": "Request body to render", 1198 "name": "body", 1199 "in": "body", 1200 "required": true, 1201 "schema": { 1202 "type": "string" 1203 } 1204 } 1205 ], 1206 "responses": { 1207 "200": { 1208 "$ref": "#/responses/MarkdownRender" 1209 }, 1210 "422": { 1211 "$ref": "#/responses/validationError" 1212 } 1213 } 1214 } 1215 }, 1216 "/markup": { 1217 "post": { 1218 "consumes": [ 1219 "application/json" 1220 ], 1221 "produces": [ 1222 "text/html" 1223 ], 1224 "tags": [ 1225 "miscellaneous" 1226 ], 1227 "summary": "Render a markup document as HTML", 1228 "operationId": "renderMarkup", 1229 "parameters": [ 1230 { 1231 "name": "body", 1232 "in": "body", 1233 "schema": { 1234 "$ref": "#/definitions/MarkupOption" 1235 } 1236 } 1237 ], 1238 "responses": { 1239 "200": { 1240 "$ref": "#/responses/MarkupRender" 1241 }, 1242 "422": { 1243 "$ref": "#/responses/validationError" 1244 } 1245 } 1246 } 1247 }, 1248 "/nodeinfo": { 1249 "get": { 1250 "produces": [ 1251 "application/json" 1252 ], 1253 "tags": [ 1254 "miscellaneous" 1255 ], 1256 "summary": "Returns the nodeinfo of the Gitea application", 1257 "operationId": "getNodeInfo", 1258 "responses": { 1259 "200": { 1260 "$ref": "#/responses/NodeInfo" 1261 } 1262 } 1263 } 1264 }, 1265 "/notifications": { 1266 "get": { 1267 "consumes": [ 1268 "application/json" 1269 ], 1270 "produces": [ 1271 "application/json" 1272 ], 1273 "tags": [ 1274 "notification" 1275 ], 1276 "summary": "List users's notification threads", 1277 "operationId": "notifyGetList", 1278 "parameters": [ 1279 { 1280 "type": "boolean", 1281 "description": "If true, show notifications marked as read. Default value is false", 1282 "name": "all", 1283 "in": "query" 1284 }, 1285 { 1286 "type": "array", 1287 "items": { 1288 "type": "string" 1289 }, 1290 "collectionFormat": "multi", 1291 "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned.", 1292 "name": "status-types", 1293 "in": "query" 1294 }, 1295 { 1296 "type": "array", 1297 "items": { 1298 "enum": [ 1299 "issue", 1300 "pull", 1301 "commit", 1302 "repository" 1303 ], 1304 "type": "string" 1305 }, 1306 "collectionFormat": "multi", 1307 "description": "filter notifications by subject type", 1308 "name": "subject-type", 1309 "in": "query" 1310 }, 1311 { 1312 "type": "string", 1313 "format": "date-time", 1314 "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format", 1315 "name": "since", 1316 "in": "query" 1317 }, 1318 { 1319 "type": "string", 1320 "format": "date-time", 1321 "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format", 1322 "name": "before", 1323 "in": "query" 1324 }, 1325 { 1326 "type": "integer", 1327 "description": "page number of results to return (1-based)", 1328 "name": "page", 1329 "in": "query" 1330 }, 1331 { 1332 "type": "integer", 1333 "description": "page size of results", 1334 "name": "limit", 1335 "in": "query" 1336 } 1337 ], 1338 "responses": { 1339 "200": { 1340 "$ref": "#/responses/NotificationThreadList" 1341 } 1342 } 1343 }, 1344 "put": { 1345 "consumes": [ 1346 "application/json" 1347 ], 1348 "produces": [ 1349 "application/json" 1350 ], 1351 "tags": [ 1352 "notification" 1353 ], 1354 "summary": "Mark notification threads as read, pinned or unread", 1355 "operationId": "notifyReadList", 1356 "parameters": [ 1357 { 1358 "type": "string", 1359 "format": "date-time", 1360 "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.", 1361 "name": "last_read_at", 1362 "in": "query" 1363 }, 1364 { 1365 "type": "string", 1366 "description": "If true, mark all notifications on this repo. Default value is false", 1367 "name": "all", 1368 "in": "query" 1369 }, 1370 { 1371 "type": "array", 1372 "items": { 1373 "type": "string" 1374 }, 1375 "collectionFormat": "multi", 1376 "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.", 1377 "name": "status-types", 1378 "in": "query" 1379 }, 1380 { 1381 "type": "string", 1382 "description": "Status to mark notifications as, Defaults to read.", 1383 "name": "to-status", 1384 "in": "query" 1385 } 1386 ], 1387 "responses": { 1388 "205": { 1389 "$ref": "#/responses/NotificationThreadList" 1390 } 1391 } 1392 } 1393 }, 1394 "/notifications/new": { 1395 "get": { 1396 "tags": [ 1397 "notification" 1398 ], 1399 "summary": "Check if unread notifications exist", 1400 "operationId": "notifyNewAvailable", 1401 "responses": { 1402 "200": { 1403 "$ref": "#/responses/NotificationCount" 1404 } 1405 } 1406 } 1407 }, 1408 "/notifications/threads/{id}": { 1409 "get": { 1410 "consumes": [ 1411 "application/json" 1412 ], 1413 "produces": [ 1414 "application/json" 1415 ], 1416 "tags": [ 1417 "notification" 1418 ], 1419 "summary": "Get notification thread by ID", 1420 "operationId": "notifyGetThread", 1421 "parameters": [ 1422 { 1423 "type": "string", 1424 "description": "id of notification thread", 1425 "name": "id", 1426 "in": "path", 1427 "required": true 1428 } 1429 ], 1430 "responses": { 1431 "200": { 1432 "$ref": "#/responses/NotificationThread" 1433 }, 1434 "403": { 1435 "$ref": "#/responses/forbidden" 1436 }, 1437 "404": { 1438 "$ref": "#/responses/notFound" 1439 } 1440 } 1441 }, 1442 "patch": { 1443 "consumes": [ 1444 "application/json" 1445 ], 1446 "produces": [ 1447 "application/json" 1448 ], 1449 "tags": [ 1450 "notification" 1451 ], 1452 "summary": "Mark notification thread as read by ID", 1453 "operationId": "notifyReadThread", 1454 "parameters": [ 1455 { 1456 "type": "string", 1457 "description": "id of notification thread", 1458 "name": "id", 1459 "in": "path", 1460 "required": true 1461 }, 1462 { 1463 "type": "string", 1464 "default": "read", 1465 "description": "Status to mark notifications as", 1466 "name": "to-status", 1467 "in": "query" 1468 } 1469 ], 1470 "responses": { 1471 "205": { 1472 "$ref": "#/responses/NotificationThread" 1473 }, 1474 "403": { 1475 "$ref": "#/responses/forbidden" 1476 }, 1477 "404": { 1478 "$ref": "#/responses/notFound" 1479 } 1480 } 1481 } 1482 }, 1483 "/org/{org}/repos": { 1484 "post": { 1485 "consumes": [ 1486 "application/json" 1487 ], 1488 "produces": [ 1489 "application/json" 1490 ], 1491 "tags": [ 1492 "organization" 1493 ], 1494 "summary": "Create a repository in an organization", 1495 "operationId": "createOrgRepoDeprecated", 1496 "deprecated": true, 1497 "parameters": [ 1498 { 1499 "type": "string", 1500 "description": "name of organization", 1501 "name": "org", 1502 "in": "path", 1503 "required": true 1504 }, 1505 { 1506 "name": "body", 1507 "in": "body", 1508 "schema": { 1509 "$ref": "#/definitions/CreateRepoOption" 1510 } 1511 } 1512 ], 1513 "responses": { 1514 "201": { 1515 "$ref": "#/responses/Repository" 1516 }, 1517 "403": { 1518 "$ref": "#/responses/forbidden" 1519 }, 1520 "404": { 1521 "$ref": "#/responses/notFound" 1522 }, 1523 "422": { 1524 "$ref": "#/responses/validationError" 1525 } 1526 } 1527 } 1528 }, 1529 "/orgs": { 1530 "get": { 1531 "produces": [ 1532 "application/json" 1533 ], 1534 "tags": [ 1535 "organization" 1536 ], 1537 "summary": "Get list of organizations", 1538 "operationId": "orgGetAll", 1539 "parameters": [ 1540 { 1541 "type": "integer", 1542 "description": "page number of results to return (1-based)", 1543 "name": "page", 1544 "in": "query" 1545 }, 1546 { 1547 "type": "integer", 1548 "description": "page size of results", 1549 "name": "limit", 1550 "in": "query" 1551 } 1552 ], 1553 "responses": { 1554 "200": { 1555 "$ref": "#/responses/OrganizationList" 1556 } 1557 } 1558 }, 1559 "post": { 1560 "consumes": [ 1561 "application/json" 1562 ], 1563 "produces": [ 1564 "application/json" 1565 ], 1566 "tags": [ 1567 "organization" 1568 ], 1569 "summary": "Create an organization", 1570 "operationId": "orgCreate", 1571 "parameters": [ 1572 { 1573 "name": "organization", 1574 "in": "body", 1575 "required": true, 1576 "schema": { 1577 "$ref": "#/definitions/CreateOrgOption" 1578 } 1579 } 1580 ], 1581 "responses": { 1582 "201": { 1583 "$ref": "#/responses/Organization" 1584 }, 1585 "403": { 1586 "$ref": "#/responses/forbidden" 1587 }, 1588 "422": { 1589 "$ref": "#/responses/validationError" 1590 } 1591 } 1592 } 1593 }, 1594 "/orgs/{org}": { 1595 "get": { 1596 "produces": [ 1597 "application/json" 1598 ], 1599 "tags": [ 1600 "organization" 1601 ], 1602 "summary": "Get an organization", 1603 "operationId": "orgGet", 1604 "parameters": [ 1605 { 1606 "type": "string", 1607 "description": "name of the organization to get", 1608 "name": "org", 1609 "in": "path", 1610 "required": true 1611 } 1612 ], 1613 "responses": { 1614 "200": { 1615 "$ref": "#/responses/Organization" 1616 }, 1617 "404": { 1618 "$ref": "#/responses/notFound" 1619 } 1620 } 1621 }, 1622 "delete": { 1623 "produces": [ 1624 "application/json" 1625 ], 1626 "tags": [ 1627 "organization" 1628 ], 1629 "summary": "Delete an organization", 1630 "operationId": "orgDelete", 1631 "parameters": [ 1632 { 1633 "type": "string", 1634 "description": "organization that is to be deleted", 1635 "name": "org", 1636 "in": "path", 1637 "required": true 1638 } 1639 ], 1640 "responses": { 1641 "204": { 1642 "$ref": "#/responses/empty" 1643 }, 1644 "404": { 1645 "$ref": "#/responses/notFound" 1646 } 1647 } 1648 }, 1649 "patch": { 1650 "consumes": [ 1651 "application/json" 1652 ], 1653 "produces": [ 1654 "application/json" 1655 ], 1656 "tags": [ 1657 "organization" 1658 ], 1659 "summary": "Edit an organization", 1660 "operationId": "orgEdit", 1661 "parameters": [ 1662 { 1663 "type": "string", 1664 "description": "name of the organization to edit", 1665 "name": "org", 1666 "in": "path", 1667 "required": true 1668 }, 1669 { 1670 "name": "body", 1671 "in": "body", 1672 "required": true, 1673 "schema": { 1674 "$ref": "#/definitions/EditOrgOption" 1675 } 1676 } 1677 ], 1678 "responses": { 1679 "200": { 1680 "$ref": "#/responses/Organization" 1681 }, 1682 "404": { 1683 "$ref": "#/responses/notFound" 1684 } 1685 } 1686 } 1687 }, 1688 "/orgs/{org}/actions/runners/registration-token": { 1689 "get": { 1690 "produces": [ 1691 "application/json" 1692 ], 1693 "tags": [ 1694 "organization" 1695 ], 1696 "summary": "Get an organization's actions runner registration token", 1697 "operationId": "orgGetRunnerRegistrationToken", 1698 "parameters": [ 1699 { 1700 "type": "string", 1701 "description": "name of the organization", 1702 "name": "org", 1703 "in": "path", 1704 "required": true 1705 } 1706 ], 1707 "responses": { 1708 "200": { 1709 "$ref": "#/responses/RegistrationToken" 1710 } 1711 } 1712 } 1713 }, 1714 "/orgs/{org}/actions/secrets": { 1715 "get": { 1716 "produces": [ 1717 "application/json" 1718 ], 1719 "tags": [ 1720 "organization" 1721 ], 1722 "summary": "List an organization's actions secrets", 1723 "operationId": "orgListActionsSecrets", 1724 "parameters": [ 1725 { 1726 "type": "string", 1727 "description": "name of the organization", 1728 "name": "org", 1729 "in": "path", 1730 "required": true 1731 }, 1732 { 1733 "type": "integer", 1734 "description": "page number of results to return (1-based)", 1735 "name": "page", 1736 "in": "query" 1737 }, 1738 { 1739 "type": "integer", 1740 "description": "page size of results", 1741 "name": "limit", 1742 "in": "query" 1743 } 1744 ], 1745 "responses": { 1746 "200": { 1747 "$ref": "#/responses/SecretList" 1748 }, 1749 "404": { 1750 "$ref": "#/responses/notFound" 1751 } 1752 } 1753 } 1754 }, 1755 "/orgs/{org}/actions/secrets/{secretname}": { 1756 "put": { 1757 "consumes": [ 1758 "application/json" 1759 ], 1760 "produces": [ 1761 "application/json" 1762 ], 1763 "tags": [ 1764 "organization" 1765 ], 1766 "summary": "Create or Update a secret value in an organization", 1767 "operationId": "updateOrgSecret", 1768 "parameters": [ 1769 { 1770 "type": "string", 1771 "description": "name of organization", 1772 "name": "org", 1773 "in": "path", 1774 "required": true 1775 }, 1776 { 1777 "type": "string", 1778 "description": "name of the secret", 1779 "name": "secretname", 1780 "in": "path", 1781 "required": true 1782 }, 1783 { 1784 "name": "body", 1785 "in": "body", 1786 "schema": { 1787 "$ref": "#/definitions/CreateOrUpdateSecretOption" 1788 } 1789 } 1790 ], 1791 "responses": { 1792 "201": { 1793 "description": "response when creating a secret" 1794 }, 1795 "204": { 1796 "description": "response when updating a secret" 1797 }, 1798 "400": { 1799 "$ref": "#/responses/error" 1800 }, 1801 "404": { 1802 "$ref": "#/responses/notFound" 1803 } 1804 } 1805 }, 1806 "delete": { 1807 "consumes": [ 1808 "application/json" 1809 ], 1810 "produces": [ 1811 "application/json" 1812 ], 1813 "tags": [ 1814 "organization" 1815 ], 1816 "summary": "Delete a secret in an organization", 1817 "operationId": "deleteOrgSecret", 1818 "parameters": [ 1819 { 1820 "type": "string", 1821 "description": "name of organization", 1822 "name": "org", 1823 "in": "path", 1824 "required": true 1825 }, 1826 { 1827 "type": "string", 1828 "description": "name of the secret", 1829 "name": "secretname", 1830 "in": "path", 1831 "required": true 1832 } 1833 ], 1834 "responses": { 1835 "204": { 1836 "description": "delete one secret of the organization" 1837 }, 1838 "400": { 1839 "$ref": "#/responses/error" 1840 }, 1841 "404": { 1842 "$ref": "#/responses/notFound" 1843 } 1844 } 1845 } 1846 }, 1847 "/orgs/{org}/actions/variables": { 1848 "get": { 1849 "produces": [ 1850 "application/json" 1851 ], 1852 "tags": [ 1853 "organization" 1854 ], 1855 "summary": "Get an org-level variables list", 1856 "operationId": "getOrgVariablesList", 1857 "parameters": [ 1858 { 1859 "type": "string", 1860 "description": "name of the organization", 1861 "name": "org", 1862 "in": "path", 1863 "required": true 1864 }, 1865 { 1866 "type": "integer", 1867 "description": "page number of results to return (1-based)", 1868 "name": "page", 1869 "in": "query" 1870 }, 1871 { 1872 "type": "integer", 1873 "description": "page size of results", 1874 "name": "limit", 1875 "in": "query" 1876 } 1877 ], 1878 "responses": { 1879 "200": { 1880 "$ref": "#/responses/VariableList" 1881 }, 1882 "400": { 1883 "$ref": "#/responses/error" 1884 }, 1885 "404": { 1886 "$ref": "#/responses/notFound" 1887 } 1888 } 1889 } 1890 }, 1891 "/orgs/{org}/actions/variables/{variablename}": { 1892 "get": { 1893 "produces": [ 1894 "application/json" 1895 ], 1896 "tags": [ 1897 "organization" 1898 ], 1899 "summary": "Get an org-level variable", 1900 "operationId": "getOrgVariable", 1901 "parameters": [ 1902 { 1903 "type": "string", 1904 "description": "name of the organization", 1905 "name": "org", 1906 "in": "path", 1907 "required": true 1908 }, 1909 { 1910 "type": "string", 1911 "description": "name of the variable", 1912 "name": "variablename", 1913 "in": "path", 1914 "required": true 1915 } 1916 ], 1917 "responses": { 1918 "200": { 1919 "$ref": "#/responses/ActionVariable" 1920 }, 1921 "400": { 1922 "$ref": "#/responses/error" 1923 }, 1924 "404": { 1925 "$ref": "#/responses/notFound" 1926 } 1927 } 1928 }, 1929 "put": { 1930 "consumes": [ 1931 "application/json" 1932 ], 1933 "produces": [ 1934 "application/json" 1935 ], 1936 "tags": [ 1937 "organization" 1938 ], 1939 "summary": "Update an org-level variable", 1940 "operationId": "updateOrgVariable", 1941 "parameters": [ 1942 { 1943 "type": "string", 1944 "description": "name of the organization", 1945 "name": "org", 1946 "in": "path", 1947 "required": true 1948 }, 1949 { 1950 "type": "string", 1951 "description": "name of the variable", 1952 "name": "variablename", 1953 "in": "path", 1954 "required": true 1955 }, 1956 { 1957 "name": "body", 1958 "in": "body", 1959 "schema": { 1960 "$ref": "#/definitions/UpdateVariableOption" 1961 } 1962 } 1963 ], 1964 "responses": { 1965 "201": { 1966 "description": "response when updating an org-level variable" 1967 }, 1968 "204": { 1969 "description": "response when updating an org-level variable" 1970 }, 1971 "400": { 1972 "$ref": "#/responses/error" 1973 }, 1974 "404": { 1975 "$ref": "#/responses/notFound" 1976 } 1977 } 1978 }, 1979 "post": { 1980 "consumes": [ 1981 "application/json" 1982 ], 1983 "produces": [ 1984 "application/json" 1985 ], 1986 "tags": [ 1987 "organization" 1988 ], 1989 "summary": "Create an org-level variable", 1990 "operationId": "createOrgVariable", 1991 "parameters": [ 1992 { 1993 "type": "string", 1994 "description": "name of the organization", 1995 "name": "org", 1996 "in": "path", 1997 "required": true 1998 }, 1999 { 2000 "type": "string", 2001 "description": "name of the variable", 2002 "name": "variablename", 2003 "in": "path", 2004 "required": true 2005 }, 2006 { 2007 "name": "body", 2008 "in": "body", 2009 "schema": { 2010 "$ref": "#/definitions/CreateVariableOption" 2011 } 2012 } 2013 ], 2014 "responses": { 2015 "201": { 2016 "description": "response when creating an org-level variable" 2017 }, 2018 "204": { 2019 "description": "response when creating an org-level variable" 2020 }, 2021 "400": { 2022 "$ref": "#/responses/error" 2023 }, 2024 "404": { 2025 "$ref": "#/responses/notFound" 2026 } 2027 } 2028 }, 2029 "delete": { 2030 "produces": [ 2031 "application/json" 2032 ], 2033 "tags": [ 2034 "organization" 2035 ], 2036 "summary": "Delete an org-level variable", 2037 "operationId": "deleteOrgVariable", 2038 "parameters": [ 2039 { 2040 "type": "string", 2041 "description": "name of the organization", 2042 "name": "org", 2043 "in": "path", 2044 "required": true 2045 }, 2046 { 2047 "type": "string", 2048 "description": "name of the variable", 2049 "name": "variablename", 2050 "in": "path", 2051 "required": true 2052 } 2053 ], 2054 "responses": { 2055 "200": { 2056 "$ref": "#/responses/ActionVariable" 2057 }, 2058 "201": { 2059 "description": "response when deleting a variable" 2060 }, 2061 "204": { 2062 "description": "response when deleting a variable" 2063 }, 2064 "400": { 2065 "$ref": "#/responses/error" 2066 }, 2067 "404": { 2068 "$ref": "#/responses/notFound" 2069 } 2070 } 2071 } 2072 }, 2073 "/orgs/{org}/activities/feeds": { 2074 "get": { 2075 "produces": [ 2076 "application/json" 2077 ], 2078 "tags": [ 2079 "organization" 2080 ], 2081 "summary": "List an organization's activity feeds", 2082 "operationId": "orgListActivityFeeds", 2083 "parameters": [ 2084 { 2085 "type": "string", 2086 "description": "name of the org", 2087 "name": "org", 2088 "in": "path", 2089 "required": true 2090 }, 2091 { 2092 "type": "string", 2093 "format": "date", 2094 "description": "the date of the activities to be found", 2095 "name": "date", 2096 "in": "query" 2097 }, 2098 { 2099 "type": "integer", 2100 "description": "page number of results to return (1-based)", 2101 "name": "page", 2102 "in": "query" 2103 }, 2104 { 2105 "type": "integer", 2106 "description": "page size of results", 2107 "name": "limit", 2108 "in": "query" 2109 } 2110 ], 2111 "responses": { 2112 "200": { 2113 "$ref": "#/responses/ActivityFeedsList" 2114 }, 2115 "404": { 2116 "$ref": "#/responses/notFound" 2117 } 2118 } 2119 } 2120 }, 2121 "/orgs/{org}/avatar": { 2122 "post": { 2123 "produces": [ 2124 "application/json" 2125 ], 2126 "tags": [ 2127 "organization" 2128 ], 2129 "summary": "Update Avatar", 2130 "operationId": "orgUpdateAvatar", 2131 "parameters": [ 2132 { 2133 "type": "string", 2134 "description": "name of the organization", 2135 "name": "org", 2136 "in": "path", 2137 "required": true 2138 }, 2139 { 2140 "name": "body", 2141 "in": "body", 2142 "schema": { 2143 "$ref": "#/definitions/UpdateUserAvatarOption" 2144 } 2145 } 2146 ], 2147 "responses": { 2148 "204": { 2149 "$ref": "#/responses/empty" 2150 }, 2151 "404": { 2152 "$ref": "#/responses/notFound" 2153 } 2154 } 2155 }, 2156 "delete": { 2157 "produces": [ 2158 "application/json" 2159 ], 2160 "tags": [ 2161 "organization" 2162 ], 2163 "summary": "Delete Avatar", 2164 "operationId": "orgDeleteAvatar", 2165 "parameters": [ 2166 { 2167 "type": "string", 2168 "description": "name of the organization", 2169 "name": "org", 2170 "in": "path", 2171 "required": true 2172 } 2173 ], 2174 "responses": { 2175 "204": { 2176 "$ref": "#/responses/empty" 2177 }, 2178 "404": { 2179 "$ref": "#/responses/notFound" 2180 } 2181 } 2182 } 2183 }, 2184 "/orgs/{org}/blocks": { 2185 "get": { 2186 "produces": [ 2187 "application/json" 2188 ], 2189 "tags": [ 2190 "organization" 2191 ], 2192 "summary": "List users blocked by the organization", 2193 "operationId": "organizationListBlocks", 2194 "parameters": [ 2195 { 2196 "type": "string", 2197 "description": "name of the organization", 2198 "name": "org", 2199 "in": "path", 2200 "required": true 2201 }, 2202 { 2203 "type": "integer", 2204 "description": "page number of results to return (1-based)", 2205 "name": "page", 2206 "in": "query" 2207 }, 2208 { 2209 "type": "integer", 2210 "description": "page size of results", 2211 "name": "limit", 2212 "in": "query" 2213 } 2214 ], 2215 "responses": { 2216 "200": { 2217 "$ref": "#/responses/UserList" 2218 } 2219 } 2220 } 2221 }, 2222 "/orgs/{org}/blocks/{username}": { 2223 "get": { 2224 "tags": [ 2225 "organization" 2226 ], 2227 "summary": "Check if a user is blocked by the organization", 2228 "operationId": "organizationCheckUserBlock", 2229 "parameters": [ 2230 { 2231 "type": "string", 2232 "description": "name of the organization", 2233 "name": "org", 2234 "in": "path", 2235 "required": true 2236 }, 2237 { 2238 "type": "string", 2239 "description": "user to check", 2240 "name": "username", 2241 "in": "path", 2242 "required": true 2243 } 2244 ], 2245 "responses": { 2246 "204": { 2247 "$ref": "#/responses/empty" 2248 }, 2249 "404": { 2250 "$ref": "#/responses/notFound" 2251 } 2252 } 2253 }, 2254 "put": { 2255 "tags": [ 2256 "organization" 2257 ], 2258 "summary": "Block a user", 2259 "operationId": "organizationBlockUser", 2260 "parameters": [ 2261 { 2262 "type": "string", 2263 "description": "name of the organization", 2264 "name": "org", 2265 "in": "path", 2266 "required": true 2267 }, 2268 { 2269 "type": "string", 2270 "description": "user to block", 2271 "name": "username", 2272 "in": "path", 2273 "required": true 2274 }, 2275 { 2276 "type": "string", 2277 "description": "optional note for the block", 2278 "name": "note", 2279 "in": "query" 2280 } 2281 ], 2282 "responses": { 2283 "204": { 2284 "$ref": "#/responses/empty" 2285 }, 2286 "404": { 2287 "$ref": "#/responses/notFound" 2288 }, 2289 "422": { 2290 "$ref": "#/responses/validationError" 2291 } 2292 } 2293 }, 2294 "delete": { 2295 "tags": [ 2296 "organization" 2297 ], 2298 "summary": "Unblock a user", 2299 "operationId": "organizationUnblockUser", 2300 "parameters": [ 2301 { 2302 "type": "string", 2303 "description": "name of the organization", 2304 "name": "org", 2305 "in": "path", 2306 "required": true 2307 }, 2308 { 2309 "type": "string", 2310 "description": "user to unblock", 2311 "name": "username", 2312 "in": "path", 2313 "required": true 2314 } 2315 ], 2316 "responses": { 2317 "204": { 2318 "$ref": "#/responses/empty" 2319 }, 2320 "404": { 2321 "$ref": "#/responses/notFound" 2322 }, 2323 "422": { 2324 "$ref": "#/responses/validationError" 2325 } 2326 } 2327 } 2328 }, 2329 "/orgs/{org}/hooks": { 2330 "get": { 2331 "produces": [ 2332 "application/json" 2333 ], 2334 "tags": [ 2335 "organization" 2336 ], 2337 "summary": "List an organization's webhooks", 2338 "operationId": "orgListHooks", 2339 "parameters": [ 2340 { 2341 "type": "string", 2342 "description": "name of the organization", 2343 "name": "org", 2344 "in": "path", 2345 "required": true 2346 }, 2347 { 2348 "type": "integer", 2349 "description": "page number of results to return (1-based)", 2350 "name": "page", 2351 "in": "query" 2352 }, 2353 { 2354 "type": "integer", 2355 "description": "page size of results", 2356 "name": "limit", 2357 "in": "query" 2358 } 2359 ], 2360 "responses": { 2361 "200": { 2362 "$ref": "#/responses/HookList" 2363 }, 2364 "404": { 2365 "$ref": "#/responses/notFound" 2366 } 2367 } 2368 }, 2369 "post": { 2370 "consumes": [ 2371 "application/json" 2372 ], 2373 "produces": [ 2374 "application/json" 2375 ], 2376 "tags": [ 2377 "organization" 2378 ], 2379 "summary": "Create a hook", 2380 "operationId": "orgCreateHook", 2381 "parameters": [ 2382 { 2383 "type": "string", 2384 "description": "name of the organization", 2385 "name": "org", 2386 "in": "path", 2387 "required": true 2388 }, 2389 { 2390 "name": "body", 2391 "in": "body", 2392 "required": true, 2393 "schema": { 2394 "$ref": "#/definitions/CreateHookOption" 2395 } 2396 } 2397 ], 2398 "responses": { 2399 "201": { 2400 "$ref": "#/responses/Hook" 2401 }, 2402 "404": { 2403 "$ref": "#/responses/notFound" 2404 } 2405 } 2406 } 2407 }, 2408 "/orgs/{org}/hooks/{id}": { 2409 "get": { 2410 "produces": [ 2411 "application/json" 2412 ], 2413 "tags": [ 2414 "organization" 2415 ], 2416 "summary": "Get a hook", 2417 "operationId": "orgGetHook", 2418 "parameters": [ 2419 { 2420 "type": "string", 2421 "description": "name of the organization", 2422 "name": "org", 2423 "in": "path", 2424 "required": true 2425 }, 2426 { 2427 "type": "integer", 2428 "format": "int64", 2429 "description": "id of the hook to get", 2430 "name": "id", 2431 "in": "path", 2432 "required": true 2433 } 2434 ], 2435 "responses": { 2436 "200": { 2437 "$ref": "#/responses/Hook" 2438 }, 2439 "404": { 2440 "$ref": "#/responses/notFound" 2441 } 2442 } 2443 }, 2444 "delete": { 2445 "produces": [ 2446 "application/json" 2447 ], 2448 "tags": [ 2449 "organization" 2450 ], 2451 "summary": "Delete a hook", 2452 "operationId": "orgDeleteHook", 2453 "parameters": [ 2454 { 2455 "type": "string", 2456 "description": "name of the organization", 2457 "name": "org", 2458 "in": "path", 2459 "required": true 2460 }, 2461 { 2462 "type": "integer", 2463 "format": "int64", 2464 "description": "id of the hook to delete", 2465 "name": "id", 2466 "in": "path", 2467 "required": true 2468 } 2469 ], 2470 "responses": { 2471 "204": { 2472 "$ref": "#/responses/empty" 2473 }, 2474 "404": { 2475 "$ref": "#/responses/notFound" 2476 } 2477 } 2478 }, 2479 "patch": { 2480 "consumes": [ 2481 "application/json" 2482 ], 2483 "produces": [ 2484 "application/json" 2485 ], 2486 "tags": [ 2487 "organization" 2488 ], 2489 "summary": "Update a hook", 2490 "operationId": "orgEditHook", 2491 "parameters": [ 2492 { 2493 "type": "string", 2494 "description": "name of the organization", 2495 "name": "org", 2496 "in": "path", 2497 "required": true 2498 }, 2499 { 2500 "type": "integer", 2501 "format": "int64", 2502 "description": "id of the hook to update", 2503 "name": "id", 2504 "in": "path", 2505 "required": true 2506 }, 2507 { 2508 "name": "body", 2509 "in": "body", 2510 "schema": { 2511 "$ref": "#/definitions/EditHookOption" 2512 } 2513 } 2514 ], 2515 "responses": { 2516 "200": { 2517 "$ref": "#/responses/Hook" 2518 }, 2519 "404": { 2520 "$ref": "#/responses/notFound" 2521 } 2522 } 2523 } 2524 }, 2525 "/orgs/{org}/labels": { 2526 "get": { 2527 "produces": [ 2528 "application/json" 2529 ], 2530 "tags": [ 2531 "organization" 2532 ], 2533 "summary": "List an organization's labels", 2534 "operationId": "orgListLabels", 2535 "parameters": [ 2536 { 2537 "type": "string", 2538 "description": "name of the organization", 2539 "name": "org", 2540 "in": "path", 2541 "required": true 2542 }, 2543 { 2544 "type": "integer", 2545 "description": "page number of results to return (1-based)", 2546 "name": "page", 2547 "in": "query" 2548 }, 2549 { 2550 "type": "integer", 2551 "description": "page size of results", 2552 "name": "limit", 2553 "in": "query" 2554 } 2555 ], 2556 "responses": { 2557 "200": { 2558 "$ref": "#/responses/LabelList" 2559 }, 2560 "404": { 2561 "$ref": "#/responses/notFound" 2562 } 2563 } 2564 }, 2565 "post": { 2566 "consumes": [ 2567 "application/json" 2568 ], 2569 "produces": [ 2570 "application/json" 2571 ], 2572 "tags": [ 2573 "organization" 2574 ], 2575 "summary": "Create a label for an organization", 2576 "operationId": "orgCreateLabel", 2577 "parameters": [ 2578 { 2579 "type": "string", 2580 "description": "name of the organization", 2581 "name": "org", 2582 "in": "path", 2583 "required": true 2584 }, 2585 { 2586 "name": "body", 2587 "in": "body", 2588 "schema": { 2589 "$ref": "#/definitions/CreateLabelOption" 2590 } 2591 } 2592 ], 2593 "responses": { 2594 "201": { 2595 "$ref": "#/responses/Label" 2596 }, 2597 "404": { 2598 "$ref": "#/responses/notFound" 2599 }, 2600 "422": { 2601 "$ref": "#/responses/validationError" 2602 } 2603 } 2604 } 2605 }, 2606 "/orgs/{org}/labels/{id}": { 2607 "get": { 2608 "produces": [ 2609 "application/json" 2610 ], 2611 "tags": [ 2612 "organization" 2613 ], 2614 "summary": "Get a single label", 2615 "operationId": "orgGetLabel", 2616 "parameters": [ 2617 { 2618 "type": "string", 2619 "description": "name of the organization", 2620 "name": "org", 2621 "in": "path", 2622 "required": true 2623 }, 2624 { 2625 "type": "integer", 2626 "format": "int64", 2627 "description": "id of the label to get", 2628 "name": "id", 2629 "in": "path", 2630 "required": true 2631 } 2632 ], 2633 "responses": { 2634 "200": { 2635 "$ref": "#/responses/Label" 2636 }, 2637 "404": { 2638 "$ref": "#/responses/notFound" 2639 } 2640 } 2641 }, 2642 "delete": { 2643 "tags": [ 2644 "organization" 2645 ], 2646 "summary": "Delete a label", 2647 "operationId": "orgDeleteLabel", 2648 "parameters": [ 2649 { 2650 "type": "string", 2651 "description": "name of the organization", 2652 "name": "org", 2653 "in": "path", 2654 "required": true 2655 }, 2656 { 2657 "type": "integer", 2658 "format": "int64", 2659 "description": "id of the label to delete", 2660 "name": "id", 2661 "in": "path", 2662 "required": true 2663 } 2664 ], 2665 "responses": { 2666 "204": { 2667 "$ref": "#/responses/empty" 2668 }, 2669 "404": { 2670 "$ref": "#/responses/notFound" 2671 } 2672 } 2673 }, 2674 "patch": { 2675 "consumes": [ 2676 "application/json" 2677 ], 2678 "produces": [ 2679 "application/json" 2680 ], 2681 "tags": [ 2682 "organization" 2683 ], 2684 "summary": "Update a label", 2685 "operationId": "orgEditLabel", 2686 "parameters": [ 2687 { 2688 "type": "string", 2689 "description": "name of the organization", 2690 "name": "org", 2691 "in": "path", 2692 "required": true 2693 }, 2694 { 2695 "type": "integer", 2696 "format": "int64", 2697 "description": "id of the label to edit", 2698 "name": "id", 2699 "in": "path", 2700 "required": true 2701 }, 2702 { 2703 "name": "body", 2704 "in": "body", 2705 "schema": { 2706 "$ref": "#/definitions/EditLabelOption" 2707 } 2708 } 2709 ], 2710 "responses": { 2711 "200": { 2712 "$ref": "#/responses/Label" 2713 }, 2714 "404": { 2715 "$ref": "#/responses/notFound" 2716 }, 2717 "422": { 2718 "$ref": "#/responses/validationError" 2719 } 2720 } 2721 } 2722 }, 2723 "/orgs/{org}/members": { 2724 "get": { 2725 "produces": [ 2726 "application/json" 2727 ], 2728 "tags": [ 2729 "organization" 2730 ], 2731 "summary": "List an organization's members", 2732 "operationId": "orgListMembers", 2733 "parameters": [ 2734 { 2735 "type": "string", 2736 "description": "name of the organization", 2737 "name": "org", 2738 "in": "path", 2739 "required": true 2740 }, 2741 { 2742 "type": "integer", 2743 "description": "page number of results to return (1-based)", 2744 "name": "page", 2745 "in": "query" 2746 }, 2747 { 2748 "type": "integer", 2749 "description": "page size of results", 2750 "name": "limit", 2751 "in": "query" 2752 } 2753 ], 2754 "responses": { 2755 "200": { 2756 "$ref": "#/responses/UserList" 2757 }, 2758 "404": { 2759 "$ref": "#/responses/notFound" 2760 } 2761 } 2762 } 2763 }, 2764 "/orgs/{org}/members/{username}": { 2765 "get": { 2766 "tags": [ 2767 "organization" 2768 ], 2769 "summary": "Check if a user is a member of an organization", 2770 "operationId": "orgIsMember", 2771 "parameters": [ 2772 { 2773 "type": "string", 2774 "description": "name of the organization", 2775 "name": "org", 2776 "in": "path", 2777 "required": true 2778 }, 2779 { 2780 "type": "string", 2781 "description": "username of the user", 2782 "name": "username", 2783 "in": "path", 2784 "required": true 2785 } 2786 ], 2787 "responses": { 2788 "204": { 2789 "description": "user is a member" 2790 }, 2791 "303": { 2792 "description": "redirection to /orgs/{org}/public_members/{username}" 2793 }, 2794 "404": { 2795 "description": "user is not a member" 2796 } 2797 } 2798 }, 2799 "delete": { 2800 "produces": [ 2801 "application/json" 2802 ], 2803 "tags": [ 2804 "organization" 2805 ], 2806 "summary": "Remove a member from an organization", 2807 "operationId": "orgDeleteMember", 2808 "parameters": [ 2809 { 2810 "type": "string", 2811 "description": "name of the organization", 2812 "name": "org", 2813 "in": "path", 2814 "required": true 2815 }, 2816 { 2817 "type": "string", 2818 "description": "username of the user", 2819 "name": "username", 2820 "in": "path", 2821 "required": true 2822 } 2823 ], 2824 "responses": { 2825 "204": { 2826 "description": "member removed" 2827 }, 2828 "404": { 2829 "$ref": "#/responses/notFound" 2830 } 2831 } 2832 } 2833 }, 2834 "/orgs/{org}/public_members": { 2835 "get": { 2836 "produces": [ 2837 "application/json" 2838 ], 2839 "tags": [ 2840 "organization" 2841 ], 2842 "summary": "List an organization's public members", 2843 "operationId": "orgListPublicMembers", 2844 "parameters": [ 2845 { 2846 "type": "string", 2847 "description": "name of the organization", 2848 "name": "org", 2849 "in": "path", 2850 "required": true 2851 }, 2852 { 2853 "type": "integer", 2854 "description": "page number of results to return (1-based)", 2855 "name": "page", 2856 "in": "query" 2857 }, 2858 { 2859 "type": "integer", 2860 "description": "page size of results", 2861 "name": "limit", 2862 "in": "query" 2863 } 2864 ], 2865 "responses": { 2866 "200": { 2867 "$ref": "#/responses/UserList" 2868 }, 2869 "404": { 2870 "$ref": "#/responses/notFound" 2871 } 2872 } 2873 } 2874 }, 2875 "/orgs/{org}/public_members/{username}": { 2876 "get": { 2877 "tags": [ 2878 "organization" 2879 ], 2880 "summary": "Check if a user is a public member of an organization", 2881 "operationId": "orgIsPublicMember", 2882 "parameters": [ 2883 { 2884 "type": "string", 2885 "description": "name of the organization", 2886 "name": "org", 2887 "in": "path", 2888 "required": true 2889 }, 2890 { 2891 "type": "string", 2892 "description": "username of the user", 2893 "name": "username", 2894 "in": "path", 2895 "required": true 2896 } 2897 ], 2898 "responses": { 2899 "204": { 2900 "description": "user is a public member" 2901 }, 2902 "404": { 2903 "description": "user is not a public member" 2904 } 2905 } 2906 }, 2907 "put": { 2908 "produces": [ 2909 "application/json" 2910 ], 2911 "tags": [ 2912 "organization" 2913 ], 2914 "summary": "Publicize a user's membership", 2915 "operationId": "orgPublicizeMember", 2916 "parameters": [ 2917 { 2918 "type": "string", 2919 "description": "name of the organization", 2920 "name": "org", 2921 "in": "path", 2922 "required": true 2923 }, 2924 { 2925 "type": "string", 2926 "description": "username of the user", 2927 "name": "username", 2928 "in": "path", 2929 "required": true 2930 } 2931 ], 2932 "responses": { 2933 "204": { 2934 "description": "membership publicized" 2935 }, 2936 "403": { 2937 "$ref": "#/responses/forbidden" 2938 }, 2939 "404": { 2940 "$ref": "#/responses/notFound" 2941 } 2942 } 2943 }, 2944 "delete": { 2945 "produces": [ 2946 "application/json" 2947 ], 2948 "tags": [ 2949 "organization" 2950 ], 2951 "summary": "Conceal a user's membership", 2952 "operationId": "orgConcealMember", 2953 "parameters": [ 2954 { 2955 "type": "string", 2956 "description": "name of the organization", 2957 "name": "org", 2958 "in": "path", 2959 "required": true 2960 }, 2961 { 2962 "type": "string", 2963 "description": "username of the user", 2964 "name": "username", 2965 "in": "path", 2966 "required": true 2967 } 2968 ], 2969 "responses": { 2970 "204": { 2971 "$ref": "#/responses/empty" 2972 }, 2973 "403": { 2974 "$ref": "#/responses/forbidden" 2975 }, 2976 "404": { 2977 "$ref": "#/responses/notFound" 2978 } 2979 } 2980 } 2981 }, 2982 "/orgs/{org}/repos": { 2983 "get": { 2984 "produces": [ 2985 "application/json" 2986 ], 2987 "tags": [ 2988 "organization" 2989 ], 2990 "summary": "List an organization's repos", 2991 "operationId": "orgListRepos", 2992 "parameters": [ 2993 { 2994 "type": "string", 2995 "description": "name of the organization", 2996 "name": "org", 2997 "in": "path", 2998 "required": true 2999 }, 3000 { 3001 "type": "integer", 3002 "description": "page number of results to return (1-based)", 3003 "name": "page", 3004 "in": "query" 3005 }, 3006 { 3007 "type": "integer", 3008 "description": "page size of results", 3009 "name": "limit", 3010 "in": "query" 3011 } 3012 ], 3013 "responses": { 3014 "200": { 3015 "$ref": "#/responses/RepositoryList" 3016 }, 3017 "404": { 3018 "$ref": "#/responses/notFound" 3019 } 3020 } 3021 }, 3022 "post": { 3023 "consumes": [ 3024 "application/json" 3025 ], 3026 "produces": [ 3027 "application/json" 3028 ], 3029 "tags": [ 3030 "organization" 3031 ], 3032 "summary": "Create a repository in an organization", 3033 "operationId": "createOrgRepo", 3034 "parameters": [ 3035 { 3036 "type": "string", 3037 "description": "name of organization", 3038 "name": "org", 3039 "in": "path", 3040 "required": true 3041 }, 3042 { 3043 "name": "body", 3044 "in": "body", 3045 "schema": { 3046 "$ref": "#/definitions/CreateRepoOption" 3047 } 3048 } 3049 ], 3050 "responses": { 3051 "201": { 3052 "$ref": "#/responses/Repository" 3053 }, 3054 "400": { 3055 "$ref": "#/responses/error" 3056 }, 3057 "403": { 3058 "$ref": "#/responses/forbidden" 3059 }, 3060 "404": { 3061 "$ref": "#/responses/notFound" 3062 } 3063 } 3064 } 3065 }, 3066 "/orgs/{org}/teams": { 3067 "get": { 3068 "produces": [ 3069 "application/json" 3070 ], 3071 "tags": [ 3072 "organization" 3073 ], 3074 "summary": "List an organization's teams", 3075 "operationId": "orgListTeams", 3076 "parameters": [ 3077 { 3078 "type": "string", 3079 "description": "name of the organization", 3080 "name": "org", 3081 "in": "path", 3082 "required": true 3083 }, 3084 { 3085 "type": "integer", 3086 "description": "page number of results to return (1-based)", 3087 "name": "page", 3088 "in": "query" 3089 }, 3090 { 3091 "type": "integer", 3092 "description": "page size of results", 3093 "name": "limit", 3094 "in": "query" 3095 } 3096 ], 3097 "responses": { 3098 "200": { 3099 "$ref": "#/responses/TeamList" 3100 }, 3101 "404": { 3102 "$ref": "#/responses/notFound" 3103 } 3104 } 3105 }, 3106 "post": { 3107 "consumes": [ 3108 "application/json" 3109 ], 3110 "produces": [ 3111 "application/json" 3112 ], 3113 "tags": [ 3114 "organization" 3115 ], 3116 "summary": "Create a team", 3117 "operationId": "orgCreateTeam", 3118 "parameters": [ 3119 { 3120 "type": "string", 3121 "description": "name of the organization", 3122 "name": "org", 3123 "in": "path", 3124 "required": true 3125 }, 3126 { 3127 "name": "body", 3128 "in": "body", 3129 "schema": { 3130 "$ref": "#/definitions/CreateTeamOption" 3131 } 3132 } 3133 ], 3134 "responses": { 3135 "201": { 3136 "$ref": "#/responses/Team" 3137 }, 3138 "404": { 3139 "$ref": "#/responses/notFound" 3140 }, 3141 "422": { 3142 "$ref": "#/responses/validationError" 3143 } 3144 } 3145 } 3146 }, 3147 "/orgs/{org}/teams/search": { 3148 "get": { 3149 "produces": [ 3150 "application/json" 3151 ], 3152 "tags": [ 3153 "organization" 3154 ], 3155 "summary": "Search for teams within an organization", 3156 "operationId": "teamSearch", 3157 "parameters": [ 3158 { 3159 "type": "string", 3160 "description": "name of the organization", 3161 "name": "org", 3162 "in": "path", 3163 "required": true 3164 }, 3165 { 3166 "type": "string", 3167 "description": "keywords to search", 3168 "name": "q", 3169 "in": "query" 3170 }, 3171 { 3172 "type": "boolean", 3173 "description": "include search within team description (defaults to true)", 3174 "name": "include_desc", 3175 "in": "query" 3176 }, 3177 { 3178 "type": "integer", 3179 "description": "page number of results to return (1-based)", 3180 "name": "page", 3181 "in": "query" 3182 }, 3183 { 3184 "type": "integer", 3185 "description": "page size of results", 3186 "name": "limit", 3187 "in": "query" 3188 } 3189 ], 3190 "responses": { 3191 "200": { 3192 "description": "SearchResults of a successful search", 3193 "schema": { 3194 "type": "object", 3195 "properties": { 3196 "data": { 3197 "type": "array", 3198 "items": { 3199 "$ref": "#/definitions/Team" 3200 } 3201 }, 3202 "ok": { 3203 "type": "boolean" 3204 } 3205 } 3206 } 3207 }, 3208 "404": { 3209 "$ref": "#/responses/notFound" 3210 } 3211 } 3212 } 3213 }, 3214 "/packages/{owner}": { 3215 "get": { 3216 "produces": [ 3217 "application/json" 3218 ], 3219 "tags": [ 3220 "package" 3221 ], 3222 "summary": "Gets all packages of an owner", 3223 "operationId": "listPackages", 3224 "parameters": [ 3225 { 3226 "type": "string", 3227 "description": "owner of the packages", 3228 "name": "owner", 3229 "in": "path", 3230 "required": true 3231 }, 3232 { 3233 "type": "integer", 3234 "description": "page number of results to return (1-based)", 3235 "name": "page", 3236 "in": "query" 3237 }, 3238 { 3239 "type": "integer", 3240 "description": "page size of results", 3241 "name": "limit", 3242 "in": "query" 3243 }, 3244 { 3245 "enum": [ 3246 "alpine", 3247 "cargo", 3248 "chef", 3249 "composer", 3250 "conan", 3251 "conda", 3252 "container", 3253 "cran", 3254 "debian", 3255 "generic", 3256 "go", 3257 "helm", 3258 "maven", 3259 "npm", 3260 "nuget", 3261 "pub", 3262 "pypi", 3263 "rpm", 3264 "rubygems", 3265 "swift", 3266 "vagrant" 3267 ], 3268 "type": "string", 3269 "description": "package type filter", 3270 "name": "type", 3271 "in": "query" 3272 }, 3273 { 3274 "type": "string", 3275 "description": "name filter", 3276 "name": "q", 3277 "in": "query" 3278 } 3279 ], 3280 "responses": { 3281 "200": { 3282 "$ref": "#/responses/PackageList" 3283 }, 3284 "404": { 3285 "$ref": "#/responses/notFound" 3286 } 3287 } 3288 } 3289 }, 3290 "/packages/{owner}/{type}/{name}/{version}": { 3291 "get": { 3292 "produces": [ 3293 "application/json" 3294 ], 3295 "tags": [ 3296 "package" 3297 ], 3298 "summary": "Gets a package", 3299 "operationId": "getPackage", 3300 "parameters": [ 3301 { 3302 "type": "string", 3303 "description": "owner of the package", 3304 "name": "owner", 3305 "in": "path", 3306 "required": true 3307 }, 3308 { 3309 "type": "string", 3310 "description": "type of the package", 3311 "name": "type", 3312 "in": "path", 3313 "required": true 3314 }, 3315 { 3316 "type": "string", 3317 "description": "name of the package", 3318 "name": "name", 3319 "in": "path", 3320 "required": true 3321 }, 3322 { 3323 "type": "string", 3324 "description": "version of the package", 3325 "name": "version", 3326 "in": "path", 3327 "required": true 3328 } 3329 ], 3330 "responses": { 3331 "200": { 3332 "$ref": "#/responses/Package" 3333 }, 3334 "404": { 3335 "$ref": "#/responses/notFound" 3336 } 3337 } 3338 }, 3339 "delete": { 3340 "tags": [ 3341 "package" 3342 ], 3343 "summary": "Delete a package", 3344 "operationId": "deletePackage", 3345 "parameters": [ 3346 { 3347 "type": "string", 3348 "description": "owner of the package", 3349 "name": "owner", 3350 "in": "path", 3351 "required": true 3352 }, 3353 { 3354 "type": "string", 3355 "description": "type of the package", 3356 "name": "type", 3357 "in": "path", 3358 "required": true 3359 }, 3360 { 3361 "type": "string", 3362 "description": "name of the package", 3363 "name": "name", 3364 "in": "path", 3365 "required": true 3366 }, 3367 { 3368 "type": "string", 3369 "description": "version of the package", 3370 "name": "version", 3371 "in": "path", 3372 "required": true 3373 } 3374 ], 3375 "responses": { 3376 "204": { 3377 "$ref": "#/responses/empty" 3378 }, 3379 "404": { 3380 "$ref": "#/responses/notFound" 3381 } 3382 } 3383 } 3384 }, 3385 "/packages/{owner}/{type}/{name}/{version}/files": { 3386 "get": { 3387 "produces": [ 3388 "application/json" 3389 ], 3390 "tags": [ 3391 "package" 3392 ], 3393 "summary": "Gets all files of a package", 3394 "operationId": "listPackageFiles", 3395 "parameters": [ 3396 { 3397 "type": "string", 3398 "description": "owner of the package", 3399 "name": "owner", 3400 "in": "path", 3401 "required": true 3402 }, 3403 { 3404 "type": "string", 3405 "description": "type of the package", 3406 "name": "type", 3407 "in": "path", 3408 "required": true 3409 }, 3410 { 3411 "type": "string", 3412 "description": "name of the package", 3413 "name": "name", 3414 "in": "path", 3415 "required": true 3416 }, 3417 { 3418 "type": "string", 3419 "description": "version of the package", 3420 "name": "version", 3421 "in": "path", 3422 "required": true 3423 } 3424 ], 3425 "responses": { 3426 "200": { 3427 "$ref": "#/responses/PackageFileList" 3428 }, 3429 "404": { 3430 "$ref": "#/responses/notFound" 3431 } 3432 } 3433 } 3434 }, 3435 "/repos/issues/search": { 3436 "get": { 3437 "produces": [ 3438 "application/json" 3439 ], 3440 "tags": [ 3441 "issue" 3442 ], 3443 "summary": "Search for issues across the repositories that the user has access to", 3444 "operationId": "issueSearchIssues", 3445 "parameters": [ 3446 { 3447 "type": "string", 3448 "description": "whether issue is open or closed", 3449 "name": "state", 3450 "in": "query" 3451 }, 3452 { 3453 "type": "string", 3454 "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded", 3455 "name": "labels", 3456 "in": "query" 3457 }, 3458 { 3459 "type": "string", 3460 "description": "comma separated list of milestone names. Fetch only issues that have any of this milestones. Non existent are discarded", 3461 "name": "milestones", 3462 "in": "query" 3463 }, 3464 { 3465 "type": "string", 3466 "description": "search string", 3467 "name": "q", 3468 "in": "query" 3469 }, 3470 { 3471 "type": "integer", 3472 "format": "int64", 3473 "description": "repository to prioritize in the results", 3474 "name": "priority_repo_id", 3475 "in": "query" 3476 }, 3477 { 3478 "type": "string", 3479 "description": "filter by type (issues / pulls) if set", 3480 "name": "type", 3481 "in": "query" 3482 }, 3483 { 3484 "type": "string", 3485 "format": "date-time", 3486 "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format", 3487 "name": "since", 3488 "in": "query" 3489 }, 3490 { 3491 "type": "string", 3492 "format": "date-time", 3493 "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format", 3494 "name": "before", 3495 "in": "query" 3496 }, 3497 { 3498 "type": "boolean", 3499 "description": "filter (issues / pulls) assigned to you, default is false", 3500 "name": "assigned", 3501 "in": "query" 3502 }, 3503 { 3504 "type": "boolean", 3505 "description": "filter (issues / pulls) created by you, default is false", 3506 "name": "created", 3507 "in": "query" 3508 }, 3509 { 3510 "type": "boolean", 3511 "description": "filter (issues / pulls) mentioning you, default is false", 3512 "name": "mentioned", 3513 "in": "query" 3514 }, 3515 { 3516 "type": "boolean", 3517 "description": "filter pulls requesting your review, default is false", 3518 "name": "review_requested", 3519 "in": "query" 3520 }, 3521 { 3522 "type": "boolean", 3523 "description": "filter pulls reviewed by you, default is false", 3524 "name": "reviewed", 3525 "in": "query" 3526 }, 3527 { 3528 "type": "string", 3529 "description": "filter by owner", 3530 "name": "owner", 3531 "in": "query" 3532 }, 3533 { 3534 "type": "string", 3535 "description": "filter by team (requires organization owner parameter to be provided)", 3536 "name": "team", 3537 "in": "query" 3538 }, 3539 { 3540 "type": "integer", 3541 "description": "page number of results to return (1-based)", 3542 "name": "page", 3543 "in": "query" 3544 }, 3545 { 3546 "type": "integer", 3547 "description": "page size of results", 3548 "name": "limit", 3549 "in": "query" 3550 } 3551 ], 3552 "responses": { 3553 "200": { 3554 "$ref": "#/responses/IssueList" 3555 } 3556 } 3557 } 3558 }, 3559 "/repos/migrate": { 3560 "post": { 3561 "consumes": [ 3562 "application/json" 3563 ], 3564 "produces": [ 3565 "application/json" 3566 ], 3567 "tags": [ 3568 "repository" 3569 ], 3570 "summary": "Migrate a remote git repository", 3571 "operationId": "repoMigrate", 3572 "parameters": [ 3573 { 3574 "name": "body", 3575 "in": "body", 3576 "schema": { 3577 "$ref": "#/definitions/MigrateRepoOptions" 3578 } 3579 } 3580 ], 3581 "responses": { 3582 "201": { 3583 "$ref": "#/responses/Repository" 3584 }, 3585 "403": { 3586 "$ref": "#/responses/forbidden" 3587 }, 3588 "409": { 3589 "description": "The repository with the same name already exists." 3590 }, 3591 "422": { 3592 "$ref": "#/responses/validationError" 3593 } 3594 } 3595 } 3596 }, 3597 "/repos/search": { 3598 "get": { 3599 "produces": [ 3600 "application/json" 3601 ], 3602 "tags": [ 3603 "repository" 3604 ], 3605 "summary": "Search for repositories", 3606 "operationId": "repoSearch", 3607 "parameters": [ 3608 { 3609 "type": "string", 3610 "description": "keyword", 3611 "name": "q", 3612 "in": "query" 3613 }, 3614 { 3615 "type": "boolean", 3616 "description": "Limit search to repositories with keyword as topic", 3617 "name": "topic", 3618 "in": "query" 3619 }, 3620 { 3621 "type": "boolean", 3622 "description": "include search of keyword within repository description", 3623 "name": "includeDesc", 3624 "in": "query" 3625 }, 3626 { 3627 "type": "integer", 3628 "format": "int64", 3629 "description": "search only for repos that the user with the given id owns or contributes to", 3630 "name": "uid", 3631 "in": "query" 3632 }, 3633 { 3634 "type": "integer", 3635 "format": "int64", 3636 "description": "repo owner to prioritize in the results", 3637 "name": "priority_owner_id", 3638 "in": "query" 3639 }, 3640 { 3641 "type": "integer", 3642 "format": "int64", 3643 "description": "search only for repos that belong to the given team id", 3644 "name": "team_id", 3645 "in": "query" 3646 }, 3647 { 3648 "type": "integer", 3649 "format": "int64", 3650 "description": "search only for repos that the user with the given id has starred", 3651 "name": "starredBy", 3652 "in": "query" 3653 }, 3654 { 3655 "type": "boolean", 3656 "description": "include private repositories this user has access to (defaults to true)", 3657 "name": "private", 3658 "in": "query" 3659 }, 3660 { 3661 "type": "boolean", 3662 "description": "show only pubic, private or all repositories (defaults to all)", 3663 "name": "is_private", 3664 "in": "query" 3665 }, 3666 { 3667 "type": "boolean", 3668 "description": "include template repositories this user has access to (defaults to true)", 3669 "name": "template", 3670 "in": "query" 3671 }, 3672 { 3673 "type": "boolean", 3674 "description": "show only archived, non-archived or all repositories (defaults to all)", 3675 "name": "archived", 3676 "in": "query" 3677 }, 3678 { 3679 "type": "string", 3680 "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"", 3681 "name": "mode", 3682 "in": "query" 3683 }, 3684 { 3685 "type": "boolean", 3686 "description": "if `uid` is given, search only for repos that the user owns", 3687 "name": "exclusive", 3688 "in": "query" 3689 }, 3690 { 3691 "type": "string", 3692 "description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\"", 3693 "name": "sort", 3694 "in": "query" 3695 }, 3696 { 3697 "type": "string", 3698 "description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.", 3699 "name": "order", 3700 "in": "query" 3701 }, 3702 { 3703 "type": "integer", 3704 "description": "page number of results to return (1-based)", 3705 "name": "page", 3706 "in": "query" 3707 }, 3708 { 3709 "type": "integer", 3710 "description": "page size of results", 3711 "name": "limit", 3712 "in": "query" 3713 } 3714 ], 3715 "responses": { 3716 "200": { 3717 "$ref": "#/responses/SearchResults" 3718 }, 3719 "422": { 3720 "$ref": "#/responses/validationError" 3721 } 3722 } 3723 } 3724 }, 3725 "/repos/{owner}/{repo}": { 3726 "get": { 3727 "produces": [ 3728 "application/json" 3729 ], 3730 "tags": [ 3731 "repository" 3732 ], 3733 "summary": "Get a repository", 3734 "operationId": "repoGet", 3735 "parameters": [ 3736 { 3737 "type": "string", 3738 "description": "owner of the repo", 3739 "name": "owner", 3740 "in": "path", 3741 "required": true 3742 }, 3743 { 3744 "type": "string", 3745 "description": "name of the repo", 3746 "name": "repo", 3747 "in": "path", 3748 "required": true 3749 } 3750 ], 3751 "responses": { 3752 "200": { 3753 "$ref": "#/responses/Repository" 3754 }, 3755 "404": { 3756 "$ref": "#/responses/notFound" 3757 } 3758 } 3759 }, 3760 "delete": { 3761 "produces": [ 3762 "application/json" 3763 ], 3764 "tags": [ 3765 "repository" 3766 ], 3767 "summary": "Delete a repository", 3768 "operationId": "repoDelete", 3769 "parameters": [ 3770 { 3771 "type": "string", 3772 "description": "owner of the repo to delete", 3773 "name": "owner", 3774 "in": "path", 3775 "required": true 3776 }, 3777 { 3778 "type": "string", 3779 "description": "name of the repo to delete", 3780 "name": "repo", 3781 "in": "path", 3782 "required": true 3783 } 3784 ], 3785 "responses": { 3786 "204": { 3787 "$ref": "#/responses/empty" 3788 }, 3789 "403": { 3790 "$ref": "#/responses/forbidden" 3791 }, 3792 "404": { 3793 "$ref": "#/responses/notFound" 3794 } 3795 } 3796 }, 3797 "patch": { 3798 "produces": [ 3799 "application/json" 3800 ], 3801 "tags": [ 3802 "repository" 3803 ], 3804 "summary": "Edit a repository's properties. Only fields that are set will be changed.", 3805 "operationId": "repoEdit", 3806 "parameters": [ 3807 { 3808 "type": "string", 3809 "description": "owner of the repo to edit", 3810 "name": "owner", 3811 "in": "path", 3812 "required": true 3813 }, 3814 { 3815 "type": "string", 3816 "description": "name of the repo to edit", 3817 "name": "repo", 3818 "in": "path", 3819 "required": true 3820 }, 3821 { 3822 "description": "Properties of a repo that you can edit", 3823 "name": "body", 3824 "in": "body", 3825 "schema": { 3826 "$ref": "#/definitions/EditRepoOption" 3827 } 3828 } 3829 ], 3830 "responses": { 3831 "200": { 3832 "$ref": "#/responses/Repository" 3833 }, 3834 "403": { 3835 "$ref": "#/responses/forbidden" 3836 }, 3837 "404": { 3838 "$ref": "#/responses/notFound" 3839 }, 3840 "422": { 3841 "$ref": "#/responses/validationError" 3842 } 3843 } 3844 } 3845 }, 3846 "/repos/{owner}/{repo}/actions/runners/registration-token": { 3847 "get": { 3848 "produces": [ 3849 "application/json" 3850 ], 3851 "tags": [ 3852 "repository" 3853 ], 3854 "summary": "Get a repository's actions runner registration token", 3855 "operationId": "repoGetRunnerRegistrationToken", 3856 "parameters": [ 3857 { 3858 "type": "string", 3859 "description": "owner of the repo", 3860 "name": "owner", 3861 "in": "path", 3862 "required": true 3863 }, 3864 { 3865 "type": "string", 3866 "description": "name of the repo", 3867 "name": "repo", 3868 "in": "path", 3869 "required": true 3870 } 3871 ], 3872 "responses": { 3873 "200": { 3874 "$ref": "#/responses/RegistrationToken" 3875 } 3876 } 3877 } 3878 }, 3879 "/repos/{owner}/{repo}/actions/secrets": { 3880 "get": { 3881 "produces": [ 3882 "application/json" 3883 ], 3884 "tags": [ 3885 "repository" 3886 ], 3887 "summary": "List an repo's actions secrets", 3888 "operationId": "repoListActionsSecrets", 3889 "parameters": [ 3890 { 3891 "type": "string", 3892 "description": "owner of the repository", 3893 "name": "owner", 3894 "in": "path", 3895 "required": true 3896 }, 3897 { 3898 "type": "string", 3899 "description": "name of the repository", 3900 "name": "repo", 3901 "in": "path", 3902 "required": true 3903 }, 3904 { 3905 "type": "integer", 3906 "description": "page number of results to return (1-based)", 3907 "name": "page", 3908 "in": "query" 3909 }, 3910 { 3911 "type": "integer", 3912 "description": "page size of results", 3913 "name": "limit", 3914 "in": "query" 3915 } 3916 ], 3917 "responses": { 3918 "200": { 3919 "$ref": "#/responses/SecretList" 3920 }, 3921 "404": { 3922 "$ref": "#/responses/notFound" 3923 } 3924 } 3925 } 3926 }, 3927 "/repos/{owner}/{repo}/actions/secrets/{secretname}": { 3928 "put": { 3929 "consumes": [ 3930 "application/json" 3931 ], 3932 "produces": [ 3933 "application/json" 3934 ], 3935 "tags": [ 3936 "repository" 3937 ], 3938 "summary": "Create or Update a secret value in a repository", 3939 "operationId": "updateRepoSecret", 3940 "parameters": [ 3941 { 3942 "type": "string", 3943 "description": "owner of the repository", 3944 "name": "owner", 3945 "in": "path", 3946 "required": true 3947 }, 3948 { 3949 "type": "string", 3950 "description": "name of the repository", 3951 "name": "repo", 3952 "in": "path", 3953 "required": true 3954 }, 3955 { 3956 "type": "string", 3957 "description": "name of the secret", 3958 "name": "secretname", 3959 "in": "path", 3960 "required": true 3961 }, 3962 { 3963 "name": "body", 3964 "in": "body", 3965 "schema": { 3966 "$ref": "#/definitions/CreateOrUpdateSecretOption" 3967 } 3968 } 3969 ], 3970 "responses": { 3971 "201": { 3972 "description": "response when creating a secret" 3973 }, 3974 "204": { 3975 "description": "response when updating a secret" 3976 }, 3977 "400": { 3978 "$ref": "#/responses/error" 3979 }, 3980 "404": { 3981 "$ref": "#/responses/notFound" 3982 } 3983 } 3984 }, 3985 "delete": { 3986 "consumes": [ 3987 "application/json" 3988 ], 3989 "produces": [ 3990 "application/json" 3991 ], 3992 "tags": [ 3993 "repository" 3994 ], 3995 "summary": "Delete a secret in a repository", 3996 "operationId": "deleteRepoSecret", 3997 "parameters": [ 3998 { 3999 "type": "string", 4000 "description": "owner of the repository", 4001 "name": "owner", 4002 "in": "path", 4003 "required": true 4004 }, 4005 { 4006 "type": "string", 4007 "description": "name of the repository", 4008 "name": "repo", 4009 "in": "path", 4010 "required": true 4011 }, 4012 { 4013 "type": "string", 4014 "description": "name of the secret", 4015 "name": "secretname", 4016 "in": "path", 4017 "required": true 4018 } 4019 ], 4020 "responses": { 4021 "204": { 4022 "description": "delete one secret of the organization" 4023 }, 4024 "400": { 4025 "$ref": "#/responses/error" 4026 }, 4027 "404": { 4028 "$ref": "#/responses/notFound" 4029 } 4030 } 4031 } 4032 }, 4033 "/repos/{owner}/{repo}/actions/variables": { 4034 "get": { 4035 "produces": [ 4036 "application/json" 4037 ], 4038 "tags": [ 4039 "repository" 4040 ], 4041 "summary": "Get repo-level variables list", 4042 "operationId": "getRepoVariablesList", 4043 "parameters": [ 4044 { 4045 "type": "string", 4046 "description": "name of the owner", 4047 "name": "owner", 4048 "in": "path", 4049 "required": true 4050 }, 4051 { 4052 "type": "string", 4053 "description": "name of the repository", 4054 "name": "repo", 4055 "in": "path", 4056 "required": true 4057 }, 4058 { 4059 "type": "integer", 4060 "description": "page number of results to return (1-based)", 4061 "name": "page", 4062 "in": "query" 4063 }, 4064 { 4065 "type": "integer", 4066 "description": "page size of results", 4067 "name": "limit", 4068 "in": "query" 4069 } 4070 ], 4071 "responses": { 4072 "200": { 4073 "$ref": "#/responses/VariableList" 4074 }, 4075 "400": { 4076 "$ref": "#/responses/error" 4077 }, 4078 "404": { 4079 "$ref": "#/responses/notFound" 4080 } 4081 } 4082 } 4083 }, 4084 "/repos/{owner}/{repo}/actions/variables/{variablename}": { 4085 "get": { 4086 "produces": [ 4087 "application/json" 4088 ], 4089 "tags": [ 4090 "repository" 4091 ], 4092 "summary": "Get a repo-level variable", 4093 "operationId": "getRepoVariable", 4094 "parameters": [ 4095 { 4096 "type": "string", 4097 "description": "name of the owner", 4098 "name": "owner", 4099 "in": "path", 4100 "required": true 4101 }, 4102 { 4103 "type": "string", 4104 "description": "name of the repository", 4105 "name": "repo", 4106 "in": "path", 4107 "required": true 4108 }, 4109 { 4110 "type": "string", 4111 "description": "name of the variable", 4112 "name": "variablename", 4113 "in": "path", 4114 "required": true 4115 } 4116 ], 4117 "responses": { 4118 "200": { 4119 "$ref": "#/responses/ActionVariable" 4120 }, 4121 "400": { 4122 "$ref": "#/responses/error" 4123 }, 4124 "404": { 4125 "$ref": "#/responses/notFound" 4126 } 4127 } 4128 }, 4129 "put": { 4130 "produces": [ 4131 "application/json" 4132 ], 4133 "tags": [ 4134 "repository" 4135 ], 4136 "summary": "Update a repo-level variable", 4137 "operationId": "updateRepoVariable", 4138 "parameters": [ 4139 { 4140 "type": "string", 4141 "description": "name of the owner", 4142 "name": "owner", 4143 "in": "path", 4144 "required": true 4145 }, 4146 { 4147 "type": "string", 4148 "description": "name of the repository", 4149 "name": "repo", 4150 "in": "path", 4151 "required": true 4152 }, 4153 { 4154 "type": "string", 4155 "description": "name of the variable", 4156 "name": "variablename", 4157 "in": "path", 4158 "required": true 4159 }, 4160 { 4161 "name": "body", 4162 "in": "body", 4163 "schema": { 4164 "$ref": "#/definitions/UpdateVariableOption" 4165 } 4166 } 4167 ], 4168 "responses": { 4169 "201": { 4170 "description": "response when updating a repo-level variable" 4171 }, 4172 "204": { 4173 "description": "response when updating a repo-level variable" 4174 }, 4175 "400": { 4176 "$ref": "#/responses/error" 4177 }, 4178 "404": { 4179 "$ref": "#/responses/notFound" 4180 } 4181 } 4182 }, 4183 "post": { 4184 "produces": [ 4185 "application/json" 4186 ], 4187 "tags": [ 4188 "repository" 4189 ], 4190 "summary": "Create a repo-level variable", 4191 "operationId": "createRepoVariable", 4192 "parameters": [ 4193 { 4194 "type": "string", 4195 "description": "name of the owner", 4196 "name": "owner", 4197 "in": "path", 4198 "required": true 4199 }, 4200 { 4201 "type": "string", 4202 "description": "name of the repository", 4203 "name": "repo", 4204 "in": "path", 4205 "required": true 4206 }, 4207 { 4208 "type": "string", 4209 "description": "name of the variable", 4210 "name": "variablename", 4211 "in": "path", 4212 "required": true 4213 }, 4214 { 4215 "name": "body", 4216 "in": "body", 4217 "schema": { 4218 "$ref": "#/definitions/CreateVariableOption" 4219 } 4220 } 4221 ], 4222 "responses": { 4223 "201": { 4224 "description": "response when creating a repo-level variable" 4225 }, 4226 "204": { 4227 "description": "response when creating a repo-level variable" 4228 }, 4229 "400": { 4230 "$ref": "#/responses/error" 4231 }, 4232 "404": { 4233 "$ref": "#/responses/notFound" 4234 } 4235 } 4236 }, 4237 "delete": { 4238 "produces": [ 4239 "application/json" 4240 ], 4241 "tags": [ 4242 "repository" 4243 ], 4244 "summary": "Delete a repo-level variable", 4245 "operationId": "deleteRepoVariable", 4246 "parameters": [ 4247 { 4248 "type": "string", 4249 "description": "name of the owner", 4250 "name": "owner", 4251 "in": "path", 4252 "required": true 4253 }, 4254 { 4255 "type": "string", 4256 "description": "name of the repository", 4257 "name": "repo", 4258 "in": "path", 4259 "required": true 4260 }, 4261 { 4262 "type": "string", 4263 "description": "name of the variable", 4264 "name": "variablename", 4265 "in": "path", 4266 "required": true 4267 } 4268 ], 4269 "responses": { 4270 "200": { 4271 "$ref": "#/responses/ActionVariable" 4272 }, 4273 "201": { 4274 "description": "response when deleting a variable" 4275 }, 4276 "204": { 4277 "description": "response when deleting a variable" 4278 }, 4279 "400": { 4280 "$ref": "#/responses/error" 4281 }, 4282 "404": { 4283 "$ref": "#/responses/notFound" 4284 } 4285 } 4286 } 4287 }, 4288 "/repos/{owner}/{repo}/activities/feeds": { 4289 "get": { 4290 "produces": [ 4291 "application/json" 4292 ], 4293 "tags": [ 4294 "repository" 4295 ], 4296 "summary": "List a repository's activity feeds", 4297 "operationId": "repoListActivityFeeds", 4298 "parameters": [ 4299 { 4300 "type": "string", 4301 "description": "owner of the repo", 4302 "name": "owner", 4303 "in": "path", 4304 "required": true 4305 }, 4306 { 4307 "type": "string", 4308 "description": "name of the repo", 4309 "name": "repo", 4310 "in": "path", 4311 "required": true 4312 }, 4313 { 4314 "type": "string", 4315 "format": "date", 4316 "description": "the date of the activities to be found", 4317 "name": "date", 4318 "in": "query" 4319 }, 4320 { 4321 "type": "integer", 4322 "description": "page number of results to return (1-based)", 4323 "name": "page", 4324 "in": "query" 4325 }, 4326 { 4327 "type": "integer", 4328 "description": "page size of results", 4329 "name": "limit", 4330 "in": "query" 4331 } 4332 ], 4333 "responses": { 4334 "200": { 4335 "$ref": "#/responses/ActivityFeedsList" 4336 }, 4337 "404": { 4338 "$ref": "#/responses/notFound" 4339 } 4340 } 4341 } 4342 }, 4343 "/repos/{owner}/{repo}/archive/{archive}": { 4344 "get": { 4345 "produces": [ 4346 "application/json" 4347 ], 4348 "tags": [ 4349 "repository" 4350 ], 4351 "summary": "Get an archive of a repository", 4352 "operationId": "repoGetArchive", 4353 "parameters": [ 4354 { 4355 "type": "string", 4356 "description": "owner of the repo", 4357 "name": "owner", 4358 "in": "path", 4359 "required": true 4360 }, 4361 { 4362 "type": "string", 4363 "description": "name of the repo", 4364 "name": "repo", 4365 "in": "path", 4366 "required": true 4367 }, 4368 { 4369 "type": "string", 4370 "description": "the git reference for download with attached archive format (e.g. master.zip)", 4371 "name": "archive", 4372 "in": "path", 4373 "required": true 4374 } 4375 ], 4376 "responses": { 4377 "200": { 4378 "description": "success" 4379 }, 4380 "404": { 4381 "$ref": "#/responses/notFound" 4382 } 4383 } 4384 } 4385 }, 4386 "/repos/{owner}/{repo}/assignees": { 4387 "get": { 4388 "produces": [ 4389 "application/json" 4390 ], 4391 "tags": [ 4392 "repository" 4393 ], 4394 "summary": "Return all users that have write access and can be assigned to issues", 4395 "operationId": "repoGetAssignees", 4396 "parameters": [ 4397 { 4398 "type": "string", 4399 "description": "owner of the repo", 4400 "name": "owner", 4401 "in": "path", 4402 "required": true 4403 }, 4404 { 4405 "type": "string", 4406 "description": "name of the repo", 4407 "name": "repo", 4408 "in": "path", 4409 "required": true 4410 } 4411 ], 4412 "responses": { 4413 "200": { 4414 "$ref": "#/responses/UserList" 4415 }, 4416 "404": { 4417 "$ref": "#/responses/notFound" 4418 } 4419 } 4420 } 4421 }, 4422 "/repos/{owner}/{repo}/avatar": { 4423 "post": { 4424 "produces": [ 4425 "application/json" 4426 ], 4427 "tags": [ 4428 "repository" 4429 ], 4430 "summary": "Update avatar", 4431 "operationId": "repoUpdateAvatar", 4432 "parameters": [ 4433 { 4434 "type": "string", 4435 "description": "owner of the repo", 4436 "name": "owner", 4437 "in": "path", 4438 "required": true 4439 }, 4440 { 4441 "type": "string", 4442 "description": "name of the repo", 4443 "name": "repo", 4444 "in": "path", 4445 "required": true 4446 }, 4447 { 4448 "name": "body", 4449 "in": "body", 4450 "schema": { 4451 "$ref": "#/definitions/UpdateRepoAvatarOption" 4452 } 4453 } 4454 ], 4455 "responses": { 4456 "204": { 4457 "$ref": "#/responses/empty" 4458 }, 4459 "404": { 4460 "$ref": "#/responses/notFound" 4461 } 4462 } 4463 }, 4464 "delete": { 4465 "produces": [ 4466 "application/json" 4467 ], 4468 "tags": [ 4469 "repository" 4470 ], 4471 "summary": "Delete avatar", 4472 "operationId": "repoDeleteAvatar", 4473 "parameters": [ 4474 { 4475 "type": "string", 4476 "description": "owner of the repo", 4477 "name": "owner", 4478 "in": "path", 4479 "required": true 4480 }, 4481 { 4482 "type": "string", 4483 "description": "name of the repo", 4484 "name": "repo", 4485 "in": "path", 4486 "required": true 4487 } 4488 ], 4489 "responses": { 4490 "204": { 4491 "$ref": "#/responses/empty" 4492 }, 4493 "404": { 4494 "$ref": "#/responses/notFound" 4495 } 4496 } 4497 } 4498 }, 4499 "/repos/{owner}/{repo}/branch_protections": { 4500 "get": { 4501 "produces": [ 4502 "application/json" 4503 ], 4504 "tags": [ 4505 "repository" 4506 ], 4507 "summary": "List branch protections for a repository", 4508 "operationId": "repoListBranchProtection", 4509 "parameters": [ 4510 { 4511 "type": "string", 4512 "description": "owner of the repo", 4513 "name": "owner", 4514 "in": "path", 4515 "required": true 4516 }, 4517 { 4518 "type": "string", 4519 "description": "name of the repo", 4520 "name": "repo", 4521 "in": "path", 4522 "required": true 4523 } 4524 ], 4525 "responses": { 4526 "200": { 4527 "$ref": "#/responses/BranchProtectionList" 4528 } 4529 } 4530 }, 4531 "post": { 4532 "consumes": [ 4533 "application/json" 4534 ], 4535 "produces": [ 4536 "application/json" 4537 ], 4538 "tags": [ 4539 "repository" 4540 ], 4541 "summary": "Create a branch protections for a repository", 4542 "operationId": "repoCreateBranchProtection", 4543 "parameters": [ 4544 { 4545 "type": "string", 4546 "description": "owner of the repo", 4547 "name": "owner", 4548 "in": "path", 4549 "required": true 4550 }, 4551 { 4552 "type": "string", 4553 "description": "name of the repo", 4554 "name": "repo", 4555 "in": "path", 4556 "required": true 4557 }, 4558 { 4559 "name": "body", 4560 "in": "body", 4561 "schema": { 4562 "$ref": "#/definitions/CreateBranchProtectionOption" 4563 } 4564 } 4565 ], 4566 "responses": { 4567 "201": { 4568 "$ref": "#/responses/BranchProtection" 4569 }, 4570 "403": { 4571 "$ref": "#/responses/forbidden" 4572 }, 4573 "404": { 4574 "$ref": "#/responses/notFound" 4575 }, 4576 "422": { 4577 "$ref": "#/responses/validationError" 4578 }, 4579 "423": { 4580 "$ref": "#/responses/repoArchivedError" 4581 } 4582 } 4583 } 4584 }, 4585 "/repos/{owner}/{repo}/branch_protections/{name}": { 4586 "get": { 4587 "produces": [ 4588 "application/json" 4589 ], 4590 "tags": [ 4591 "repository" 4592 ], 4593 "summary": "Get a specific branch protection for the repository", 4594 "operationId": "repoGetBranchProtection", 4595 "parameters": [ 4596 { 4597 "type": "string", 4598 "description": "owner of the repo", 4599 "name": "owner", 4600 "in": "path", 4601 "required": true 4602 }, 4603 { 4604 "type": "string", 4605 "description": "name of the repo", 4606 "name": "repo", 4607 "in": "path", 4608 "required": true 4609 }, 4610 { 4611 "type": "string", 4612 "description": "name of protected branch", 4613 "name": "name", 4614 "in": "path", 4615 "required": true 4616 } 4617 ], 4618 "responses": { 4619 "200": { 4620 "$ref": "#/responses/BranchProtection" 4621 }, 4622 "404": { 4623 "$ref": "#/responses/notFound" 4624 } 4625 } 4626 }, 4627 "delete": { 4628 "produces": [ 4629 "application/json" 4630 ], 4631 "tags": [ 4632 "repository" 4633 ], 4634 "summary": "Delete a specific branch protection for the repository", 4635 "operationId": "repoDeleteBranchProtection", 4636 "parameters": [ 4637 { 4638 "type": "string", 4639 "description": "owner of the repo", 4640 "name": "owner", 4641 "in": "path", 4642 "required": true 4643 }, 4644 { 4645 "type": "string", 4646 "description": "name of the repo", 4647 "name": "repo", 4648 "in": "path", 4649 "required": true 4650 }, 4651 { 4652 "type": "string", 4653 "description": "name of protected branch", 4654 "name": "name", 4655 "in": "path", 4656 "required": true 4657 } 4658 ], 4659 "responses": { 4660 "204": { 4661 "$ref": "#/responses/empty" 4662 }, 4663 "404": { 4664 "$ref": "#/responses/notFound" 4665 } 4666 } 4667 }, 4668 "patch": { 4669 "consumes": [ 4670 "application/json" 4671 ], 4672 "produces": [ 4673 "application/json" 4674 ], 4675 "tags": [ 4676 "repository" 4677 ], 4678 "summary": "Edit a branch protections for a repository. Only fields that are set will be changed", 4679 "operationId": "repoEditBranchProtection", 4680 "parameters": [ 4681 { 4682 "type": "string", 4683 "description": "owner of the repo", 4684 "name": "owner", 4685 "in": "path", 4686 "required": true 4687 }, 4688 { 4689 "type": "string", 4690 "description": "name of the repo", 4691 "name": "repo", 4692 "in": "path", 4693 "required": true 4694 }, 4695 { 4696 "type": "string", 4697 "description": "name of protected branch", 4698 "name": "name", 4699 "in": "path", 4700 "required": true 4701 }, 4702 { 4703 "name": "body", 4704 "in": "body", 4705 "schema": { 4706 "$ref": "#/definitions/EditBranchProtectionOption" 4707 } 4708 } 4709 ], 4710 "responses": { 4711 "200": { 4712 "$ref": "#/responses/BranchProtection" 4713 }, 4714 "404": { 4715 "$ref": "#/responses/notFound" 4716 }, 4717 "422": { 4718 "$ref": "#/responses/validationError" 4719 }, 4720 "423": { 4721 "$ref": "#/responses/repoArchivedError" 4722 } 4723 } 4724 } 4725 }, 4726 "/repos/{owner}/{repo}/branches": { 4727 "get": { 4728 "produces": [ 4729 "application/json" 4730 ], 4731 "tags": [ 4732 "repository" 4733 ], 4734 "summary": "List a repository's branches", 4735 "operationId": "repoListBranches", 4736 "parameters": [ 4737 { 4738 "type": "string", 4739 "description": "owner of the repo", 4740 "name": "owner", 4741 "in": "path", 4742 "required": true 4743 }, 4744 { 4745 "type": "string", 4746 "description": "name of the repo", 4747 "name": "repo", 4748 "in": "path", 4749 "required": true 4750 }, 4751 { 4752 "type": "integer", 4753 "description": "page number of results to return (1-based)", 4754 "name": "page", 4755 "in": "query" 4756 }, 4757 { 4758 "type": "integer", 4759 "description": "page size of results", 4760 "name": "limit", 4761 "in": "query" 4762 } 4763 ], 4764 "responses": { 4765 "200": { 4766 "$ref": "#/responses/BranchList" 4767 } 4768 } 4769 }, 4770 "post": { 4771 "consumes": [ 4772 "application/json" 4773 ], 4774 "produces": [ 4775 "application/json" 4776 ], 4777 "tags": [ 4778 "repository" 4779 ], 4780 "summary": "Create a branch", 4781 "operationId": "repoCreateBranch", 4782 "parameters": [ 4783 { 4784 "type": "string", 4785 "description": "owner of the repo", 4786 "name": "owner", 4787 "in": "path", 4788 "required": true 4789 }, 4790 { 4791 "type": "string", 4792 "description": "name of the repo", 4793 "name": "repo", 4794 "in": "path", 4795 "required": true 4796 }, 4797 { 4798 "name": "body", 4799 "in": "body", 4800 "schema": { 4801 "$ref": "#/definitions/CreateBranchRepoOption" 4802 } 4803 } 4804 ], 4805 "responses": { 4806 "201": { 4807 "$ref": "#/responses/Branch" 4808 }, 4809 "403": { 4810 "description": "The branch is archived or a mirror." 4811 }, 4812 "404": { 4813 "description": "The old branch does not exist." 4814 }, 4815 "409": { 4816 "description": "The branch with the same name already exists." 4817 }, 4818 "423": { 4819 "$ref": "#/responses/repoArchivedError" 4820 } 4821 } 4822 } 4823 }, 4824 "/repos/{owner}/{repo}/branches/{branch}": { 4825 "get": { 4826 "produces": [ 4827 "application/json" 4828 ], 4829 "tags": [ 4830 "repository" 4831 ], 4832 "summary": "Retrieve a specific branch from a repository, including its effective branch protection", 4833 "operationId": "repoGetBranch", 4834 "parameters": [ 4835 { 4836 "type": "string", 4837 "description": "owner of the repo", 4838 "name": "owner", 4839 "in": "path", 4840 "required": true 4841 }, 4842 { 4843 "type": "string", 4844 "description": "name of the repo", 4845 "name": "repo", 4846 "in": "path", 4847 "required": true 4848 }, 4849 { 4850 "type": "string", 4851 "description": "branch to get", 4852 "name": "branch", 4853 "in": "path", 4854 "required": true 4855 } 4856 ], 4857 "responses": { 4858 "200": { 4859 "$ref": "#/responses/Branch" 4860 }, 4861 "404": { 4862 "$ref": "#/responses/notFound" 4863 } 4864 } 4865 }, 4866 "delete": { 4867 "produces": [ 4868 "application/json" 4869 ], 4870 "tags": [ 4871 "repository" 4872 ], 4873 "summary": "Delete a specific branch from a repository", 4874 "operationId": "repoDeleteBranch", 4875 "parameters": [ 4876 { 4877 "type": "string", 4878 "description": "owner of the repo", 4879 "name": "owner", 4880 "in": "path", 4881 "required": true 4882 }, 4883 { 4884 "type": "string", 4885 "description": "name of the repo", 4886 "name": "repo", 4887 "in": "path", 4888 "required": true 4889 }, 4890 { 4891 "type": "string", 4892 "description": "branch to delete", 4893 "name": "branch", 4894 "in": "path", 4895 "required": true 4896 } 4897 ], 4898 "responses": { 4899 "204": { 4900 "$ref": "#/responses/empty" 4901 }, 4902 "403": { 4903 "$ref": "#/responses/error" 4904 }, 4905 "404": { 4906 "$ref": "#/responses/notFound" 4907 }, 4908 "423": { 4909 "$ref": "#/responses/repoArchivedError" 4910 } 4911 } 4912 } 4913 }, 4914 "/repos/{owner}/{repo}/collaborators": { 4915 "get": { 4916 "produces": [ 4917 "application/json" 4918 ], 4919 "tags": [ 4920 "repository" 4921 ], 4922 "summary": "List a repository's collaborators", 4923 "operationId": "repoListCollaborators", 4924 "parameters": [ 4925 { 4926 "type": "string", 4927 "description": "owner of the repo", 4928 "name": "owner", 4929 "in": "path", 4930 "required": true 4931 }, 4932 { 4933 "type": "string", 4934 "description": "name of the repo", 4935 "name": "repo", 4936 "in": "path", 4937 "required": true 4938 }, 4939 { 4940 "type": "integer", 4941 "description": "page number of results to return (1-based)", 4942 "name": "page", 4943 "in": "query" 4944 }, 4945 { 4946 "type": "integer", 4947 "description": "page size of results", 4948 "name": "limit", 4949 "in": "query" 4950 } 4951 ], 4952 "responses": { 4953 "200": { 4954 "$ref": "#/responses/UserList" 4955 }, 4956 "404": { 4957 "$ref": "#/responses/notFound" 4958 } 4959 } 4960 } 4961 }, 4962 "/repos/{owner}/{repo}/collaborators/{collaborator}": { 4963 "get": { 4964 "produces": [ 4965 "application/json" 4966 ], 4967 "tags": [ 4968 "repository" 4969 ], 4970 "summary": "Check if a user is a collaborator of a repository", 4971 "operationId": "repoCheckCollaborator", 4972 "parameters": [ 4973 { 4974 "type": "string", 4975 "description": "owner of the repo", 4976 "name": "owner", 4977 "in": "path", 4978 "required": true 4979 }, 4980 { 4981 "type": "string", 4982 "description": "name of the repo", 4983 "name": "repo", 4984 "in": "path", 4985 "required": true 4986 }, 4987 { 4988 "type": "string", 4989 "description": "username of the collaborator", 4990 "name": "collaborator", 4991 "in": "path", 4992 "required": true 4993 } 4994 ], 4995 "responses": { 4996 "204": { 4997 "$ref": "#/responses/empty" 4998 }, 4999 "404": { 5000 "$ref": "#/responses/notFound" 5001 }, 5002 "422": { 5003 "$ref": "#/responses/validationError" 5004 } 5005 } 5006 }, 5007 "put": { 5008 "produces": [ 5009 "application/json" 5010 ], 5011 "tags": [ 5012 "repository" 5013 ], 5014 "summary": "Add a collaborator to a repository", 5015 "operationId": "repoAddCollaborator", 5016 "parameters": [ 5017 { 5018 "type": "string", 5019 "description": "owner of the repo", 5020 "name": "owner", 5021 "in": "path", 5022 "required": true 5023 }, 5024 { 5025 "type": "string", 5026 "description": "name of the repo", 5027 "name": "repo", 5028 "in": "path", 5029 "required": true 5030 }, 5031 { 5032 "type": "string", 5033 "description": "username of the collaborator to add", 5034 "name": "collaborator", 5035 "in": "path", 5036 "required": true 5037 }, 5038 { 5039 "name": "body", 5040 "in": "body", 5041 "schema": { 5042 "$ref": "#/definitions/AddCollaboratorOption" 5043 } 5044 } 5045 ], 5046 "responses": { 5047 "204": { 5048 "$ref": "#/responses/empty" 5049 }, 5050 "403": { 5051 "$ref": "#/responses/forbidden" 5052 }, 5053 "404": { 5054 "$ref": "#/responses/notFound" 5055 }, 5056 "422": { 5057 "$ref": "#/responses/validationError" 5058 } 5059 } 5060 }, 5061 "delete": { 5062 "produces": [ 5063 "application/json" 5064 ], 5065 "tags": [ 5066 "repository" 5067 ], 5068 "summary": "Delete a collaborator from a repository", 5069 "operationId": "repoDeleteCollaborator", 5070 "parameters": [ 5071 { 5072 "type": "string", 5073 "description": "owner of the repo", 5074 "name": "owner", 5075 "in": "path", 5076 "required": true 5077 }, 5078 { 5079 "type": "string", 5080 "description": "name of the repo", 5081 "name": "repo", 5082 "in": "path", 5083 "required": true 5084 }, 5085 { 5086 "type": "string", 5087 "description": "username of the collaborator to delete", 5088 "name": "collaborator", 5089 "in": "path", 5090 "required": true 5091 } 5092 ], 5093 "responses": { 5094 "204": { 5095 "$ref": "#/responses/empty" 5096 }, 5097 "404": { 5098 "$ref": "#/responses/notFound" 5099 }, 5100 "422": { 5101 "$ref": "#/responses/validationError" 5102 } 5103 } 5104 } 5105 }, 5106 "/repos/{owner}/{repo}/collaborators/{collaborator}/permission": { 5107 "get": { 5108 "produces": [ 5109 "application/json" 5110 ], 5111 "tags": [ 5112 "repository" 5113 ], 5114 "summary": "Get repository permissions for a user", 5115 "operationId": "repoGetRepoPermissions", 5116 "parameters": [ 5117 { 5118 "type": "string", 5119 "description": "owner of the repo", 5120 "name": "owner", 5121 "in": "path", 5122 "required": true 5123 }, 5124 { 5125 "type": "string", 5126 "description": "name of the repo", 5127 "name": "repo", 5128 "in": "path", 5129 "required": true 5130 }, 5131 { 5132 "type": "string", 5133 "description": "username of the collaborator", 5134 "name": "collaborator", 5135 "in": "path", 5136 "required": true 5137 } 5138 ], 5139 "responses": { 5140 "200": { 5141 "$ref": "#/responses/RepoCollaboratorPermission" 5142 }, 5143 "403": { 5144 "$ref": "#/responses/forbidden" 5145 }, 5146 "404": { 5147 "$ref": "#/responses/notFound" 5148 } 5149 } 5150 } 5151 }, 5152 "/repos/{owner}/{repo}/commits": { 5153 "get": { 5154 "produces": [ 5155 "application/json" 5156 ], 5157 "tags": [ 5158 "repository" 5159 ], 5160 "summary": "Get a list of all commits from a repository", 5161 "operationId": "repoGetAllCommits", 5162 "parameters": [ 5163 { 5164 "type": "string", 5165 "description": "owner of the repo", 5166 "name": "owner", 5167 "in": "path", 5168 "required": true 5169 }, 5170 { 5171 "type": "string", 5172 "description": "name of the repo", 5173 "name": "repo", 5174 "in": "path", 5175 "required": true 5176 }, 5177 { 5178 "type": "string", 5179 "description": "SHA or branch to start listing commits from (usually 'master')", 5180 "name": "sha", 5181 "in": "query" 5182 }, 5183 { 5184 "type": "string", 5185 "description": "filepath of a file/dir", 5186 "name": "path", 5187 "in": "query" 5188 }, 5189 { 5190 "type": "boolean", 5191 "description": "include diff stats for every commit (disable for speedup, default 'true')", 5192 "name": "stat", 5193 "in": "query" 5194 }, 5195 { 5196 "type": "boolean", 5197 "description": "include verification for every commit (disable for speedup, default 'true')", 5198 "name": "verification", 5199 "in": "query" 5200 }, 5201 { 5202 "type": "boolean", 5203 "description": "include a list of affected files for every commit (disable for speedup, default 'true')", 5204 "name": "files", 5205 "in": "query" 5206 }, 5207 { 5208 "type": "integer", 5209 "description": "page number of results to return (1-based)", 5210 "name": "page", 5211 "in": "query" 5212 }, 5213 { 5214 "type": "integer", 5215 "description": "page size of results (ignored if used with 'path')", 5216 "name": "limit", 5217 "in": "query" 5218 }, 5219 { 5220 "type": "string", 5221 "description": "commits that match the given specifier will not be listed.", 5222 "name": "not", 5223 "in": "query" 5224 } 5225 ], 5226 "responses": { 5227 "200": { 5228 "$ref": "#/responses/CommitList" 5229 }, 5230 "404": { 5231 "$ref": "#/responses/notFound" 5232 }, 5233 "409": { 5234 "$ref": "#/responses/EmptyRepository" 5235 } 5236 } 5237 } 5238 }, 5239 "/repos/{owner}/{repo}/commits/{ref}/status": { 5240 "get": { 5241 "produces": [ 5242 "application/json" 5243 ], 5244 "tags": [ 5245 "repository" 5246 ], 5247 "summary": "Get a commit's combined status, by branch/tag/commit reference", 5248 "operationId": "repoGetCombinedStatusByRef", 5249 "parameters": [ 5250 { 5251 "type": "string", 5252 "description": "owner of the repo", 5253 "name": "owner", 5254 "in": "path", 5255 "required": true 5256 }, 5257 { 5258 "type": "string", 5259 "description": "name of the repo", 5260 "name": "repo", 5261 "in": "path", 5262 "required": true 5263 }, 5264 { 5265 "type": "string", 5266 "description": "name of branch/tag/commit", 5267 "name": "ref", 5268 "in": "path", 5269 "required": true 5270 }, 5271 { 5272 "type": "integer", 5273 "description": "page number of results to return (1-based)", 5274 "name": "page", 5275 "in": "query" 5276 }, 5277 { 5278 "type": "integer", 5279 "description": "page size of results", 5280 "name": "limit", 5281 "in": "query" 5282 } 5283 ], 5284 "responses": { 5285 "200": { 5286 "$ref": "#/responses/CombinedStatus" 5287 }, 5288 "400": { 5289 "$ref": "#/responses/error" 5290 }, 5291 "404": { 5292 "$ref": "#/responses/notFound" 5293 } 5294 } 5295 } 5296 }, 5297 "/repos/{owner}/{repo}/commits/{ref}/statuses": { 5298 "get": { 5299 "produces": [ 5300 "application/json" 5301 ], 5302 "tags": [ 5303 "repository" 5304 ], 5305 "summary": "Get a commit's statuses, by branch/tag/commit reference", 5306 "operationId": "repoListStatusesByRef", 5307 "parameters": [ 5308 { 5309 "type": "string", 5310 "description": "owner of the repo", 5311 "name": "owner", 5312 "in": "path", 5313 "required": true 5314 }, 5315 { 5316 "type": "string", 5317 "description": "name of the repo", 5318 "name": "repo", 5319 "in": "path", 5320 "required": true 5321 }, 5322 { 5323 "type": "string", 5324 "description": "name of branch/tag/commit", 5325 "name": "ref", 5326 "in": "path", 5327 "required": true 5328 }, 5329 { 5330 "enum": [ 5331 "oldest", 5332 "recentupdate", 5333 "leastupdate", 5334 "leastindex", 5335 "highestindex" 5336 ], 5337 "type": "string", 5338 "description": "type of sort", 5339 "name": "sort", 5340 "in": "query" 5341 }, 5342 { 5343 "enum": [ 5344 "pending", 5345 "success", 5346 "error", 5347 "failure", 5348 "warning" 5349 ], 5350 "type": "string", 5351 "description": "type of state", 5352 "name": "state", 5353 "in": "query" 5354 }, 5355 { 5356 "type": "integer", 5357 "description": "page number of results to return (1-based)", 5358 "name": "page", 5359 "in": "query" 5360 }, 5361 { 5362 "type": "integer", 5363 "description": "page size of results", 5364 "name": "limit", 5365 "in": "query" 5366 } 5367 ], 5368 "responses": { 5369 "200": { 5370 "$ref": "#/responses/CommitStatusList" 5371 }, 5372 "400": { 5373 "$ref": "#/responses/error" 5374 }, 5375 "404": { 5376 "$ref": "#/responses/notFound" 5377 } 5378 } 5379 } 5380 }, 5381 "/repos/{owner}/{repo}/commits/{sha}/pull": { 5382 "get": { 5383 "produces": [ 5384 "application/json" 5385 ], 5386 "tags": [ 5387 "repository" 5388 ], 5389 "summary": "Get the merged pull request of the commit", 5390 "operationId": "repoGetCommitPullRequest", 5391 "parameters": [ 5392 { 5393 "type": "string", 5394 "description": "owner of the repo", 5395 "name": "owner", 5396 "in": "path", 5397 "required": true 5398 }, 5399 { 5400 "type": "string", 5401 "description": "name of the repo", 5402 "name": "repo", 5403 "in": "path", 5404 "required": true 5405 }, 5406 { 5407 "type": "string", 5408 "description": "SHA of the commit to get", 5409 "name": "sha", 5410 "in": "path", 5411 "required": true 5412 } 5413 ], 5414 "responses": { 5415 "200": { 5416 "$ref": "#/responses/PullRequest" 5417 }, 5418 "404": { 5419 "$ref": "#/responses/notFound" 5420 } 5421 } 5422 } 5423 }, 5424 "/repos/{owner}/{repo}/compare/{basehead}": { 5425 "get": { 5426 "produces": [ 5427 "application/json" 5428 ], 5429 "tags": [ 5430 "repository" 5431 ], 5432 "summary": "Get commit comparison information", 5433 "operationId": "repoCompareDiff", 5434 "parameters": [ 5435 { 5436 "type": "string", 5437 "description": "owner of the repo", 5438 "name": "owner", 5439 "in": "path", 5440 "required": true 5441 }, 5442 { 5443 "type": "string", 5444 "description": "name of the repo", 5445 "name": "repo", 5446 "in": "path", 5447 "required": true 5448 }, 5449 { 5450 "type": "string", 5451 "description": "compare two branches or commits", 5452 "name": "basehead", 5453 "in": "path", 5454 "required": true 5455 } 5456 ], 5457 "responses": { 5458 "200": { 5459 "$ref": "#/responses/Compare" 5460 }, 5461 "404": { 5462 "$ref": "#/responses/notFound" 5463 } 5464 } 5465 } 5466 }, 5467 "/repos/{owner}/{repo}/contents": { 5468 "get": { 5469 "produces": [ 5470 "application/json" 5471 ], 5472 "tags": [ 5473 "repository" 5474 ], 5475 "summary": "Gets the metadata of all the entries of the root dir", 5476 "operationId": "repoGetContentsList", 5477 "parameters": [ 5478 { 5479 "type": "string", 5480 "description": "owner of the repo", 5481 "name": "owner", 5482 "in": "path", 5483 "required": true 5484 }, 5485 { 5486 "type": "string", 5487 "description": "name of the repo", 5488 "name": "repo", 5489 "in": "path", 5490 "required": true 5491 }, 5492 { 5493 "type": "string", 5494 "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)", 5495 "name": "ref", 5496 "in": "query" 5497 } 5498 ], 5499 "responses": { 5500 "200": { 5501 "$ref": "#/responses/ContentsListResponse" 5502 }, 5503 "404": { 5504 "$ref": "#/responses/notFound" 5505 } 5506 } 5507 }, 5508 "post": { 5509 "consumes": [ 5510 "application/json" 5511 ], 5512 "produces": [ 5513 "application/json" 5514 ], 5515 "tags": [ 5516 "repository" 5517 ], 5518 "summary": "Modify multiple files in a repository", 5519 "operationId": "repoChangeFiles", 5520 "parameters": [ 5521 { 5522 "type": "string", 5523 "description": "owner of the repo", 5524 "name": "owner", 5525 "in": "path", 5526 "required": true 5527 }, 5528 { 5529 "type": "string", 5530 "description": "name of the repo", 5531 "name": "repo", 5532 "in": "path", 5533 "required": true 5534 }, 5535 { 5536 "name": "body", 5537 "in": "body", 5538 "required": true, 5539 "schema": { 5540 "$ref": "#/definitions/ChangeFilesOptions" 5541 } 5542 } 5543 ], 5544 "responses": { 5545 "201": { 5546 "$ref": "#/responses/FilesResponse" 5547 }, 5548 "403": { 5549 "$ref": "#/responses/error" 5550 }, 5551 "404": { 5552 "$ref": "#/responses/notFound" 5553 }, 5554 "422": { 5555 "$ref": "#/responses/error" 5556 }, 5557 "423": { 5558 "$ref": "#/responses/repoArchivedError" 5559 } 5560 } 5561 } 5562 }, 5563 "/repos/{owner}/{repo}/contents/{filepath}": { 5564 "get": { 5565 "produces": [ 5566 "application/json" 5567 ], 5568 "tags": [ 5569 "repository" 5570 ], 5571 "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir", 5572 "operationId": "repoGetContents", 5573 "parameters": [ 5574 { 5575 "type": "string", 5576 "description": "owner of the repo", 5577 "name": "owner", 5578 "in": "path", 5579 "required": true 5580 }, 5581 { 5582 "type": "string", 5583 "description": "name of the repo", 5584 "name": "repo", 5585 "in": "path", 5586 "required": true 5587 }, 5588 { 5589 "type": "string", 5590 "description": "path of the dir, file, symlink or submodule in the repo", 5591 "name": "filepath", 5592 "in": "path", 5593 "required": true 5594 }, 5595 { 5596 "type": "string", 5597 "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)", 5598 "name": "ref", 5599 "in": "query" 5600 } 5601 ], 5602 "responses": { 5603 "200": { 5604 "$ref": "#/responses/ContentsResponse" 5605 }, 5606 "404": { 5607 "$ref": "#/responses/notFound" 5608 } 5609 } 5610 }, 5611 "put": { 5612 "consumes": [ 5613 "application/json" 5614 ], 5615 "produces": [ 5616 "application/json" 5617 ], 5618 "tags": [ 5619 "repository" 5620 ], 5621 "summary": "Update a file in a repository", 5622 "operationId": "repoUpdateFile", 5623 "parameters": [ 5624 { 5625 "type": "string", 5626 "description": "owner of the repo", 5627 "name": "owner", 5628 "in": "path", 5629 "required": true 5630 }, 5631 { 5632 "type": "string", 5633 "description": "name of the repo", 5634 "name": "repo", 5635 "in": "path", 5636 "required": true 5637 }, 5638 { 5639 "type": "string", 5640 "description": "path of the file to update", 5641 "name": "filepath", 5642 "in": "path", 5643 "required": true 5644 }, 5645 { 5646 "name": "body", 5647 "in": "body", 5648 "required": true, 5649 "schema": { 5650 "$ref": "#/definitions/UpdateFileOptions" 5651 } 5652 } 5653 ], 5654 "responses": { 5655 "200": { 5656 "$ref": "#/responses/FileResponse" 5657 }, 5658 "403": { 5659 "$ref": "#/responses/error" 5660 }, 5661 "404": { 5662 "$ref": "#/responses/notFound" 5663 }, 5664 "422": { 5665 "$ref": "#/responses/error" 5666 }, 5667 "423": { 5668 "$ref": "#/responses/repoArchivedError" 5669 } 5670 } 5671 }, 5672 "post": { 5673 "consumes": [ 5674 "application/json" 5675 ], 5676 "produces": [ 5677 "application/json" 5678 ], 5679 "tags": [ 5680 "repository" 5681 ], 5682 "summary": "Create a file in a repository", 5683 "operationId": "repoCreateFile", 5684 "parameters": [ 5685 { 5686 "type": "string", 5687 "description": "owner of the repo", 5688 "name": "owner", 5689 "in": "path", 5690 "required": true 5691 }, 5692 { 5693 "type": "string", 5694 "description": "name of the repo", 5695 "name": "repo", 5696 "in": "path", 5697 "required": true 5698 }, 5699 { 5700 "type": "string", 5701 "description": "path of the file to create", 5702 "name": "filepath", 5703 "in": "path", 5704 "required": true 5705 }, 5706 { 5707 "name": "body", 5708 "in": "body", 5709 "required": true, 5710 "schema": { 5711 "$ref": "#/definitions/CreateFileOptions" 5712 } 5713 } 5714 ], 5715 "responses": { 5716 "201": { 5717 "$ref": "#/responses/FileResponse" 5718 }, 5719 "403": { 5720 "$ref": "#/responses/error" 5721 }, 5722 "404": { 5723 "$ref": "#/responses/notFound" 5724 }, 5725 "422": { 5726 "$ref": "#/responses/error" 5727 }, 5728 "423": { 5729 "$ref": "#/responses/repoArchivedError" 5730 } 5731 } 5732 }, 5733 "delete": { 5734 "consumes": [ 5735 "application/json" 5736 ], 5737 "produces": [ 5738 "application/json" 5739 ], 5740 "tags": [ 5741 "repository" 5742 ], 5743 "summary": "Delete a file in a repository", 5744 "operationId": "repoDeleteFile", 5745 "parameters": [ 5746 { 5747 "type": "string", 5748 "description": "owner of the repo", 5749 "name": "owner", 5750 "in": "path", 5751 "required": true 5752 }, 5753 { 5754 "type": "string", 5755 "description": "name of the repo", 5756 "name": "repo", 5757 "in": "path", 5758 "required": true 5759 }, 5760 { 5761 "type": "string", 5762 "description": "path of the file to delete", 5763 "name": "filepath", 5764 "in": "path", 5765 "required": true 5766 }, 5767 { 5768 "name": "body", 5769 "in": "body", 5770 "required": true, 5771 "schema": { 5772 "$ref": "#/definitions/DeleteFileOptions" 5773 } 5774 } 5775 ], 5776 "responses": { 5777 "200": { 5778 "$ref": "#/responses/FileDeleteResponse" 5779 }, 5780 "400": { 5781 "$ref": "#/responses/error" 5782 }, 5783 "403": { 5784 "$ref": "#/responses/error" 5785 }, 5786 "404": { 5787 "$ref": "#/responses/error" 5788 }, 5789 "423": { 5790 "$ref": "#/responses/repoArchivedError" 5791 } 5792 } 5793 } 5794 }, 5795 "/repos/{owner}/{repo}/diffpatch": { 5796 "post": { 5797 "consumes": [ 5798 "application/json" 5799 ], 5800 "produces": [ 5801 "application/json" 5802 ], 5803 "tags": [ 5804 "repository" 5805 ], 5806 "summary": "Apply diff patch to repository", 5807 "operationId": "repoApplyDiffPatch", 5808 "parameters": [ 5809 { 5810 "type": "string", 5811 "description": "owner of the repo", 5812 "name": "owner", 5813 "in": "path", 5814 "required": true 5815 }, 5816 { 5817 "type": "string", 5818 "description": "name of the repo", 5819 "name": "repo", 5820 "in": "path", 5821 "required": true 5822 }, 5823 { 5824 "name": "body", 5825 "in": "body", 5826 "required": true, 5827 "schema": { 5828 "$ref": "#/definitions/UpdateFileOptions" 5829 } 5830 } 5831 ], 5832 "responses": { 5833 "200": { 5834 "$ref": "#/responses/FileResponse" 5835 }, 5836 "404": { 5837 "$ref": "#/responses/notFound" 5838 }, 5839 "423": { 5840 "$ref": "#/responses/repoArchivedError" 5841 } 5842 } 5843 } 5844 }, 5845 "/repos/{owner}/{repo}/editorconfig/{filepath}": { 5846 "get": { 5847 "produces": [ 5848 "application/json" 5849 ], 5850 "tags": [ 5851 "repository" 5852 ], 5853 "summary": "Get the EditorConfig definitions of a file in a repository", 5854 "operationId": "repoGetEditorConfig", 5855 "parameters": [ 5856 { 5857 "type": "string", 5858 "description": "owner of the repo", 5859 "name": "owner", 5860 "in": "path", 5861 "required": true 5862 }, 5863 { 5864 "type": "string", 5865 "description": "name of the repo", 5866 "name": "repo", 5867 "in": "path", 5868 "required": true 5869 }, 5870 { 5871 "type": "string", 5872 "description": "filepath of file to get", 5873 "name": "filepath", 5874 "in": "path", 5875 "required": true 5876 }, 5877 { 5878 "type": "string", 5879 "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)", 5880 "name": "ref", 5881 "in": "query" 5882 } 5883 ], 5884 "responses": { 5885 "200": { 5886 "description": "success" 5887 }, 5888 "404": { 5889 "$ref": "#/responses/notFound" 5890 } 5891 } 5892 } 5893 }, 5894 "/repos/{owner}/{repo}/forks": { 5895 "get": { 5896 "produces": [ 5897 "application/json" 5898 ], 5899 "tags": [ 5900 "repository" 5901 ], 5902 "summary": "List a repository's forks", 5903 "operationId": "listForks", 5904 "parameters": [ 5905 { 5906 "type": "string", 5907 "description": "owner of the repo", 5908 "name": "owner", 5909 "in": "path", 5910 "required": true 5911 }, 5912 { 5913 "type": "string", 5914 "description": "name of the repo", 5915 "name": "repo", 5916 "in": "path", 5917 "required": true 5918 }, 5919 { 5920 "type": "integer", 5921 "description": "page number of results to return (1-based)", 5922 "name": "page", 5923 "in": "query" 5924 }, 5925 { 5926 "type": "integer", 5927 "description": "page size of results", 5928 "name": "limit", 5929 "in": "query" 5930 } 5931 ], 5932 "responses": { 5933 "200": { 5934 "$ref": "#/responses/RepositoryList" 5935 }, 5936 "404": { 5937 "$ref": "#/responses/notFound" 5938 } 5939 } 5940 }, 5941 "post": { 5942 "produces": [ 5943 "application/json" 5944 ], 5945 "tags": [ 5946 "repository" 5947 ], 5948 "summary": "Fork a repository", 5949 "operationId": "createFork", 5950 "parameters": [ 5951 { 5952 "type": "string", 5953 "description": "owner of the repo to fork", 5954 "name": "owner", 5955 "in": "path", 5956 "required": true 5957 }, 5958 { 5959 "type": "string", 5960 "description": "name of the repo to fork", 5961 "name": "repo", 5962 "in": "path", 5963 "required": true 5964 }, 5965 { 5966 "name": "body", 5967 "in": "body", 5968 "schema": { 5969 "$ref": "#/definitions/CreateForkOption" 5970 } 5971 } 5972 ], 5973 "responses": { 5974 "202": { 5975 "$ref": "#/responses/Repository" 5976 }, 5977 "403": { 5978 "$ref": "#/responses/forbidden" 5979 }, 5980 "404": { 5981 "$ref": "#/responses/notFound" 5982 }, 5983 "409": { 5984 "description": "The repository with the same name already exists." 5985 }, 5986 "422": { 5987 "$ref": "#/responses/validationError" 5988 } 5989 } 5990 } 5991 }, 5992 "/repos/{owner}/{repo}/git/blobs/{sha}": { 5993 "get": { 5994 "produces": [ 5995 "application/json" 5996 ], 5997 "tags": [ 5998 "repository" 5999 ], 6000 "summary": "Gets the blob of a repository.", 6001 "operationId": "GetBlob", 6002 "parameters": [ 6003 { 6004 "type": "string", 6005 "description": "owner of the repo", 6006 "name": "owner", 6007 "in": "path", 6008 "required": true 6009 }, 6010 { 6011 "type": "string", 6012 "description": "name of the repo", 6013 "name": "repo", 6014 "in": "path", 6015 "required": true 6016 }, 6017 { 6018 "type": "string", 6019 "description": "sha of the commit", 6020 "name": "sha", 6021 "in": "path", 6022 "required": true 6023 } 6024 ], 6025 "responses": { 6026 "200": { 6027 "$ref": "#/responses/GitBlobResponse" 6028 }, 6029 "400": { 6030 "$ref": "#/responses/error" 6031 }, 6032 "404": { 6033 "$ref": "#/responses/notFound" 6034 } 6035 } 6036 } 6037 }, 6038 "/repos/{owner}/{repo}/git/commits/{sha}": { 6039 "get": { 6040 "produces": [ 6041 "application/json" 6042 ], 6043 "tags": [ 6044 "repository" 6045 ], 6046 "summary": "Get a single commit from a repository", 6047 "operationId": "repoGetSingleCommit", 6048 "parameters": [ 6049 { 6050 "type": "string", 6051 "description": "owner of the repo", 6052 "name": "owner", 6053 "in": "path", 6054 "required": true 6055 }, 6056 { 6057 "type": "string", 6058 "description": "name of the repo", 6059 "name": "repo", 6060 "in": "path", 6061 "required": true 6062 }, 6063 { 6064 "type": "string", 6065 "description": "a git ref or commit sha", 6066 "name": "sha", 6067 "in": "path", 6068 "required": true 6069 }, 6070 { 6071 "type": "boolean", 6072 "description": "include diff stats for every commit (disable for speedup, default 'true')", 6073 "name": "stat", 6074 "in": "query" 6075 }, 6076 { 6077 "type": "boolean", 6078 "description": "include verification for every commit (disable for speedup, default 'true')", 6079 "name": "verification", 6080 "in": "query" 6081 }, 6082 { 6083 "type": "boolean", 6084 "description": "include a list of affected files for every commit (disable for speedup, default 'true')", 6085 "name": "files", 6086 "in": "query" 6087 } 6088 ], 6089 "responses": { 6090 "200": { 6091 "$ref": "#/responses/Commit" 6092 }, 6093 "404": { 6094 "$ref": "#/responses/notFound" 6095 }, 6096 "422": { 6097 "$ref": "#/responses/validationError" 6098 } 6099 } 6100 } 6101 }, 6102 "/repos/{owner}/{repo}/git/commits/{sha}.{diffType}": { 6103 "get": { 6104 "produces": [ 6105 "text/plain" 6106 ], 6107 "tags": [ 6108 "repository" 6109 ], 6110 "summary": "Get a commit's diff or patch", 6111 "operationId": "repoDownloadCommitDiffOrPatch", 6112 "parameters": [ 6113 { 6114 "type": "string", 6115 "description": "owner of the repo", 6116 "name": "owner", 6117 "in": "path", 6118 "required": true 6119 }, 6120 { 6121 "type": "string", 6122 "description": "name of the repo", 6123 "name": "repo", 6124 "in": "path", 6125 "required": true 6126 }, 6127 { 6128 "type": "string", 6129 "description": "SHA of the commit to get", 6130 "name": "sha", 6131 "in": "path", 6132 "required": true 6133 }, 6134 { 6135 "enum": [ 6136 "diff", 6137 "patch" 6138 ], 6139 "type": "string", 6140 "description": "whether the output is diff or patch", 6141 "name": "diffType", 6142 "in": "path", 6143 "required": true 6144 } 6145 ], 6146 "responses": { 6147 "200": { 6148 "$ref": "#/responses/string" 6149 }, 6150 "404": { 6151 "$ref": "#/responses/notFound" 6152 } 6153 } 6154 } 6155 }, 6156 "/repos/{owner}/{repo}/git/notes/{sha}": { 6157 "get": { 6158 "produces": [ 6159 "application/json" 6160 ], 6161 "tags": [ 6162 "repository" 6163 ], 6164 "summary": "Get a note corresponding to a single commit from a repository", 6165 "operationId": "repoGetNote", 6166 "parameters": [ 6167 { 6168 "type": "string", 6169 "description": "owner of the repo", 6170 "name": "owner", 6171 "in": "path", 6172 "required": true 6173 }, 6174 { 6175 "type": "string", 6176 "description": "name of the repo", 6177 "name": "repo", 6178 "in": "path", 6179 "required": true 6180 }, 6181 { 6182 "type": "string", 6183 "description": "a git ref or commit sha", 6184 "name": "sha", 6185 "in": "path", 6186 "required": true 6187 }, 6188 { 6189 "type": "boolean", 6190 "description": "include verification for every commit (disable for speedup, default 'true')", 6191 "name": "verification", 6192 "in": "query" 6193 }, 6194 { 6195 "type": "boolean", 6196 "description": "include a list of affected files for every commit (disable for speedup, default 'true')", 6197 "name": "files", 6198 "in": "query" 6199 } 6200 ], 6201 "responses": { 6202 "200": { 6203 "$ref": "#/responses/Note" 6204 }, 6205 "404": { 6206 "$ref": "#/responses/notFound" 6207 }, 6208 "422": { 6209 "$ref": "#/responses/validationError" 6210 } 6211 } 6212 } 6213 }, 6214 "/repos/{owner}/{repo}/git/refs": { 6215 "get": { 6216 "produces": [ 6217 "application/json" 6218 ], 6219 "tags": [ 6220 "repository" 6221 ], 6222 "summary": "Get specified ref or filtered repository's refs", 6223 "operationId": "repoListAllGitRefs", 6224 "parameters": [ 6225 { 6226 "type": "string", 6227 "description": "owner of the repo", 6228 "name": "owner", 6229 "in": "path", 6230 "required": true 6231 }, 6232 { 6233 "type": "string", 6234 "description": "name of the repo", 6235 "name": "repo", 6236 "in": "path", 6237 "required": true 6238 } 6239 ], 6240 "responses": { 6241 "200": { 6242 "$ref": "#/responses/ReferenceList" 6243 }, 6244 "404": { 6245 "$ref": "#/responses/notFound" 6246 } 6247 } 6248 } 6249 }, 6250 "/repos/{owner}/{repo}/git/refs/{ref}": { 6251 "get": { 6252 "produces": [ 6253 "application/json" 6254 ], 6255 "tags": [ 6256 "repository" 6257 ], 6258 "summary": "Get specified ref or filtered repository's refs", 6259 "operationId": "repoListGitRefs", 6260 "parameters": [ 6261 { 6262 "type": "string", 6263 "description": "owner of the repo", 6264 "name": "owner", 6265 "in": "path", 6266 "required": true 6267 }, 6268 { 6269 "type": "string", 6270 "description": "name of the repo", 6271 "name": "repo", 6272 "in": "path", 6273 "required": true 6274 }, 6275 { 6276 "type": "string", 6277 "description": "part or full name of the ref", 6278 "name": "ref", 6279 "in": "path", 6280 "required": true 6281 } 6282 ], 6283 "responses": { 6284 "200": { 6285 "$ref": "#/responses/ReferenceList" 6286 }, 6287 "404": { 6288 "$ref": "#/responses/notFound" 6289 } 6290 } 6291 } 6292 }, 6293 "/repos/{owner}/{repo}/git/tags/{sha}": { 6294 "get": { 6295 "produces": [ 6296 "application/json" 6297 ], 6298 "tags": [ 6299 "repository" 6300 ], 6301 "summary": "Gets the tag object of an annotated tag (not lightweight tags)", 6302 "operationId": "GetAnnotatedTag", 6303 "parameters": [ 6304 { 6305 "type": "string", 6306 "description": "owner of the repo", 6307 "name": "owner", 6308 "in": "path", 6309 "required": true 6310 }, 6311 { 6312 "type": "string", 6313 "description": "name of the repo", 6314 "name": "repo", 6315 "in": "path", 6316 "required": true 6317 }, 6318 { 6319 "type": "string", 6320 "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.", 6321 "name": "sha", 6322 "in": "path", 6323 "required": true 6324 } 6325 ], 6326 "responses": { 6327 "200": { 6328 "$ref": "#/responses/AnnotatedTag" 6329 }, 6330 "400": { 6331 "$ref": "#/responses/error" 6332 }, 6333 "404": { 6334 "$ref": "#/responses/notFound" 6335 } 6336 } 6337 } 6338 }, 6339 "/repos/{owner}/{repo}/git/trees/{sha}": { 6340 "get": { 6341 "produces": [ 6342 "application/json" 6343 ], 6344 "tags": [ 6345 "repository" 6346 ], 6347 "summary": "Gets the tree of a repository.", 6348 "operationId": "GetTree", 6349 "parameters": [ 6350 { 6351 "type": "string", 6352 "description": "owner of the repo", 6353 "name": "owner", 6354 "in": "path", 6355 "required": true 6356 }, 6357 { 6358 "type": "string", 6359 "description": "name of the repo", 6360 "name": "repo", 6361 "in": "path", 6362 "required": true 6363 }, 6364 { 6365 "type": "string", 6366 "description": "sha of the commit", 6367 "name": "sha", 6368 "in": "path", 6369 "required": true 6370 }, 6371 { 6372 "type": "boolean", 6373 "description": "show all directories and files", 6374 "name": "recursive", 6375 "in": "query" 6376 }, 6377 { 6378 "type": "integer", 6379 "description": "page number; the 'truncated' field in the response will be true if there are still more items after this page, false if the last page", 6380 "name": "page", 6381 "in": "query" 6382 }, 6383 { 6384 "type": "integer", 6385 "description": "number of items per page", 6386 "name": "per_page", 6387 "in": "query" 6388 } 6389 ], 6390 "responses": { 6391 "200": { 6392 "$ref": "#/responses/GitTreeResponse" 6393 }, 6394 "400": { 6395 "$ref": "#/responses/error" 6396 }, 6397 "404": { 6398 "$ref": "#/responses/notFound" 6399 } 6400 } 6401 } 6402 }, 6403 "/repos/{owner}/{repo}/hooks": { 6404 "get": { 6405 "produces": [ 6406 "application/json" 6407 ], 6408 "tags": [ 6409 "repository" 6410 ], 6411 "summary": "List the hooks in a repository", 6412 "operationId": "repoListHooks", 6413 "parameters": [ 6414 { 6415 "type": "string", 6416 "description": "owner of the repo", 6417 "name": "owner", 6418 "in": "path", 6419 "required": true 6420 }, 6421 { 6422 "type": "string", 6423 "description": "name of the repo", 6424 "name": "repo", 6425 "in": "path", 6426 "required": true 6427 }, 6428 { 6429 "type": "integer", 6430 "description": "page number of results to return (1-based)", 6431 "name": "page", 6432 "in": "query" 6433 }, 6434 { 6435 "type": "integer", 6436 "description": "page size of results", 6437 "name": "limit", 6438 "in": "query" 6439 } 6440 ], 6441 "responses": { 6442 "200": { 6443 "$ref": "#/responses/HookList" 6444 }, 6445 "404": { 6446 "$ref": "#/responses/notFound" 6447 } 6448 } 6449 }, 6450 "post": { 6451 "consumes": [ 6452 "application/json" 6453 ], 6454 "produces": [ 6455 "application/json" 6456 ], 6457 "tags": [ 6458 "repository" 6459 ], 6460 "summary": "Create a hook", 6461 "operationId": "repoCreateHook", 6462 "parameters": [ 6463 { 6464 "type": "string", 6465 "description": "owner of the repo", 6466 "name": "owner", 6467 "in": "path", 6468 "required": true 6469 }, 6470 { 6471 "type": "string", 6472 "description": "name of the repo", 6473 "name": "repo", 6474 "in": "path", 6475 "required": true 6476 }, 6477 { 6478 "name": "body", 6479 "in": "body", 6480 "schema": { 6481 "$ref": "#/definitions/CreateHookOption" 6482 } 6483 } 6484 ], 6485 "responses": { 6486 "201": { 6487 "$ref": "#/responses/Hook" 6488 }, 6489 "404": { 6490 "$ref": "#/responses/notFound" 6491 } 6492 } 6493 } 6494 }, 6495 "/repos/{owner}/{repo}/hooks/git": { 6496 "get": { 6497 "produces": [ 6498 "application/json" 6499 ], 6500 "tags": [ 6501 "repository" 6502 ], 6503 "summary": "List the Git hooks in a repository", 6504 "operationId": "repoListGitHooks", 6505 "parameters": [ 6506 { 6507 "type": "string", 6508 "description": "owner of the repo", 6509 "name": "owner", 6510 "in": "path", 6511 "required": true 6512 }, 6513 { 6514 "type": "string", 6515 "description": "name of the repo", 6516 "name": "repo", 6517 "in": "path", 6518 "required": true 6519 } 6520 ], 6521 "responses": { 6522 "200": { 6523 "$ref": "#/responses/GitHookList" 6524 }, 6525 "404": { 6526 "$ref": "#/responses/notFound" 6527 } 6528 } 6529 } 6530 }, 6531 "/repos/{owner}/{repo}/hooks/git/{id}": { 6532 "get": { 6533 "produces": [ 6534 "application/json" 6535 ], 6536 "tags": [ 6537 "repository" 6538 ], 6539 "summary": "Get a Git hook", 6540 "operationId": "repoGetGitHook", 6541 "parameters": [ 6542 { 6543 "type": "string", 6544 "description": "owner of the repo", 6545 "name": "owner", 6546 "in": "path", 6547 "required": true 6548 }, 6549 { 6550 "type": "string", 6551 "description": "name of the repo", 6552 "name": "repo", 6553 "in": "path", 6554 "required": true 6555 }, 6556 { 6557 "type": "string", 6558 "description": "id of the hook to get", 6559 "name": "id", 6560 "in": "path", 6561 "required": true 6562 } 6563 ], 6564 "responses": { 6565 "200": { 6566 "$ref": "#/responses/GitHook" 6567 }, 6568 "404": { 6569 "$ref": "#/responses/notFound" 6570 } 6571 } 6572 }, 6573 "delete": { 6574 "produces": [ 6575 "application/json" 6576 ], 6577 "tags": [ 6578 "repository" 6579 ], 6580 "summary": "Delete a Git hook in a repository", 6581 "operationId": "repoDeleteGitHook", 6582 "parameters": [ 6583 { 6584 "type": "string", 6585 "description": "owner of the repo", 6586 "name": "owner", 6587 "in": "path", 6588 "required": true 6589 }, 6590 { 6591 "type": "string", 6592 "description": "name of the repo", 6593 "name": "repo", 6594 "in": "path", 6595 "required": true 6596 }, 6597 { 6598 "type": "string", 6599 "description": "id of the hook to get", 6600 "name": "id", 6601 "in": "path", 6602 "required": true 6603 } 6604 ], 6605 "responses": { 6606 "204": { 6607 "$ref": "#/responses/empty" 6608 }, 6609 "404": { 6610 "$ref": "#/responses/notFound" 6611 } 6612 } 6613 }, 6614 "patch": { 6615 "produces": [ 6616 "application/json" 6617 ], 6618 "tags": [ 6619 "repository" 6620 ], 6621 "summary": "Edit a Git hook in a repository", 6622 "operationId": "repoEditGitHook", 6623 "parameters": [ 6624 { 6625 "type": "string", 6626 "description": "owner of the repo", 6627 "name": "owner", 6628 "in": "path", 6629 "required": true 6630 }, 6631 { 6632 "type": "string", 6633 "description": "name of the repo", 6634 "name": "repo", 6635 "in": "path", 6636 "required": true 6637 }, 6638 { 6639 "type": "string", 6640 "description": "id of the hook to get", 6641 "name": "id", 6642 "in": "path", 6643 "required": true 6644 }, 6645 { 6646 "name": "body", 6647 "in": "body", 6648 "schema": { 6649 "$ref": "#/definitions/EditGitHookOption" 6650 } 6651 } 6652 ], 6653 "responses": { 6654 "200": { 6655 "$ref": "#/responses/GitHook" 6656 }, 6657 "404": { 6658 "$ref": "#/responses/notFound" 6659 } 6660 } 6661 } 6662 }, 6663 "/repos/{owner}/{repo}/hooks/{id}": { 6664 "get": { 6665 "produces": [ 6666 "application/json" 6667 ], 6668 "tags": [ 6669 "repository" 6670 ], 6671 "summary": "Get a hook", 6672 "operationId": "repoGetHook", 6673 "parameters": [ 6674 { 6675 "type": "string", 6676 "description": "owner of the repo", 6677 "name": "owner", 6678 "in": "path", 6679 "required": true 6680 }, 6681 { 6682 "type": "string", 6683 "description": "name of the repo", 6684 "name": "repo", 6685 "in": "path", 6686 "required": true 6687 }, 6688 { 6689 "type": "integer", 6690 "format": "int64", 6691 "description": "id of the hook to get", 6692 "name": "id", 6693 "in": "path", 6694 "required": true 6695 } 6696 ], 6697 "responses": { 6698 "200": { 6699 "$ref": "#/responses/Hook" 6700 }, 6701 "404": { 6702 "$ref": "#/responses/notFound" 6703 } 6704 } 6705 }, 6706 "delete": { 6707 "produces": [ 6708 "application/json" 6709 ], 6710 "tags": [ 6711 "repository" 6712 ], 6713 "summary": "Delete a hook in a repository", 6714 "operationId": "repoDeleteHook", 6715 "parameters": [ 6716 { 6717 "type": "string", 6718 "description": "owner of the repo", 6719 "name": "owner", 6720 "in": "path", 6721 "required": true 6722 }, 6723 { 6724 "type": "string", 6725 "description": "name of the repo", 6726 "name": "repo", 6727 "in": "path", 6728 "required": true 6729 }, 6730 { 6731 "type": "integer", 6732 "format": "int64", 6733 "description": "id of the hook to delete", 6734 "name": "id", 6735 "in": "path", 6736 "required": true 6737 } 6738 ], 6739 "responses": { 6740 "204": { 6741 "$ref": "#/responses/empty" 6742 }, 6743 "404": { 6744 "$ref": "#/responses/notFound" 6745 } 6746 } 6747 }, 6748 "patch": { 6749 "produces": [ 6750 "application/json" 6751 ], 6752 "tags": [ 6753 "repository" 6754 ], 6755 "summary": "Edit a hook in a repository", 6756 "operationId": "repoEditHook", 6757 "parameters": [ 6758 { 6759 "type": "string", 6760 "description": "owner of the repo", 6761 "name": "owner", 6762 "in": "path", 6763 "required": true 6764 }, 6765 { 6766 "type": "string", 6767 "description": "name of the repo", 6768 "name": "repo", 6769 "in": "path", 6770 "required": true 6771 }, 6772 { 6773 "type": "integer", 6774 "format": "int64", 6775 "description": "index of the hook", 6776 "name": "id", 6777 "in": "path", 6778 "required": true 6779 }, 6780 { 6781 "name": "body", 6782 "in": "body", 6783 "schema": { 6784 "$ref": "#/definitions/EditHookOption" 6785 } 6786 } 6787 ], 6788 "responses": { 6789 "200": { 6790 "$ref": "#/responses/Hook" 6791 }, 6792 "404": { 6793 "$ref": "#/responses/notFound" 6794 } 6795 } 6796 } 6797 }, 6798 "/repos/{owner}/{repo}/hooks/{id}/tests": { 6799 "post": { 6800 "produces": [ 6801 "application/json" 6802 ], 6803 "tags": [ 6804 "repository" 6805 ], 6806 "summary": "Test a push webhook", 6807 "operationId": "repoTestHook", 6808 "parameters": [ 6809 { 6810 "type": "string", 6811 "description": "owner of the repo", 6812 "name": "owner", 6813 "in": "path", 6814 "required": true 6815 }, 6816 { 6817 "type": "string", 6818 "description": "name of the repo", 6819 "name": "repo", 6820 "in": "path", 6821 "required": true 6822 }, 6823 { 6824 "type": "integer", 6825 "format": "int64", 6826 "description": "id of the hook to test", 6827 "name": "id", 6828 "in": "path", 6829 "required": true 6830 }, 6831 { 6832 "type": "string", 6833 "description": "The name of the commit/branch/tag, indicates which commit will be loaded to the webhook payload.", 6834 "name": "ref", 6835 "in": "query" 6836 } 6837 ], 6838 "responses": { 6839 "204": { 6840 "$ref": "#/responses/empty" 6841 }, 6842 "404": { 6843 "$ref": "#/responses/notFound" 6844 } 6845 } 6846 } 6847 }, 6848 "/repos/{owner}/{repo}/issue_config": { 6849 "get": { 6850 "produces": [ 6851 "application/json" 6852 ], 6853 "tags": [ 6854 "repository" 6855 ], 6856 "summary": "Returns the issue config for a repo", 6857 "operationId": "repoGetIssueConfig", 6858 "parameters": [ 6859 { 6860 "type": "string", 6861 "description": "owner of the repo", 6862 "name": "owner", 6863 "in": "path", 6864 "required": true 6865 }, 6866 { 6867 "type": "string", 6868 "description": "name of the repo", 6869 "name": "repo", 6870 "in": "path", 6871 "required": true 6872 } 6873 ], 6874 "responses": { 6875 "200": { 6876 "$ref": "#/responses/RepoIssueConfig" 6877 }, 6878 "404": { 6879 "$ref": "#/responses/notFound" 6880 } 6881 } 6882 } 6883 }, 6884 "/repos/{owner}/{repo}/issue_config/validate": { 6885 "get": { 6886 "produces": [ 6887 "application/json" 6888 ], 6889 "tags": [ 6890 "repository" 6891 ], 6892 "summary": "Returns the validation information for a issue config", 6893 "operationId": "repoValidateIssueConfig", 6894 "parameters": [ 6895 { 6896 "type": "string", 6897 "description": "owner of the repo", 6898 "name": "owner", 6899 "in": "path", 6900 "required": true 6901 }, 6902 { 6903 "type": "string", 6904 "description": "name of the repo", 6905 "name": "repo", 6906 "in": "path", 6907 "required": true 6908 } 6909 ], 6910 "responses": { 6911 "200": { 6912 "$ref": "#/responses/RepoIssueConfigValidation" 6913 }, 6914 "404": { 6915 "$ref": "#/responses/notFound" 6916 } 6917 } 6918 } 6919 }, 6920 "/repos/{owner}/{repo}/issue_templates": { 6921 "get": { 6922 "produces": [ 6923 "application/json" 6924 ], 6925 "tags": [ 6926 "repository" 6927 ], 6928 "summary": "Get available issue templates for a repository", 6929 "operationId": "repoGetIssueTemplates", 6930 "parameters": [ 6931 { 6932 "type": "string", 6933 "description": "owner of the repo", 6934 "name": "owner", 6935 "in": "path", 6936 "required": true 6937 }, 6938 { 6939 "type": "string", 6940 "description": "name of the repo", 6941 "name": "repo", 6942 "in": "path", 6943 "required": true 6944 } 6945 ], 6946 "responses": { 6947 "200": { 6948 "$ref": "#/responses/IssueTemplates" 6949 }, 6950 "404": { 6951 "$ref": "#/responses/notFound" 6952 } 6953 } 6954 } 6955 }, 6956 "/repos/{owner}/{repo}/issues": { 6957 "get": { 6958 "produces": [ 6959 "application/json" 6960 ], 6961 "tags": [ 6962 "issue" 6963 ], 6964 "summary": "List a repository's issues", 6965 "operationId": "issueListIssues", 6966 "parameters": [ 6967 { 6968 "type": "string", 6969 "description": "owner of the repo", 6970 "name": "owner", 6971 "in": "path", 6972 "required": true 6973 }, 6974 { 6975 "type": "string", 6976 "description": "name of the repo", 6977 "name": "repo", 6978 "in": "path", 6979 "required": true 6980 }, 6981 { 6982 "enum": [ 6983 "closed", 6984 "open", 6985 "all" 6986 ], 6987 "type": "string", 6988 "description": "whether issue is open or closed", 6989 "name": "state", 6990 "in": "query" 6991 }, 6992 { 6993 "type": "string", 6994 "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded", 6995 "name": "labels", 6996 "in": "query" 6997 }, 6998 { 6999 "type": "string", 7000 "description": "search string", 7001 "name": "q", 7002 "in": "query" 7003 }, 7004 { 7005 "enum": [ 7006 "issues", 7007 "pulls" 7008 ], 7009 "type": "string", 7010 "description": "filter by type (issues / pulls) if set", 7011 "name": "type", 7012 "in": "query" 7013 }, 7014 { 7015 "type": "string", 7016 "description": "comma separated list of milestone names or ids. It uses names and fall back to ids. Fetch only issues that have any of this milestones. Non existent milestones are discarded", 7017 "name": "milestones", 7018 "in": "query" 7019 }, 7020 { 7021 "type": "string", 7022 "format": "date-time", 7023 "description": "Only show items updated after the given time. This is a timestamp in RFC 3339 format", 7024 "name": "since", 7025 "in": "query" 7026 }, 7027 { 7028 "type": "string", 7029 "format": "date-time", 7030 "description": "Only show items updated before the given time. This is a timestamp in RFC 3339 format", 7031 "name": "before", 7032 "in": "query" 7033 }, 7034 { 7035 "type": "string", 7036 "description": "Only show items which were created by the given user", 7037 "name": "created_by", 7038 "in": "query" 7039 }, 7040 { 7041 "type": "string", 7042 "description": "Only show items for which the given user is assigned", 7043 "name": "assigned_by", 7044 "in": "query" 7045 }, 7046 { 7047 "type": "string", 7048 "description": "Only show items in which the given user was mentioned", 7049 "name": "mentioned_by", 7050 "in": "query" 7051 }, 7052 { 7053 "type": "integer", 7054 "description": "page number of results to return (1-based)", 7055 "name": "page", 7056 "in": "query" 7057 }, 7058 { 7059 "type": "integer", 7060 "description": "page size of results", 7061 "name": "limit", 7062 "in": "query" 7063 } 7064 ], 7065 "responses": { 7066 "200": { 7067 "$ref": "#/responses/IssueList" 7068 }, 7069 "404": { 7070 "$ref": "#/responses/notFound" 7071 } 7072 } 7073 }, 7074 "post": { 7075 "consumes": [ 7076 "application/json" 7077 ], 7078 "produces": [ 7079 "application/json" 7080 ], 7081 "tags": [ 7082 "issue" 7083 ], 7084 "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.", 7085 "operationId": "issueCreateIssue", 7086 "parameters": [ 7087 { 7088 "type": "string", 7089 "description": "owner of the repo", 7090 "name": "owner", 7091 "in": "path", 7092 "required": true 7093 }, 7094 { 7095 "type": "string", 7096 "description": "name of the repo", 7097 "name": "repo", 7098 "in": "path", 7099 "required": true 7100 }, 7101 { 7102 "name": "body", 7103 "in": "body", 7104 "schema": { 7105 "$ref": "#/definitions/CreateIssueOption" 7106 } 7107 } 7108 ], 7109 "responses": { 7110 "201": { 7111 "$ref": "#/responses/Issue" 7112 }, 7113 "403": { 7114 "$ref": "#/responses/forbidden" 7115 }, 7116 "404": { 7117 "$ref": "#/responses/notFound" 7118 }, 7119 "412": { 7120 "$ref": "#/responses/error" 7121 }, 7122 "422": { 7123 "$ref": "#/responses/validationError" 7124 }, 7125 "423": { 7126 "$ref": "#/responses/repoArchivedError" 7127 } 7128 } 7129 } 7130 }, 7131 "/repos/{owner}/{repo}/issues/comments": { 7132 "get": { 7133 "produces": [ 7134 "application/json" 7135 ], 7136 "tags": [ 7137 "issue" 7138 ], 7139 "summary": "List all comments in a repository", 7140 "operationId": "issueGetRepoComments", 7141 "parameters": [ 7142 { 7143 "type": "string", 7144 "description": "owner of the repo", 7145 "name": "owner", 7146 "in": "path", 7147 "required": true 7148 }, 7149 { 7150 "type": "string", 7151 "description": "name of the repo", 7152 "name": "repo", 7153 "in": "path", 7154 "required": true 7155 }, 7156 { 7157 "type": "string", 7158 "format": "date-time", 7159 "description": "if provided, only comments updated since the provided time are returned.", 7160 "name": "since", 7161 "in": "query" 7162 }, 7163 { 7164 "type": "string", 7165 "format": "date-time", 7166 "description": "if provided, only comments updated before the provided time are returned.", 7167 "name": "before", 7168 "in": "query" 7169 }, 7170 { 7171 "type": "integer", 7172 "description": "page number of results to return (1-based)", 7173 "name": "page", 7174 "in": "query" 7175 }, 7176 { 7177 "type": "integer", 7178 "description": "page size of results", 7179 "name": "limit", 7180 "in": "query" 7181 } 7182 ], 7183 "responses": { 7184 "200": { 7185 "$ref": "#/responses/CommentList" 7186 }, 7187 "404": { 7188 "$ref": "#/responses/notFound" 7189 } 7190 } 7191 } 7192 }, 7193 "/repos/{owner}/{repo}/issues/comments/{id}": { 7194 "get": { 7195 "consumes": [ 7196 "application/json" 7197 ], 7198 "produces": [ 7199 "application/json" 7200 ], 7201 "tags": [ 7202 "issue" 7203 ], 7204 "summary": "Get a comment", 7205 "operationId": "issueGetComment", 7206 "parameters": [ 7207 { 7208 "type": "string", 7209 "description": "owner of the repo", 7210 "name": "owner", 7211 "in": "path", 7212 "required": true 7213 }, 7214 { 7215 "type": "string", 7216 "description": "name of the repo", 7217 "name": "repo", 7218 "in": "path", 7219 "required": true 7220 }, 7221 { 7222 "type": "integer", 7223 "format": "int64", 7224 "description": "id of the comment", 7225 "name": "id", 7226 "in": "path", 7227 "required": true 7228 } 7229 ], 7230 "responses": { 7231 "200": { 7232 "$ref": "#/responses/Comment" 7233 }, 7234 "204": { 7235 "$ref": "#/responses/empty" 7236 }, 7237 "403": { 7238 "$ref": "#/responses/forbidden" 7239 }, 7240 "404": { 7241 "$ref": "#/responses/notFound" 7242 } 7243 } 7244 }, 7245 "delete": { 7246 "tags": [ 7247 "issue" 7248 ], 7249 "summary": "Delete a comment", 7250 "operationId": "issueDeleteComment", 7251 "parameters": [ 7252 { 7253 "type": "string", 7254 "description": "owner of the repo", 7255 "name": "owner", 7256 "in": "path", 7257 "required": true 7258 }, 7259 { 7260 "type": "string", 7261 "description": "name of the repo", 7262 "name": "repo", 7263 "in": "path", 7264 "required": true 7265 }, 7266 { 7267 "type": "integer", 7268 "format": "int64", 7269 "description": "id of comment to delete", 7270 "name": "id", 7271 "in": "path", 7272 "required": true 7273 } 7274 ], 7275 "responses": { 7276 "204": { 7277 "$ref": "#/responses/empty" 7278 }, 7279 "403": { 7280 "$ref": "#/responses/forbidden" 7281 }, 7282 "404": { 7283 "$ref": "#/responses/notFound" 7284 } 7285 } 7286 }, 7287 "patch": { 7288 "consumes": [ 7289 "application/json" 7290 ], 7291 "produces": [ 7292 "application/json" 7293 ], 7294 "tags": [ 7295 "issue" 7296 ], 7297 "summary": "Edit a comment", 7298 "operationId": "issueEditComment", 7299 "parameters": [ 7300 { 7301 "type": "string", 7302 "description": "owner of the repo", 7303 "name": "owner", 7304 "in": "path", 7305 "required": true 7306 }, 7307 { 7308 "type": "string", 7309 "description": "name of the repo", 7310 "name": "repo", 7311 "in": "path", 7312 "required": true 7313 }, 7314 { 7315 "type": "integer", 7316 "format": "int64", 7317 "description": "id of the comment to edit", 7318 "name": "id", 7319 "in": "path", 7320 "required": true 7321 }, 7322 { 7323 "name": "body", 7324 "in": "body", 7325 "schema": { 7326 "$ref": "#/definitions/EditIssueCommentOption" 7327 } 7328 } 7329 ], 7330 "responses": { 7331 "200": { 7332 "$ref": "#/responses/Comment" 7333 }, 7334 "204": { 7335 "$ref": "#/responses/empty" 7336 }, 7337 "403": { 7338 "$ref": "#/responses/forbidden" 7339 }, 7340 "404": { 7341 "$ref": "#/responses/notFound" 7342 }, 7343 "423": { 7344 "$ref": "#/responses/repoArchivedError" 7345 } 7346 } 7347 } 7348 }, 7349 "/repos/{owner}/{repo}/issues/comments/{id}/assets": { 7350 "get": { 7351 "produces": [ 7352 "application/json" 7353 ], 7354 "tags": [ 7355 "issue" 7356 ], 7357 "summary": "List comment's attachments", 7358 "operationId": "issueListIssueCommentAttachments", 7359 "parameters": [ 7360 { 7361 "type": "string", 7362 "description": "owner of the repo", 7363 "name": "owner", 7364 "in": "path", 7365 "required": true 7366 }, 7367 { 7368 "type": "string", 7369 "description": "name of the repo", 7370 "name": "repo", 7371 "in": "path", 7372 "required": true 7373 }, 7374 { 7375 "type": "integer", 7376 "format": "int64", 7377 "description": "id of the comment", 7378 "name": "id", 7379 "in": "path", 7380 "required": true 7381 } 7382 ], 7383 "responses": { 7384 "200": { 7385 "$ref": "#/responses/AttachmentList" 7386 }, 7387 "404": { 7388 "$ref": "#/responses/error" 7389 } 7390 } 7391 }, 7392 "post": { 7393 "consumes": [ 7394 "multipart/form-data" 7395 ], 7396 "produces": [ 7397 "application/json" 7398 ], 7399 "tags": [ 7400 "issue" 7401 ], 7402 "summary": "Create a comment attachment", 7403 "operationId": "issueCreateIssueCommentAttachment", 7404 "parameters": [ 7405 { 7406 "type": "string", 7407 "description": "owner of the repo", 7408 "name": "owner", 7409 "in": "path", 7410 "required": true 7411 }, 7412 { 7413 "type": "string", 7414 "description": "name of the repo", 7415 "name": "repo", 7416 "in": "path", 7417 "required": true 7418 }, 7419 { 7420 "type": "integer", 7421 "format": "int64", 7422 "description": "id of the comment", 7423 "name": "id", 7424 "in": "path", 7425 "required": true 7426 }, 7427 { 7428 "type": "string", 7429 "description": "name of the attachment", 7430 "name": "name", 7431 "in": "query" 7432 }, 7433 { 7434 "type": "file", 7435 "description": "attachment to upload", 7436 "name": "attachment", 7437 "in": "formData", 7438 "required": true 7439 } 7440 ], 7441 "responses": { 7442 "201": { 7443 "$ref": "#/responses/Attachment" 7444 }, 7445 "400": { 7446 "$ref": "#/responses/error" 7447 }, 7448 "403": { 7449 "$ref": "#/responses/forbidden" 7450 }, 7451 "404": { 7452 "$ref": "#/responses/error" 7453 }, 7454 "422": { 7455 "$ref": "#/responses/validationError" 7456 }, 7457 "423": { 7458 "$ref": "#/responses/repoArchivedError" 7459 } 7460 } 7461 } 7462 }, 7463 "/repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id}": { 7464 "get": { 7465 "produces": [ 7466 "application/json" 7467 ], 7468 "tags": [ 7469 "issue" 7470 ], 7471 "summary": "Get a comment attachment", 7472 "operationId": "issueGetIssueCommentAttachment", 7473 "parameters": [ 7474 { 7475 "type": "string", 7476 "description": "owner of the repo", 7477 "name": "owner", 7478 "in": "path", 7479 "required": true 7480 }, 7481 { 7482 "type": "string", 7483 "description": "name of the repo", 7484 "name": "repo", 7485 "in": "path", 7486 "required": true 7487 }, 7488 { 7489 "type": "integer", 7490 "format": "int64", 7491 "description": "id of the comment", 7492 "name": "id", 7493 "in": "path", 7494 "required": true 7495 }, 7496 { 7497 "type": "integer", 7498 "format": "int64", 7499 "description": "id of the attachment to get", 7500 "name": "attachment_id", 7501 "in": "path", 7502 "required": true 7503 } 7504 ], 7505 "responses": { 7506 "200": { 7507 "$ref": "#/responses/Attachment" 7508 }, 7509 "404": { 7510 "$ref": "#/responses/error" 7511 } 7512 } 7513 }, 7514 "delete": { 7515 "produces": [ 7516 "application/json" 7517 ], 7518 "tags": [ 7519 "issue" 7520 ], 7521 "summary": "Delete a comment attachment", 7522 "operationId": "issueDeleteIssueCommentAttachment", 7523 "parameters": [ 7524 { 7525 "type": "string", 7526 "description": "owner of the repo", 7527 "name": "owner", 7528 "in": "path", 7529 "required": true 7530 }, 7531 { 7532 "type": "string", 7533 "description": "name of the repo", 7534 "name": "repo", 7535 "in": "path", 7536 "required": true 7537 }, 7538 { 7539 "type": "integer", 7540 "format": "int64", 7541 "description": "id of the comment", 7542 "name": "id", 7543 "in": "path", 7544 "required": true 7545 }, 7546 { 7547 "type": "integer", 7548 "format": "int64", 7549 "description": "id of the attachment to delete", 7550 "name": "attachment_id", 7551 "in": "path", 7552 "required": true 7553 } 7554 ], 7555 "responses": { 7556 "204": { 7557 "$ref": "#/responses/empty" 7558 }, 7559 "404": { 7560 "$ref": "#/responses/error" 7561 }, 7562 "423": { 7563 "$ref": "#/responses/repoArchivedError" 7564 } 7565 } 7566 }, 7567 "patch": { 7568 "consumes": [ 7569 "application/json" 7570 ], 7571 "produces": [ 7572 "application/json" 7573 ], 7574 "tags": [ 7575 "issue" 7576 ], 7577 "summary": "Edit a comment attachment", 7578 "operationId": "issueEditIssueCommentAttachment", 7579 "parameters": [ 7580 { 7581 "type": "string", 7582 "description": "owner of the repo", 7583 "name": "owner", 7584 "in": "path", 7585 "required": true 7586 }, 7587 { 7588 "type": "string", 7589 "description": "name of the repo", 7590 "name": "repo", 7591 "in": "path", 7592 "required": true 7593 }, 7594 { 7595 "type": "integer", 7596 "format": "int64", 7597 "description": "id of the comment", 7598 "name": "id", 7599 "in": "path", 7600 "required": true 7601 }, 7602 { 7603 "type": "integer", 7604 "format": "int64", 7605 "description": "id of the attachment to edit", 7606 "name": "attachment_id", 7607 "in": "path", 7608 "required": true 7609 }, 7610 { 7611 "name": "body", 7612 "in": "body", 7613 "schema": { 7614 "$ref": "#/definitions/EditAttachmentOptions" 7615 } 7616 } 7617 ], 7618 "responses": { 7619 "201": { 7620 "$ref": "#/responses/Attachment" 7621 }, 7622 "404": { 7623 "$ref": "#/responses/error" 7624 }, 7625 "423": { 7626 "$ref": "#/responses/repoArchivedError" 7627 } 7628 } 7629 } 7630 }, 7631 "/repos/{owner}/{repo}/issues/comments/{id}/reactions": { 7632 "get": { 7633 "consumes": [ 7634 "application/json" 7635 ], 7636 "produces": [ 7637 "application/json" 7638 ], 7639 "tags": [ 7640 "issue" 7641 ], 7642 "summary": "Get a list of reactions from a comment of an issue", 7643 "operationId": "issueGetCommentReactions", 7644 "parameters": [ 7645 { 7646 "type": "string", 7647 "description": "owner of the repo", 7648 "name": "owner", 7649 "in": "path", 7650 "required": true 7651 }, 7652 { 7653 "type": "string", 7654 "description": "name of the repo", 7655 "name": "repo", 7656 "in": "path", 7657 "required": true 7658 }, 7659 { 7660 "type": "integer", 7661 "format": "int64", 7662 "description": "id of the comment to edit", 7663 "name": "id", 7664 "in": "path", 7665 "required": true 7666 } 7667 ], 7668 "responses": { 7669 "200": { 7670 "$ref": "#/responses/ReactionList" 7671 }, 7672 "403": { 7673 "$ref": "#/responses/forbidden" 7674 }, 7675 "404": { 7676 "$ref": "#/responses/notFound" 7677 } 7678 } 7679 }, 7680 "post": { 7681 "consumes": [ 7682 "application/json" 7683 ], 7684 "produces": [ 7685 "application/json" 7686 ], 7687 "tags": [ 7688 "issue" 7689 ], 7690 "summary": "Add a reaction to a comment of an issue", 7691 "operationId": "issuePostCommentReaction", 7692 "parameters": [ 7693 { 7694 "type": "string", 7695 "description": "owner of the repo", 7696 "name": "owner", 7697 "in": "path", 7698 "required": true 7699 }, 7700 { 7701 "type": "string", 7702 "description": "name of the repo", 7703 "name": "repo", 7704 "in": "path", 7705 "required": true 7706 }, 7707 { 7708 "type": "integer", 7709 "format": "int64", 7710 "description": "id of the comment to edit", 7711 "name": "id", 7712 "in": "path", 7713 "required": true 7714 }, 7715 { 7716 "name": "content", 7717 "in": "body", 7718 "schema": { 7719 "$ref": "#/definitions/EditReactionOption" 7720 } 7721 } 7722 ], 7723 "responses": { 7724 "200": { 7725 "$ref": "#/responses/Reaction" 7726 }, 7727 "201": { 7728 "$ref": "#/responses/Reaction" 7729 }, 7730 "403": { 7731 "$ref": "#/responses/forbidden" 7732 }, 7733 "404": { 7734 "$ref": "#/responses/notFound" 7735 } 7736 } 7737 }, 7738 "delete": { 7739 "consumes": [ 7740 "application/json" 7741 ], 7742 "produces": [ 7743 "application/json" 7744 ], 7745 "tags": [ 7746 "issue" 7747 ], 7748 "summary": "Remove a reaction from a comment of an issue", 7749 "operationId": "issueDeleteCommentReaction", 7750 "parameters": [ 7751 { 7752 "type": "string", 7753 "description": "owner of the repo", 7754 "name": "owner", 7755 "in": "path", 7756 "required": true 7757 }, 7758 { 7759 "type": "string", 7760 "description": "name of the repo", 7761 "name": "repo", 7762 "in": "path", 7763 "required": true 7764 }, 7765 { 7766 "type": "integer", 7767 "format": "int64", 7768 "description": "id of the comment to edit", 7769 "name": "id", 7770 "in": "path", 7771 "required": true 7772 }, 7773 { 7774 "name": "content", 7775 "in": "body", 7776 "schema": { 7777 "$ref": "#/definitions/EditReactionOption" 7778 } 7779 } 7780 ], 7781 "responses": { 7782 "200": { 7783 "$ref": "#/responses/empty" 7784 }, 7785 "403": { 7786 "$ref": "#/responses/forbidden" 7787 }, 7788 "404": { 7789 "$ref": "#/responses/notFound" 7790 } 7791 } 7792 } 7793 }, 7794 "/repos/{owner}/{repo}/issues/pinned": { 7795 "get": { 7796 "produces": [ 7797 "application/json" 7798 ], 7799 "tags": [ 7800 "repository" 7801 ], 7802 "summary": "List a repo's pinned issues", 7803 "operationId": "repoListPinnedIssues", 7804 "parameters": [ 7805 { 7806 "type": "string", 7807 "description": "owner of the repo", 7808 "name": "owner", 7809 "in": "path", 7810 "required": true 7811 }, 7812 { 7813 "type": "string", 7814 "description": "name of the repo", 7815 "name": "repo", 7816 "in": "path", 7817 "required": true 7818 } 7819 ], 7820 "responses": { 7821 "200": { 7822 "$ref": "#/responses/IssueList" 7823 }, 7824 "404": { 7825 "$ref": "#/responses/notFound" 7826 } 7827 } 7828 } 7829 }, 7830 "/repos/{owner}/{repo}/issues/{index}": { 7831 "get": { 7832 "produces": [ 7833 "application/json" 7834 ], 7835 "tags": [ 7836 "issue" 7837 ], 7838 "summary": "Get an issue", 7839 "operationId": "issueGetIssue", 7840 "parameters": [ 7841 { 7842 "type": "string", 7843 "description": "owner of the repo", 7844 "name": "owner", 7845 "in": "path", 7846 "required": true 7847 }, 7848 { 7849 "type": "string", 7850 "description": "name of the repo", 7851 "name": "repo", 7852 "in": "path", 7853 "required": true 7854 }, 7855 { 7856 "type": "integer", 7857 "format": "int64", 7858 "description": "index of the issue to get", 7859 "name": "index", 7860 "in": "path", 7861 "required": true 7862 } 7863 ], 7864 "responses": { 7865 "200": { 7866 "$ref": "#/responses/Issue" 7867 }, 7868 "404": { 7869 "$ref": "#/responses/notFound" 7870 } 7871 } 7872 }, 7873 "delete": { 7874 "tags": [ 7875 "issue" 7876 ], 7877 "summary": "Delete an issue", 7878 "operationId": "issueDelete", 7879 "parameters": [ 7880 { 7881 "type": "string", 7882 "description": "owner of the repo", 7883 "name": "owner", 7884 "in": "path", 7885 "required": true 7886 }, 7887 { 7888 "type": "string", 7889 "description": "name of the repo", 7890 "name": "repo", 7891 "in": "path", 7892 "required": true 7893 }, 7894 { 7895 "type": "integer", 7896 "format": "int64", 7897 "description": "index of issue to delete", 7898 "name": "index", 7899 "in": "path", 7900 "required": true 7901 } 7902 ], 7903 "responses": { 7904 "204": { 7905 "$ref": "#/responses/empty" 7906 }, 7907 "403": { 7908 "$ref": "#/responses/forbidden" 7909 }, 7910 "404": { 7911 "$ref": "#/responses/notFound" 7912 } 7913 } 7914 }, 7915 "patch": { 7916 "consumes": [ 7917 "application/json" 7918 ], 7919 "produces": [ 7920 "application/json" 7921 ], 7922 "tags": [ 7923 "issue" 7924 ], 7925 "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.", 7926 "operationId": "issueEditIssue", 7927 "parameters": [ 7928 { 7929 "type": "string", 7930 "description": "owner of the repo", 7931 "name": "owner", 7932 "in": "path", 7933 "required": true 7934 }, 7935 { 7936 "type": "string", 7937 "description": "name of the repo", 7938 "name": "repo", 7939 "in": "path", 7940 "required": true 7941 }, 7942 { 7943 "type": "integer", 7944 "format": "int64", 7945 "description": "index of the issue to edit", 7946 "name": "index", 7947 "in": "path", 7948 "required": true 7949 }, 7950 { 7951 "name": "body", 7952 "in": "body", 7953 "schema": { 7954 "$ref": "#/definitions/EditIssueOption" 7955 } 7956 } 7957 ], 7958 "responses": { 7959 "201": { 7960 "$ref": "#/responses/Issue" 7961 }, 7962 "403": { 7963 "$ref": "#/responses/forbidden" 7964 }, 7965 "404": { 7966 "$ref": "#/responses/notFound" 7967 }, 7968 "412": { 7969 "$ref": "#/responses/error" 7970 } 7971 } 7972 } 7973 }, 7974 "/repos/{owner}/{repo}/issues/{index}/assets": { 7975 "get": { 7976 "produces": [ 7977 "application/json" 7978 ], 7979 "tags": [ 7980 "issue" 7981 ], 7982 "summary": "List issue's attachments", 7983 "operationId": "issueListIssueAttachments", 7984 "parameters": [ 7985 { 7986 "type": "string", 7987 "description": "owner of the repo", 7988 "name": "owner", 7989 "in": "path", 7990 "required": true 7991 }, 7992 { 7993 "type": "string", 7994 "description": "name of the repo", 7995 "name": "repo", 7996 "in": "path", 7997 "required": true 7998 }, 7999 { 8000 "type": "integer", 8001 "format": "int64", 8002 "description": "index of the issue", 8003 "name": "index", 8004 "in": "path", 8005 "required": true 8006 } 8007 ], 8008 "responses": { 8009 "200": { 8010 "$ref": "#/responses/AttachmentList" 8011 }, 8012 "404": { 8013 "$ref": "#/responses/error" 8014 } 8015 } 8016 }, 8017 "post": { 8018 "consumes": [ 8019 "multipart/form-data" 8020 ], 8021 "produces": [ 8022 "application/json" 8023 ], 8024 "tags": [ 8025 "issue" 8026 ], 8027 "summary": "Create an issue attachment", 8028 "operationId": "issueCreateIssueAttachment", 8029 "parameters": [ 8030 { 8031 "type": "string", 8032 "description": "owner of the repo", 8033 "name": "owner", 8034 "in": "path", 8035 "required": true 8036 }, 8037 { 8038 "type": "string", 8039 "description": "name of the repo", 8040 "name": "repo", 8041 "in": "path", 8042 "required": true 8043 }, 8044 { 8045 "type": "integer", 8046 "format": "int64", 8047 "description": "index of the issue", 8048 "name": "index", 8049 "in": "path", 8050 "required": true 8051 }, 8052 { 8053 "type": "string", 8054 "description": "name of the attachment", 8055 "name": "name", 8056 "in": "query" 8057 }, 8058 { 8059 "type": "file", 8060 "description": "attachment to upload", 8061 "name": "attachment", 8062 "in": "formData", 8063 "required": true 8064 } 8065 ], 8066 "responses": { 8067 "201": { 8068 "$ref": "#/responses/Attachment" 8069 }, 8070 "400": { 8071 "$ref": "#/responses/error" 8072 }, 8073 "404": { 8074 "$ref": "#/responses/error" 8075 }, 8076 "422": { 8077 "$ref": "#/responses/validationError" 8078 }, 8079 "423": { 8080 "$ref": "#/responses/repoArchivedError" 8081 } 8082 } 8083 } 8084 }, 8085 "/repos/{owner}/{repo}/issues/{index}/assets/{attachment_id}": { 8086 "get": { 8087 "produces": [ 8088 "application/json" 8089 ], 8090 "tags": [ 8091 "issue" 8092 ], 8093 "summary": "Get an issue attachment", 8094 "operationId": "issueGetIssueAttachment", 8095 "parameters": [ 8096 { 8097 "type": "string", 8098 "description": "owner of the repo", 8099 "name": "owner", 8100 "in": "path", 8101 "required": true 8102 }, 8103 { 8104 "type": "string", 8105 "description": "name of the repo", 8106 "name": "repo", 8107 "in": "path", 8108 "required": true 8109 }, 8110 { 8111 "type": "integer", 8112 "format": "int64", 8113 "description": "index of the issue", 8114 "name": "index", 8115 "in": "path", 8116 "required": true 8117 }, 8118 { 8119 "type": "integer", 8120 "format": "int64", 8121 "description": "id of the attachment to get", 8122 "name": "attachment_id", 8123 "in": "path", 8124 "required": true 8125 } 8126 ], 8127 "responses": { 8128 "200": { 8129 "$ref": "#/responses/Attachment" 8130 }, 8131 "404": { 8132 "$ref": "#/responses/error" 8133 } 8134 } 8135 }, 8136 "delete": { 8137 "produces": [ 8138 "application/json" 8139 ], 8140 "tags": [ 8141 "issue" 8142 ], 8143 "summary": "Delete an issue attachment", 8144 "operationId": "issueDeleteIssueAttachment", 8145 "parameters": [ 8146 { 8147 "type": "string", 8148 "description": "owner of the repo", 8149 "name": "owner", 8150 "in": "path", 8151 "required": true 8152 }, 8153 { 8154 "type": "string", 8155 "description": "name of the repo", 8156 "name": "repo", 8157 "in": "path", 8158 "required": true 8159 }, 8160 { 8161 "type": "integer", 8162 "format": "int64", 8163 "description": "index of the issue", 8164 "name": "index", 8165 "in": "path", 8166 "required": true 8167 }, 8168 { 8169 "type": "integer", 8170 "format": "int64", 8171 "description": "id of the attachment to delete", 8172 "name": "attachment_id", 8173 "in": "path", 8174 "required": true 8175 } 8176 ], 8177 "responses": { 8178 "204": { 8179 "$ref": "#/responses/empty" 8180 }, 8181 "404": { 8182 "$ref": "#/responses/error" 8183 }, 8184 "423": { 8185 "$ref": "#/responses/repoArchivedError" 8186 } 8187 } 8188 }, 8189 "patch": { 8190 "consumes": [ 8191 "application/json" 8192 ], 8193 "produces": [ 8194 "application/json" 8195 ], 8196 "tags": [ 8197 "issue" 8198 ], 8199 "summary": "Edit an issue attachment", 8200 "operationId": "issueEditIssueAttachment", 8201 "parameters": [ 8202 { 8203 "type": "string", 8204 "description": "owner of the repo", 8205 "name": "owner", 8206 "in": "path", 8207 "required": true 8208 }, 8209 { 8210 "type": "string", 8211 "description": "name of the repo", 8212 "name": "repo", 8213 "in": "path", 8214 "required": true 8215 }, 8216 { 8217 "type": "integer", 8218 "format": "int64", 8219 "description": "index of the issue", 8220 "name": "index", 8221 "in": "path", 8222 "required": true 8223 }, 8224 { 8225 "type": "integer", 8226 "format": "int64", 8227 "description": "id of the attachment to edit", 8228 "name": "attachment_id", 8229 "in": "path", 8230 "required": true 8231 }, 8232 { 8233 "name": "body", 8234 "in": "body", 8235 "schema": { 8236 "$ref": "#/definitions/EditAttachmentOptions" 8237 } 8238 } 8239 ], 8240 "responses": { 8241 "201": { 8242 "$ref": "#/responses/Attachment" 8243 }, 8244 "404": { 8245 "$ref": "#/responses/error" 8246 }, 8247 "423": { 8248 "$ref": "#/responses/repoArchivedError" 8249 } 8250 } 8251 } 8252 }, 8253 "/repos/{owner}/{repo}/issues/{index}/blocks": { 8254 "get": { 8255 "produces": [ 8256 "application/json" 8257 ], 8258 "tags": [ 8259 "issue" 8260 ], 8261 "summary": "List issues that are blocked by this issue", 8262 "operationId": "issueListBlocks", 8263 "parameters": [ 8264 { 8265 "type": "string", 8266 "description": "owner of the repo", 8267 "name": "owner", 8268 "in": "path", 8269 "required": true 8270 }, 8271 { 8272 "type": "string", 8273 "description": "name of the repo", 8274 "name": "repo", 8275 "in": "path", 8276 "required": true 8277 }, 8278 { 8279 "type": "string", 8280 "description": "index of the issue", 8281 "name": "index", 8282 "in": "path", 8283 "required": true 8284 }, 8285 { 8286 "type": "integer", 8287 "description": "page number of results to return (1-based)", 8288 "name": "page", 8289 "in": "query" 8290 }, 8291 { 8292 "type": "integer", 8293 "description": "page size of results", 8294 "name": "limit", 8295 "in": "query" 8296 } 8297 ], 8298 "responses": { 8299 "200": { 8300 "$ref": "#/responses/IssueList" 8301 }, 8302 "404": { 8303 "$ref": "#/responses/notFound" 8304 } 8305 } 8306 }, 8307 "post": { 8308 "produces": [ 8309 "application/json" 8310 ], 8311 "tags": [ 8312 "issue" 8313 ], 8314 "summary": "Block the issue given in the body by the issue in path", 8315 "operationId": "issueCreateIssueBlocking", 8316 "parameters": [ 8317 { 8318 "type": "string", 8319 "description": "owner of the repo", 8320 "name": "owner", 8321 "in": "path", 8322 "required": true 8323 }, 8324 { 8325 "type": "string", 8326 "description": "name of the repo", 8327 "name": "repo", 8328 "in": "path", 8329 "required": true 8330 }, 8331 { 8332 "type": "string", 8333 "description": "index of the issue", 8334 "name": "index", 8335 "in": "path", 8336 "required": true 8337 }, 8338 { 8339 "name": "body", 8340 "in": "body", 8341 "schema": { 8342 "$ref": "#/definitions/IssueMeta" 8343 } 8344 } 8345 ], 8346 "responses": { 8347 "201": { 8348 "$ref": "#/responses/Issue" 8349 }, 8350 "404": { 8351 "description": "the issue does not exist" 8352 } 8353 } 8354 }, 8355 "delete": { 8356 "produces": [ 8357 "application/json" 8358 ], 8359 "tags": [ 8360 "issue" 8361 ], 8362 "summary": "Unblock the issue given in the body by the issue in path", 8363 "operationId": "issueRemoveIssueBlocking", 8364 "parameters": [ 8365 { 8366 "type": "string", 8367 "description": "owner of the repo", 8368 "name": "owner", 8369 "in": "path", 8370 "required": true 8371 }, 8372 { 8373 "type": "string", 8374 "description": "name of the repo", 8375 "name": "repo", 8376 "in": "path", 8377 "required": true 8378 }, 8379 { 8380 "type": "string", 8381 "description": "index of the issue", 8382 "name": "index", 8383 "in": "path", 8384 "required": true 8385 }, 8386 { 8387 "name": "body", 8388 "in": "body", 8389 "schema": { 8390 "$ref": "#/definitions/IssueMeta" 8391 } 8392 } 8393 ], 8394 "responses": { 8395 "200": { 8396 "$ref": "#/responses/Issue" 8397 }, 8398 "404": { 8399 "$ref": "#/responses/notFound" 8400 } 8401 } 8402 } 8403 }, 8404 "/repos/{owner}/{repo}/issues/{index}/comments": { 8405 "get": { 8406 "produces": [ 8407 "application/json" 8408 ], 8409 "tags": [ 8410 "issue" 8411 ], 8412 "summary": "List all comments on an issue", 8413 "operationId": "issueGetComments", 8414 "parameters": [ 8415 { 8416 "type": "string", 8417 "description": "owner of the repo", 8418 "name": "owner", 8419 "in": "path", 8420 "required": true 8421 }, 8422 { 8423 "type": "string", 8424 "description": "name of the repo", 8425 "name": "repo", 8426 "in": "path", 8427 "required": true 8428 }, 8429 { 8430 "type": "integer", 8431 "format": "int64", 8432 "description": "index of the issue", 8433 "name": "index", 8434 "in": "path", 8435 "required": true 8436 }, 8437 { 8438 "type": "string", 8439 "format": "date-time", 8440 "description": "if provided, only comments updated since the specified time are returned.", 8441 "name": "since", 8442 "in": "query" 8443 }, 8444 { 8445 "type": "string", 8446 "format": "date-time", 8447 "description": "if provided, only comments updated before the provided time are returned.", 8448 "name": "before", 8449 "in": "query" 8450 } 8451 ], 8452 "responses": { 8453 "200": { 8454 "$ref": "#/responses/CommentList" 8455 }, 8456 "404": { 8457 "$ref": "#/responses/notFound" 8458 } 8459 } 8460 }, 8461 "post": { 8462 "consumes": [ 8463 "application/json" 8464 ], 8465 "produces": [ 8466 "application/json" 8467 ], 8468 "tags": [ 8469 "issue" 8470 ], 8471 "summary": "Add a comment to an issue", 8472 "operationId": "issueCreateComment", 8473 "parameters": [ 8474 { 8475 "type": "string", 8476 "description": "owner of the repo", 8477 "name": "owner", 8478 "in": "path", 8479 "required": true 8480 }, 8481 { 8482 "type": "string", 8483 "description": "name of the repo", 8484 "name": "repo", 8485 "in": "path", 8486 "required": true 8487 }, 8488 { 8489 "type": "integer", 8490 "format": "int64", 8491 "description": "index of the issue", 8492 "name": "index", 8493 "in": "path", 8494 "required": true 8495 }, 8496 { 8497 "name": "body", 8498 "in": "body", 8499 "schema": { 8500 "$ref": "#/definitions/CreateIssueCommentOption" 8501 } 8502 } 8503 ], 8504 "responses": { 8505 "201": { 8506 "$ref": "#/responses/Comment" 8507 }, 8508 "403": { 8509 "$ref": "#/responses/forbidden" 8510 }, 8511 "404": { 8512 "$ref": "#/responses/notFound" 8513 }, 8514 "423": { 8515 "$ref": "#/responses/repoArchivedError" 8516 } 8517 } 8518 } 8519 }, 8520 "/repos/{owner}/{repo}/issues/{index}/comments/{id}": { 8521 "delete": { 8522 "tags": [ 8523 "issue" 8524 ], 8525 "summary": "Delete a comment", 8526 "operationId": "issueDeleteCommentDeprecated", 8527 "deprecated": true, 8528 "parameters": [ 8529 { 8530 "type": "string", 8531 "description": "owner of the repo", 8532 "name": "owner", 8533 "in": "path", 8534 "required": true 8535 }, 8536 { 8537 "type": "string", 8538 "description": "name of the repo", 8539 "name": "repo", 8540 "in": "path", 8541 "required": true 8542 }, 8543 { 8544 "type": "integer", 8545 "description": "this parameter is ignored", 8546 "name": "index", 8547 "in": "path", 8548 "required": true 8549 }, 8550 { 8551 "type": "integer", 8552 "format": "int64", 8553 "description": "id of comment to delete", 8554 "name": "id", 8555 "in": "path", 8556 "required": true 8557 } 8558 ], 8559 "responses": { 8560 "204": { 8561 "$ref": "#/responses/empty" 8562 }, 8563 "403": { 8564 "$ref": "#/responses/forbidden" 8565 }, 8566 "404": { 8567 "$ref": "#/responses/notFound" 8568 } 8569 } 8570 }, 8571 "patch": { 8572 "consumes": [ 8573 "application/json" 8574 ], 8575 "produces": [ 8576 "application/json" 8577 ], 8578 "tags": [ 8579 "issue" 8580 ], 8581 "summary": "Edit a comment", 8582 "operationId": "issueEditCommentDeprecated", 8583 "deprecated": true, 8584 "parameters": [ 8585 { 8586 "type": "string", 8587 "description": "owner of the repo", 8588 "name": "owner", 8589 "in": "path", 8590 "required": true 8591 }, 8592 { 8593 "type": "string", 8594 "description": "name of the repo", 8595 "name": "repo", 8596 "in": "path", 8597 "required": true 8598 }, 8599 { 8600 "type": "integer", 8601 "description": "this parameter is ignored", 8602 "name": "index", 8603 "in": "path", 8604 "required": true 8605 }, 8606 { 8607 "type": "integer", 8608 "format": "int64", 8609 "description": "id of the comment to edit", 8610 "name": "id", 8611 "in": "path", 8612 "required": true 8613 }, 8614 { 8615 "name": "body", 8616 "in": "body", 8617 "schema": { 8618 "$ref": "#/definitions/EditIssueCommentOption" 8619 } 8620 } 8621 ], 8622 "responses": { 8623 "200": { 8624 "$ref": "#/responses/Comment" 8625 }, 8626 "204": { 8627 "$ref": "#/responses/empty" 8628 }, 8629 "403": { 8630 "$ref": "#/responses/forbidden" 8631 }, 8632 "404": { 8633 "$ref": "#/responses/notFound" 8634 } 8635 } 8636 } 8637 }, 8638 "/repos/{owner}/{repo}/issues/{index}/deadline": { 8639 "post": { 8640 "consumes": [ 8641 "application/json" 8642 ], 8643 "produces": [ 8644 "application/json" 8645 ], 8646 "tags": [ 8647 "issue" 8648 ], 8649 "summary": "Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.", 8650 "operationId": "issueEditIssueDeadline", 8651 "parameters": [ 8652 { 8653 "type": "string", 8654 "description": "owner of the repo", 8655 "name": "owner", 8656 "in": "path", 8657 "required": true 8658 }, 8659 { 8660 "type": "string", 8661 "description": "name of the repo", 8662 "name": "repo", 8663 "in": "path", 8664 "required": true 8665 }, 8666 { 8667 "type": "integer", 8668 "format": "int64", 8669 "description": "index of the issue to create or update a deadline on", 8670 "name": "index", 8671 "in": "path", 8672 "required": true 8673 }, 8674 { 8675 "name": "body", 8676 "in": "body", 8677 "schema": { 8678 "$ref": "#/definitions/EditDeadlineOption" 8679 } 8680 } 8681 ], 8682 "responses": { 8683 "201": { 8684 "$ref": "#/responses/IssueDeadline" 8685 }, 8686 "403": { 8687 "$ref": "#/responses/forbidden" 8688 }, 8689 "404": { 8690 "$ref": "#/responses/notFound" 8691 } 8692 } 8693 } 8694 }, 8695 "/repos/{owner}/{repo}/issues/{index}/dependencies": { 8696 "get": { 8697 "produces": [ 8698 "application/json" 8699 ], 8700 "tags": [ 8701 "issue" 8702 ], 8703 "summary": "List an issue's dependencies, i.e all issues that block this issue.", 8704 "operationId": "issueListIssueDependencies", 8705 "parameters": [ 8706 { 8707 "type": "string", 8708 "description": "owner of the repo", 8709 "name": "owner", 8710 "in": "path", 8711 "required": true 8712 }, 8713 { 8714 "type": "string", 8715 "description": "name of the repo", 8716 "name": "repo", 8717 "in": "path", 8718 "required": true 8719 }, 8720 { 8721 "type": "string", 8722 "description": "index of the issue", 8723 "name": "index", 8724 "in": "path", 8725 "required": true 8726 }, 8727 { 8728 "type": "integer", 8729 "description": "page number of results to return (1-based)", 8730 "name": "page", 8731 "in": "query" 8732 }, 8733 { 8734 "type": "integer", 8735 "description": "page size of results", 8736 "name": "limit", 8737 "in": "query" 8738 } 8739 ], 8740 "responses": { 8741 "200": { 8742 "$ref": "#/responses/IssueList" 8743 }, 8744 "404": { 8745 "$ref": "#/responses/notFound" 8746 } 8747 } 8748 }, 8749 "post": { 8750 "produces": [ 8751 "application/json" 8752 ], 8753 "tags": [ 8754 "issue" 8755 ], 8756 "summary": "Make the issue in the url depend on the issue in the form.", 8757 "operationId": "issueCreateIssueDependencies", 8758 "parameters": [ 8759 { 8760 "type": "string", 8761 "description": "owner of the repo", 8762 "name": "owner", 8763 "in": "path", 8764 "required": true 8765 }, 8766 { 8767 "type": "string", 8768 "description": "name of the repo", 8769 "name": "repo", 8770 "in": "path", 8771 "required": true 8772 }, 8773 { 8774 "type": "string", 8775 "description": "index of the issue", 8776 "name": "index", 8777 "in": "path", 8778 "required": true 8779 }, 8780 { 8781 "name": "body", 8782 "in": "body", 8783 "schema": { 8784 "$ref": "#/definitions/IssueMeta" 8785 } 8786 } 8787 ], 8788 "responses": { 8789 "201": { 8790 "$ref": "#/responses/Issue" 8791 }, 8792 "404": { 8793 "description": "the issue does not exist" 8794 }, 8795 "423": { 8796 "$ref": "#/responses/repoArchivedError" 8797 } 8798 } 8799 }, 8800 "delete": { 8801 "produces": [ 8802 "application/json" 8803 ], 8804 "tags": [ 8805 "issue" 8806 ], 8807 "summary": "Remove an issue dependency", 8808 "operationId": "issueRemoveIssueDependencies", 8809 "parameters": [ 8810 { 8811 "type": "string", 8812 "description": "owner of the repo", 8813 "name": "owner", 8814 "in": "path", 8815 "required": true 8816 }, 8817 { 8818 "type": "string", 8819 "description": "name of the repo", 8820 "name": "repo", 8821 "in": "path", 8822 "required": true 8823 }, 8824 { 8825 "type": "string", 8826 "description": "index of the issue", 8827 "name": "index", 8828 "in": "path", 8829 "required": true 8830 }, 8831 { 8832 "name": "body", 8833 "in": "body", 8834 "schema": { 8835 "$ref": "#/definitions/IssueMeta" 8836 } 8837 } 8838 ], 8839 "responses": { 8840 "200": { 8841 "$ref": "#/responses/Issue" 8842 }, 8843 "404": { 8844 "$ref": "#/responses/notFound" 8845 }, 8846 "423": { 8847 "$ref": "#/responses/repoArchivedError" 8848 } 8849 } 8850 } 8851 }, 8852 "/repos/{owner}/{repo}/issues/{index}/labels": { 8853 "get": { 8854 "produces": [ 8855 "application/json" 8856 ], 8857 "tags": [ 8858 "issue" 8859 ], 8860 "summary": "Get an issue's labels", 8861 "operationId": "issueGetLabels", 8862 "parameters": [ 8863 { 8864 "type": "string", 8865 "description": "owner of the repo", 8866 "name": "owner", 8867 "in": "path", 8868 "required": true 8869 }, 8870 { 8871 "type": "string", 8872 "description": "name of the repo", 8873 "name": "repo", 8874 "in": "path", 8875 "required": true 8876 }, 8877 { 8878 "type": "integer", 8879 "format": "int64", 8880 "description": "index of the issue", 8881 "name": "index", 8882 "in": "path", 8883 "required": true 8884 } 8885 ], 8886 "responses": { 8887 "200": { 8888 "$ref": "#/responses/LabelList" 8889 }, 8890 "404": { 8891 "$ref": "#/responses/notFound" 8892 } 8893 } 8894 }, 8895 "put": { 8896 "consumes": [ 8897 "application/json" 8898 ], 8899 "produces": [ 8900 "application/json" 8901 ], 8902 "tags": [ 8903 "issue" 8904 ], 8905 "summary": "Replace an issue's labels", 8906 "operationId": "issueReplaceLabels", 8907 "parameters": [ 8908 { 8909 "type": "string", 8910 "description": "owner of the repo", 8911 "name": "owner", 8912 "in": "path", 8913 "required": true 8914 }, 8915 { 8916 "type": "string", 8917 "description": "name of the repo", 8918 "name": "repo", 8919 "in": "path", 8920 "required": true 8921 }, 8922 { 8923 "type": "integer", 8924 "format": "int64", 8925 "description": "index of the issue", 8926 "name": "index", 8927 "in": "path", 8928 "required": true 8929 }, 8930 { 8931 "name": "body", 8932 "in": "body", 8933 "schema": { 8934 "$ref": "#/definitions/IssueLabelsOption" 8935 } 8936 } 8937 ], 8938 "responses": { 8939 "200": { 8940 "$ref": "#/responses/LabelList" 8941 }, 8942 "403": { 8943 "$ref": "#/responses/forbidden" 8944 }, 8945 "404": { 8946 "$ref": "#/responses/notFound" 8947 } 8948 } 8949 }, 8950 "post": { 8951 "consumes": [ 8952 "application/json" 8953 ], 8954 "produces": [ 8955 "application/json" 8956 ], 8957 "tags": [ 8958 "issue" 8959 ], 8960 "summary": "Add a label to an issue", 8961 "operationId": "issueAddLabel", 8962 "parameters": [ 8963 { 8964 "type": "string", 8965 "description": "owner of the repo", 8966 "name": "owner", 8967 "in": "path", 8968 "required": true 8969 }, 8970 { 8971 "type": "string", 8972 "description": "name of the repo", 8973 "name": "repo", 8974 "in": "path", 8975 "required": true 8976 }, 8977 { 8978 "type": "integer", 8979 "format": "int64", 8980 "description": "index of the issue", 8981 "name": "index", 8982 "in": "path", 8983 "required": true 8984 }, 8985 { 8986 "name": "body", 8987 "in": "body", 8988 "schema": { 8989 "$ref": "#/definitions/IssueLabelsOption" 8990 } 8991 } 8992 ], 8993 "responses": { 8994 "200": { 8995 "$ref": "#/responses/LabelList" 8996 }, 8997 "403": { 8998 "$ref": "#/responses/forbidden" 8999 }, 9000 "404": { 9001 "$ref": "#/responses/notFound" 9002 } 9003 } 9004 }, 9005 "delete": { 9006 "produces": [ 9007 "application/json" 9008 ], 9009 "tags": [ 9010 "issue" 9011 ], 9012 "summary": "Remove all labels from an issue", 9013 "operationId": "issueClearLabels", 9014 "parameters": [ 9015 { 9016 "type": "string", 9017 "description": "owner of the repo", 9018 "name": "owner", 9019 "in": "path", 9020 "required": true 9021 }, 9022 { 9023 "type": "string", 9024 "description": "name of the repo", 9025 "name": "repo", 9026 "in": "path", 9027 "required": true 9028 }, 9029 { 9030 "type": "integer", 9031 "format": "int64", 9032 "description": "index of the issue", 9033 "name": "index", 9034 "in": "path", 9035 "required": true 9036 } 9037 ], 9038 "responses": { 9039 "204": { 9040 "$ref": "#/responses/empty" 9041 }, 9042 "403": { 9043 "$ref": "#/responses/forbidden" 9044 }, 9045 "404": { 9046 "$ref": "#/responses/notFound" 9047 } 9048 } 9049 } 9050 }, 9051 "/repos/{owner}/{repo}/issues/{index}/labels/{id}": { 9052 "delete": { 9053 "produces": [ 9054 "application/json" 9055 ], 9056 "tags": [ 9057 "issue" 9058 ], 9059 "summary": "Remove a label from an issue", 9060 "operationId": "issueRemoveLabel", 9061 "parameters": [ 9062 { 9063 "type": "string", 9064 "description": "owner of the repo", 9065 "name": "owner", 9066 "in": "path", 9067 "required": true 9068 }, 9069 { 9070 "type": "string", 9071 "description": "name of the repo", 9072 "name": "repo", 9073 "in": "path", 9074 "required": true 9075 }, 9076 { 9077 "type": "integer", 9078 "format": "int64", 9079 "description": "index of the issue", 9080 "name": "index", 9081 "in": "path", 9082 "required": true 9083 }, 9084 { 9085 "type": "integer", 9086 "format": "int64", 9087 "description": "id of the label to remove", 9088 "name": "id", 9089 "in": "path", 9090 "required": true 9091 } 9092 ], 9093 "responses": { 9094 "204": { 9095 "$ref": "#/responses/empty" 9096 }, 9097 "403": { 9098 "$ref": "#/responses/forbidden" 9099 }, 9100 "404": { 9101 "$ref": "#/responses/notFound" 9102 }, 9103 "422": { 9104 "$ref": "#/responses/validationError" 9105 } 9106 } 9107 } 9108 }, 9109 "/repos/{owner}/{repo}/issues/{index}/pin": { 9110 "post": { 9111 "tags": [ 9112 "issue" 9113 ], 9114 "summary": "Pin an Issue", 9115 "operationId": "pinIssue", 9116 "parameters": [ 9117 { 9118 "type": "string", 9119 "description": "owner of the repo", 9120 "name": "owner", 9121 "in": "path", 9122 "required": true 9123 }, 9124 { 9125 "type": "string", 9126 "description": "name of the repo", 9127 "name": "repo", 9128 "in": "path", 9129 "required": true 9130 }, 9131 { 9132 "type": "integer", 9133 "format": "int64", 9134 "description": "index of issue to pin", 9135 "name": "index", 9136 "in": "path", 9137 "required": true 9138 } 9139 ], 9140 "responses": { 9141 "204": { 9142 "$ref": "#/responses/empty" 9143 }, 9144 "403": { 9145 "$ref": "#/responses/forbidden" 9146 }, 9147 "404": { 9148 "$ref": "#/responses/notFound" 9149 } 9150 } 9151 }, 9152 "delete": { 9153 "tags": [ 9154 "issue" 9155 ], 9156 "summary": "Unpin an Issue", 9157 "operationId": "unpinIssue", 9158 "parameters": [ 9159 { 9160 "type": "string", 9161 "description": "owner of the repo", 9162 "name": "owner", 9163 "in": "path", 9164 "required": true 9165 }, 9166 { 9167 "type": "string", 9168 "description": "name of the repo", 9169 "name": "repo", 9170 "in": "path", 9171 "required": true 9172 }, 9173 { 9174 "type": "integer", 9175 "format": "int64", 9176 "description": "index of issue to unpin", 9177 "name": "index", 9178 "in": "path", 9179 "required": true 9180 } 9181 ], 9182 "responses": { 9183 "204": { 9184 "$ref": "#/responses/empty" 9185 }, 9186 "403": { 9187 "$ref": "#/responses/forbidden" 9188 }, 9189 "404": { 9190 "$ref": "#/responses/notFound" 9191 } 9192 } 9193 } 9194 }, 9195 "/repos/{owner}/{repo}/issues/{index}/pin/{position}": { 9196 "patch": { 9197 "tags": [ 9198 "issue" 9199 ], 9200 "summary": "Moves the Pin to the given Position", 9201 "operationId": "moveIssuePin", 9202 "parameters": [ 9203 { 9204 "type": "string", 9205 "description": "owner of the repo", 9206 "name": "owner", 9207 "in": "path", 9208 "required": true 9209 }, 9210 { 9211 "type": "string", 9212 "description": "name of the repo", 9213 "name": "repo", 9214 "in": "path", 9215 "required": true 9216 }, 9217 { 9218 "type": "integer", 9219 "format": "int64", 9220 "description": "index of issue", 9221 "name": "index", 9222 "in": "path", 9223 "required": true 9224 }, 9225 { 9226 "type": "integer", 9227 "format": "int64", 9228 "description": "the new position", 9229 "name": "position", 9230 "in": "path", 9231 "required": true 9232 } 9233 ], 9234 "responses": { 9235 "204": { 9236 "$ref": "#/responses/empty" 9237 }, 9238 "403": { 9239 "$ref": "#/responses/forbidden" 9240 }, 9241 "404": { 9242 "$ref": "#/responses/notFound" 9243 } 9244 } 9245 } 9246 }, 9247 "/repos/{owner}/{repo}/issues/{index}/reactions": { 9248 "get": { 9249 "consumes": [ 9250 "application/json" 9251 ], 9252 "produces": [ 9253 "application/json" 9254 ], 9255 "tags": [ 9256 "issue" 9257 ], 9258 "summary": "Get a list reactions of an issue", 9259 "operationId": "issueGetIssueReactions", 9260 "parameters": [ 9261 { 9262 "type": "string", 9263 "description": "owner of the repo", 9264 "name": "owner", 9265 "in": "path", 9266 "required": true 9267 }, 9268 { 9269 "type": "string", 9270 "description": "name of the repo", 9271 "name": "repo", 9272 "in": "path", 9273 "required": true 9274 }, 9275 { 9276 "type": "integer", 9277 "format": "int64", 9278 "description": "index of the issue", 9279 "name": "index", 9280 "in": "path", 9281 "required": true 9282 }, 9283 { 9284 "type": "integer", 9285 "description": "page number of results to return (1-based)", 9286 "name": "page", 9287 "in": "query" 9288 }, 9289 { 9290 "type": "integer", 9291 "description": "page size of results", 9292 "name": "limit", 9293 "in": "query" 9294 } 9295 ], 9296 "responses": { 9297 "200": { 9298 "$ref": "#/responses/ReactionList" 9299 }, 9300 "403": { 9301 "$ref": "#/responses/forbidden" 9302 }, 9303 "404": { 9304 "$ref": "#/responses/notFound" 9305 } 9306 } 9307 }, 9308 "post": { 9309 "consumes": [ 9310 "application/json" 9311 ], 9312 "produces": [ 9313 "application/json" 9314 ], 9315 "tags": [ 9316 "issue" 9317 ], 9318 "summary": "Add a reaction to an issue", 9319 "operationId": "issuePostIssueReaction", 9320 "parameters": [ 9321 { 9322 "type": "string", 9323 "description": "owner of the repo", 9324 "name": "owner", 9325 "in": "path", 9326 "required": true 9327 }, 9328 { 9329 "type": "string", 9330 "description": "name of the repo", 9331 "name": "repo", 9332 "in": "path", 9333 "required": true 9334 }, 9335 { 9336 "type": "integer", 9337 "format": "int64", 9338 "description": "index of the issue", 9339 "name": "index", 9340 "in": "path", 9341 "required": true 9342 }, 9343 { 9344 "name": "content", 9345 "in": "body", 9346 "schema": { 9347 "$ref": "#/definitions/EditReactionOption" 9348 } 9349 } 9350 ], 9351 "responses": { 9352 "200": { 9353 "$ref": "#/responses/Reaction" 9354 }, 9355 "201": { 9356 "$ref": "#/responses/Reaction" 9357 }, 9358 "403": { 9359 "$ref": "#/responses/forbidden" 9360 }, 9361 "404": { 9362 "$ref": "#/responses/notFound" 9363 } 9364 } 9365 }, 9366 "delete": { 9367 "consumes": [ 9368 "application/json" 9369 ], 9370 "produces": [ 9371 "application/json" 9372 ], 9373 "tags": [ 9374 "issue" 9375 ], 9376 "summary": "Remove a reaction from an issue", 9377 "operationId": "issueDeleteIssueReaction", 9378 "parameters": [ 9379 { 9380 "type": "string", 9381 "description": "owner of the repo", 9382 "name": "owner", 9383 "in": "path", 9384 "required": true 9385 }, 9386 { 9387 "type": "string", 9388 "description": "name of the repo", 9389 "name": "repo", 9390 "in": "path", 9391 "required": true 9392 }, 9393 { 9394 "type": "integer", 9395 "format": "int64", 9396 "description": "index of the issue", 9397 "name": "index", 9398 "in": "path", 9399 "required": true 9400 }, 9401 { 9402 "name": "content", 9403 "in": "body", 9404 "schema": { 9405 "$ref": "#/definitions/EditReactionOption" 9406 } 9407 } 9408 ], 9409 "responses": { 9410 "200": { 9411 "$ref": "#/responses/empty" 9412 }, 9413 "403": { 9414 "$ref": "#/responses/forbidden" 9415 }, 9416 "404": { 9417 "$ref": "#/responses/notFound" 9418 } 9419 } 9420 } 9421 }, 9422 "/repos/{owner}/{repo}/issues/{index}/stopwatch/delete": { 9423 "delete": { 9424 "consumes": [ 9425 "application/json" 9426 ], 9427 "produces": [ 9428 "application/json" 9429 ], 9430 "tags": [ 9431 "issue" 9432 ], 9433 "summary": "Delete an issue's existing stopwatch.", 9434 "operationId": "issueDeleteStopWatch", 9435 "parameters": [ 9436 { 9437 "type": "string", 9438 "description": "owner of the repo", 9439 "name": "owner", 9440 "in": "path", 9441 "required": true 9442 }, 9443 { 9444 "type": "string", 9445 "description": "name of the repo", 9446 "name": "repo", 9447 "in": "path", 9448 "required": true 9449 }, 9450 { 9451 "type": "integer", 9452 "format": "int64", 9453 "description": "index of the issue to stop the stopwatch on", 9454 "name": "index", 9455 "in": "path", 9456 "required": true 9457 } 9458 ], 9459 "responses": { 9460 "204": { 9461 "$ref": "#/responses/empty" 9462 }, 9463 "403": { 9464 "description": "Not repo writer, user does not have rights to toggle stopwatch" 9465 }, 9466 "404": { 9467 "$ref": "#/responses/notFound" 9468 }, 9469 "409": { 9470 "description": "Cannot cancel a non existent stopwatch" 9471 } 9472 } 9473 } 9474 }, 9475 "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": { 9476 "post": { 9477 "consumes": [ 9478 "application/json" 9479 ], 9480 "produces": [ 9481 "application/json" 9482 ], 9483 "tags": [ 9484 "issue" 9485 ], 9486 "summary": "Start stopwatch on an issue.", 9487 "operationId": "issueStartStopWatch", 9488 "parameters": [ 9489 { 9490 "type": "string", 9491 "description": "owner of the repo", 9492 "name": "owner", 9493 "in": "path", 9494 "required": true 9495 }, 9496 { 9497 "type": "string", 9498 "description": "name of the repo", 9499 "name": "repo", 9500 "in": "path", 9501 "required": true 9502 }, 9503 { 9504 "type": "integer", 9505 "format": "int64", 9506 "description": "index of the issue to create the stopwatch on", 9507 "name": "index", 9508 "in": "path", 9509 "required": true 9510 } 9511 ], 9512 "responses": { 9513 "201": { 9514 "$ref": "#/responses/empty" 9515 }, 9516 "403": { 9517 "description": "Not repo writer, user does not have rights to toggle stopwatch" 9518 }, 9519 "404": { 9520 "$ref": "#/responses/notFound" 9521 }, 9522 "409": { 9523 "description": "Cannot start a stopwatch again if it already exists" 9524 } 9525 } 9526 } 9527 }, 9528 "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": { 9529 "post": { 9530 "consumes": [ 9531 "application/json" 9532 ], 9533 "produces": [ 9534 "application/json" 9535 ], 9536 "tags": [ 9537 "issue" 9538 ], 9539 "summary": "Stop an issue's existing stopwatch.", 9540 "operationId": "issueStopStopWatch", 9541 "parameters": [ 9542 { 9543 "type": "string", 9544 "description": "owner of the repo", 9545 "name": "owner", 9546 "in": "path", 9547 "required": true 9548 }, 9549 { 9550 "type": "string", 9551 "description": "name of the repo", 9552 "name": "repo", 9553 "in": "path", 9554 "required": true 9555 }, 9556 { 9557 "type": "integer", 9558 "format": "int64", 9559 "description": "index of the issue to stop the stopwatch on", 9560 "name": "index", 9561 "in": "path", 9562 "required": true 9563 } 9564 ], 9565 "responses": { 9566 "201": { 9567 "$ref": "#/responses/empty" 9568 }, 9569 "403": { 9570 "description": "Not repo writer, user does not have rights to toggle stopwatch" 9571 }, 9572 "404": { 9573 "$ref": "#/responses/notFound" 9574 }, 9575 "409": { 9576 "description": "Cannot stop a non existent stopwatch" 9577 } 9578 } 9579 } 9580 }, 9581 "/repos/{owner}/{repo}/issues/{index}/subscriptions": { 9582 "get": { 9583 "consumes": [ 9584 "application/json" 9585 ], 9586 "produces": [ 9587 "application/json" 9588 ], 9589 "tags": [ 9590 "issue" 9591 ], 9592 "summary": "Get users who subscribed on an issue.", 9593 "operationId": "issueSubscriptions", 9594 "parameters": [ 9595 { 9596 "type": "string", 9597 "description": "owner of the repo", 9598 "name": "owner", 9599 "in": "path", 9600 "required": true 9601 }, 9602 { 9603 "type": "string", 9604 "description": "name of the repo", 9605 "name": "repo", 9606 "in": "path", 9607 "required": true 9608 }, 9609 { 9610 "type": "integer", 9611 "format": "int64", 9612 "description": "index of the issue", 9613 "name": "index", 9614 "in": "path", 9615 "required": true 9616 }, 9617 { 9618 "type": "integer", 9619 "description": "page number of results to return (1-based)", 9620 "name": "page", 9621 "in": "query" 9622 }, 9623 { 9624 "type": "integer", 9625 "description": "page size of results", 9626 "name": "limit", 9627 "in": "query" 9628 } 9629 ], 9630 "responses": { 9631 "200": { 9632 "$ref": "#/responses/UserList" 9633 }, 9634 "404": { 9635 "$ref": "#/responses/notFound" 9636 } 9637 } 9638 } 9639 }, 9640 "/repos/{owner}/{repo}/issues/{index}/subscriptions/check": { 9641 "get": { 9642 "consumes": [ 9643 "application/json" 9644 ], 9645 "produces": [ 9646 "application/json" 9647 ], 9648 "tags": [ 9649 "issue" 9650 ], 9651 "summary": "Check if user is subscribed to an issue", 9652 "operationId": "issueCheckSubscription", 9653 "parameters": [ 9654 { 9655 "type": "string", 9656 "description": "owner of the repo", 9657 "name": "owner", 9658 "in": "path", 9659 "required": true 9660 }, 9661 { 9662 "type": "string", 9663 "description": "name of the repo", 9664 "name": "repo", 9665 "in": "path", 9666 "required": true 9667 }, 9668 { 9669 "type": "integer", 9670 "format": "int64", 9671 "description": "index of the issue", 9672 "name": "index", 9673 "in": "path", 9674 "required": true 9675 } 9676 ], 9677 "responses": { 9678 "200": { 9679 "$ref": "#/responses/WatchInfo" 9680 }, 9681 "404": { 9682 "$ref": "#/responses/notFound" 9683 } 9684 } 9685 } 9686 }, 9687 "/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}": { 9688 "put": { 9689 "consumes": [ 9690 "application/json" 9691 ], 9692 "produces": [ 9693 "application/json" 9694 ], 9695 "tags": [ 9696 "issue" 9697 ], 9698 "summary": "Subscribe user to issue", 9699 "operationId": "issueAddSubscription", 9700 "parameters": [ 9701 { 9702 "type": "string", 9703 "description": "owner of the repo", 9704 "name": "owner", 9705 "in": "path", 9706 "required": true 9707 }, 9708 { 9709 "type": "string", 9710 "description": "name of the repo", 9711 "name": "repo", 9712 "in": "path", 9713 "required": true 9714 }, 9715 { 9716 "type": "integer", 9717 "format": "int64", 9718 "description": "index of the issue", 9719 "name": "index", 9720 "in": "path", 9721 "required": true 9722 }, 9723 { 9724 "type": "string", 9725 "description": "user to subscribe", 9726 "name": "user", 9727 "in": "path", 9728 "required": true 9729 } 9730 ], 9731 "responses": { 9732 "200": { 9733 "description": "Already subscribed" 9734 }, 9735 "201": { 9736 "description": "Successfully Subscribed" 9737 }, 9738 "304": { 9739 "description": "User can only subscribe itself if he is no admin" 9740 }, 9741 "404": { 9742 "$ref": "#/responses/notFound" 9743 } 9744 } 9745 }, 9746 "delete": { 9747 "consumes": [ 9748 "application/json" 9749 ], 9750 "produces": [ 9751 "application/json" 9752 ], 9753 "tags": [ 9754 "issue" 9755 ], 9756 "summary": "Unsubscribe user from issue", 9757 "operationId": "issueDeleteSubscription", 9758 "parameters": [ 9759 { 9760 "type": "string", 9761 "description": "owner of the repo", 9762 "name": "owner", 9763 "in": "path", 9764 "required": true 9765 }, 9766 { 9767 "type": "string", 9768 "description": "name of the repo", 9769 "name": "repo", 9770 "in": "path", 9771 "required": true 9772 }, 9773 { 9774 "type": "integer", 9775 "format": "int64", 9776 "description": "index of the issue", 9777 "name": "index", 9778 "in": "path", 9779 "required": true 9780 }, 9781 { 9782 "type": "string", 9783 "description": "user witch unsubscribe", 9784 "name": "user", 9785 "in": "path", 9786 "required": true 9787 } 9788 ], 9789 "responses": { 9790 "200": { 9791 "description": "Already unsubscribed" 9792 }, 9793 "201": { 9794 "description": "Successfully Unsubscribed" 9795 }, 9796 "304": { 9797 "description": "User can only subscribe itself if he is no admin" 9798 }, 9799 "404": { 9800 "$ref": "#/responses/notFound" 9801 } 9802 } 9803 } 9804 }, 9805 "/repos/{owner}/{repo}/issues/{index}/timeline": { 9806 "get": { 9807 "produces": [ 9808 "application/json" 9809 ], 9810 "tags": [ 9811 "issue" 9812 ], 9813 "summary": "List all comments and events on an issue", 9814 "operationId": "issueGetCommentsAndTimeline", 9815 "parameters": [ 9816 { 9817 "type": "string", 9818 "description": "owner of the repo", 9819 "name": "owner", 9820 "in": "path", 9821 "required": true 9822 }, 9823 { 9824 "type": "string", 9825 "description": "name of the repo", 9826 "name": "repo", 9827 "in": "path", 9828 "required": true 9829 }, 9830 { 9831 "type": "integer", 9832 "format": "int64", 9833 "description": "index of the issue", 9834 "name": "index", 9835 "in": "path", 9836 "required": true 9837 }, 9838 { 9839 "type": "string", 9840 "format": "date-time", 9841 "description": "if provided, only comments updated since the specified time are returned.", 9842 "name": "since", 9843 "in": "query" 9844 }, 9845 { 9846 "type": "integer", 9847 "description": "page number of results to return (1-based)", 9848 "name": "page", 9849 "in": "query" 9850 }, 9851 { 9852 "type": "integer", 9853 "description": "page size of results", 9854 "name": "limit", 9855 "in": "query" 9856 }, 9857 { 9858 "type": "string", 9859 "format": "date-time", 9860 "description": "if provided, only comments updated before the provided time are returned.", 9861 "name": "before", 9862 "in": "query" 9863 } 9864 ], 9865 "responses": { 9866 "200": { 9867 "$ref": "#/responses/TimelineList" 9868 }, 9869 "404": { 9870 "$ref": "#/responses/notFound" 9871 } 9872 } 9873 } 9874 }, 9875 "/repos/{owner}/{repo}/issues/{index}/times": { 9876 "get": { 9877 "produces": [ 9878 "application/json" 9879 ], 9880 "tags": [ 9881 "issue" 9882 ], 9883 "summary": "List an issue's tracked times", 9884 "operationId": "issueTrackedTimes", 9885 "parameters": [ 9886 { 9887 "type": "string", 9888 "description": "owner of the repo", 9889 "name": "owner", 9890 "in": "path", 9891 "required": true 9892 }, 9893 { 9894 "type": "string", 9895 "description": "name of the repo", 9896 "name": "repo", 9897 "in": "path", 9898 "required": true 9899 }, 9900 { 9901 "type": "integer", 9902 "format": "int64", 9903 "description": "index of the issue", 9904 "name": "index", 9905 "in": "path", 9906 "required": true 9907 }, 9908 { 9909 "type": "string", 9910 "description": "optional filter by user (available for issue managers)", 9911 "name": "user", 9912 "in": "query" 9913 }, 9914 { 9915 "type": "string", 9916 "format": "date-time", 9917 "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format", 9918 "name": "since", 9919 "in": "query" 9920 }, 9921 { 9922 "type": "string", 9923 "format": "date-time", 9924 "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format", 9925 "name": "before", 9926 "in": "query" 9927 }, 9928 { 9929 "type": "integer", 9930 "description": "page number of results to return (1-based)", 9931 "name": "page", 9932 "in": "query" 9933 }, 9934 { 9935 "type": "integer", 9936 "description": "page size of results", 9937 "name": "limit", 9938 "in": "query" 9939 } 9940 ], 9941 "responses": { 9942 "200": { 9943 "$ref": "#/responses/TrackedTimeList" 9944 }, 9945 "404": { 9946 "$ref": "#/responses/notFound" 9947 } 9948 } 9949 }, 9950 "post": { 9951 "consumes": [ 9952 "application/json" 9953 ], 9954 "produces": [ 9955 "application/json" 9956 ], 9957 "tags": [ 9958 "issue" 9959 ], 9960 "summary": "Add tracked time to a issue", 9961 "operationId": "issueAddTime", 9962 "parameters": [ 9963 { 9964 "type": "string", 9965 "description": "owner of the repo", 9966 "name": "owner", 9967 "in": "path", 9968 "required": true 9969 }, 9970 { 9971 "type": "string", 9972 "description": "name of the repo", 9973 "name": "repo", 9974 "in": "path", 9975 "required": true 9976 }, 9977 { 9978 "type": "integer", 9979 "format": "int64", 9980 "description": "index of the issue", 9981 "name": "index", 9982 "in": "path", 9983 "required": true 9984 }, 9985 { 9986 "name": "body", 9987 "in": "body", 9988 "schema": { 9989 "$ref": "#/definitions/AddTimeOption" 9990 } 9991 } 9992 ], 9993 "responses": { 9994 "200": { 9995 "$ref": "#/responses/TrackedTime" 9996 }, 9997 "400": { 9998 "$ref": "#/responses/error" 9999 }, 10000 "403": { 10001 "$ref": "#/responses/forbidden" 10002 }, 10003 "404": { 10004 "$ref": "#/responses/notFound" 10005 } 10006 } 10007 }, 10008 "delete": { 10009 "consumes": [ 10010 "application/json" 10011 ], 10012 "produces": [ 10013 "application/json" 10014 ], 10015 "tags": [ 10016 "issue" 10017 ], 10018 "summary": "Reset a tracked time of an issue", 10019 "operationId": "issueResetTime", 10020 "parameters": [ 10021 { 10022 "type": "string", 10023 "description": "owner of the repo", 10024 "name": "owner", 10025 "in": "path", 10026 "required": true 10027 }, 10028 { 10029 "type": "string", 10030 "description": "name of the repo", 10031 "name": "repo", 10032 "in": "path", 10033 "required": true 10034 }, 10035 { 10036 "type": "integer", 10037 "format": "int64", 10038 "description": "index of the issue to add tracked time to", 10039 "name": "index", 10040 "in": "path", 10041 "required": true 10042 } 10043 ], 10044 "responses": { 10045 "204": { 10046 "$ref": "#/responses/empty" 10047 }, 10048 "400": { 10049 "$ref": "#/responses/error" 10050 }, 10051 "403": { 10052 "$ref": "#/responses/forbidden" 10053 }, 10054 "404": { 10055 "$ref": "#/responses/notFound" 10056 } 10057 } 10058 } 10059 }, 10060 "/repos/{owner}/{repo}/issues/{index}/times/{id}": { 10061 "delete": { 10062 "consumes": [ 10063 "application/json" 10064 ], 10065 "produces": [ 10066 "application/json" 10067 ], 10068 "tags": [ 10069 "issue" 10070 ], 10071 "summary": "Delete specific tracked time", 10072 "operationId": "issueDeleteTime", 10073 "parameters": [ 10074 { 10075 "type": "string", 10076 "description": "owner of the repo", 10077 "name": "owner", 10078 "in": "path", 10079 "required": true 10080 }, 10081 { 10082 "type": "string", 10083 "description": "name of the repo", 10084 "name": "repo", 10085 "in": "path", 10086 "required": true 10087 }, 10088 { 10089 "type": "integer", 10090 "format": "int64", 10091 "description": "index of the issue", 10092 "name": "index", 10093 "in": "path", 10094 "required": true 10095 }, 10096 { 10097 "type": "integer", 10098 "format": "int64", 10099 "description": "id of time to delete", 10100 "name": "id", 10101 "in": "path", 10102 "required": true 10103 } 10104 ], 10105 "responses": { 10106 "204": { 10107 "$ref": "#/responses/empty" 10108 }, 10109 "400": { 10110 "$ref": "#/responses/error" 10111 }, 10112 "403": { 10113 "$ref": "#/responses/forbidden" 10114 }, 10115 "404": { 10116 "$ref": "#/responses/notFound" 10117 } 10118 } 10119 } 10120 }, 10121 "/repos/{owner}/{repo}/keys": { 10122 "get": { 10123 "produces": [ 10124 "application/json" 10125 ], 10126 "tags": [ 10127 "repository" 10128 ], 10129 "summary": "List a repository's keys", 10130 "operationId": "repoListKeys", 10131 "parameters": [ 10132 { 10133 "type": "string", 10134 "description": "owner of the repo", 10135 "name": "owner", 10136 "in": "path", 10137 "required": true 10138 }, 10139 { 10140 "type": "string", 10141 "description": "name of the repo", 10142 "name": "repo", 10143 "in": "path", 10144 "required": true 10145 }, 10146 { 10147 "type": "integer", 10148 "description": "the key_id to search for", 10149 "name": "key_id", 10150 "in": "query" 10151 }, 10152 { 10153 "type": "string", 10154 "description": "fingerprint of the key", 10155 "name": "fingerprint", 10156 "in": "query" 10157 }, 10158 { 10159 "type": "integer", 10160 "description": "page number of results to return (1-based)", 10161 "name": "page", 10162 "in": "query" 10163 }, 10164 { 10165 "type": "integer", 10166 "description": "page size of results", 10167 "name": "limit", 10168 "in": "query" 10169 } 10170 ], 10171 "responses": { 10172 "200": { 10173 "$ref": "#/responses/DeployKeyList" 10174 }, 10175 "404": { 10176 "$ref": "#/responses/notFound" 10177 } 10178 } 10179 }, 10180 "post": { 10181 "consumes": [ 10182 "application/json" 10183 ], 10184 "produces": [ 10185 "application/json" 10186 ], 10187 "tags": [ 10188 "repository" 10189 ], 10190 "summary": "Add a key to a repository", 10191 "operationId": "repoCreateKey", 10192 "parameters": [ 10193 { 10194 "type": "string", 10195 "description": "owner of the repo", 10196 "name": "owner", 10197 "in": "path", 10198 "required": true 10199 }, 10200 { 10201 "type": "string", 10202 "description": "name of the repo", 10203 "name": "repo", 10204 "in": "path", 10205 "required": true 10206 }, 10207 { 10208 "name": "body", 10209 "in": "body", 10210 "schema": { 10211 "$ref": "#/definitions/CreateKeyOption" 10212 } 10213 } 10214 ], 10215 "responses": { 10216 "201": { 10217 "$ref": "#/responses/DeployKey" 10218 }, 10219 "404": { 10220 "$ref": "#/responses/notFound" 10221 }, 10222 "422": { 10223 "$ref": "#/responses/validationError" 10224 } 10225 } 10226 } 10227 }, 10228 "/repos/{owner}/{repo}/keys/{id}": { 10229 "get": { 10230 "produces": [ 10231 "application/json" 10232 ], 10233 "tags": [ 10234 "repository" 10235 ], 10236 "summary": "Get a repository's key by id", 10237 "operationId": "repoGetKey", 10238 "parameters": [ 10239 { 10240 "type": "string", 10241 "description": "owner of the repo", 10242 "name": "owner", 10243 "in": "path", 10244 "required": true 10245 }, 10246 { 10247 "type": "string", 10248 "description": "name of the repo", 10249 "name": "repo", 10250 "in": "path", 10251 "required": true 10252 }, 10253 { 10254 "type": "integer", 10255 "format": "int64", 10256 "description": "id of the key to get", 10257 "name": "id", 10258 "in": "path", 10259 "required": true 10260 } 10261 ], 10262 "responses": { 10263 "200": { 10264 "$ref": "#/responses/DeployKey" 10265 }, 10266 "404": { 10267 "$ref": "#/responses/notFound" 10268 } 10269 } 10270 }, 10271 "delete": { 10272 "tags": [ 10273 "repository" 10274 ], 10275 "summary": "Delete a key from a repository", 10276 "operationId": "repoDeleteKey", 10277 "parameters": [ 10278 { 10279 "type": "string", 10280 "description": "owner of the repo", 10281 "name": "owner", 10282 "in": "path", 10283 "required": true 10284 }, 10285 { 10286 "type": "string", 10287 "description": "name of the repo", 10288 "name": "repo", 10289 "in": "path", 10290 "required": true 10291 }, 10292 { 10293 "type": "integer", 10294 "format": "int64", 10295 "description": "id of the key to delete", 10296 "name": "id", 10297 "in": "path", 10298 "required": true 10299 } 10300 ], 10301 "responses": { 10302 "204": { 10303 "$ref": "#/responses/empty" 10304 }, 10305 "403": { 10306 "$ref": "#/responses/forbidden" 10307 }, 10308 "404": { 10309 "$ref": "#/responses/notFound" 10310 } 10311 } 10312 } 10313 }, 10314 "/repos/{owner}/{repo}/labels": { 10315 "get": { 10316 "produces": [ 10317 "application/json" 10318 ], 10319 "tags": [ 10320 "issue" 10321 ], 10322 "summary": "Get all of a repository's labels", 10323 "operationId": "issueListLabels", 10324 "parameters": [ 10325 { 10326 "type": "string", 10327 "description": "owner of the repo", 10328 "name": "owner", 10329 "in": "path", 10330 "required": true 10331 }, 10332 { 10333 "type": "string", 10334 "description": "name of the repo", 10335 "name": "repo", 10336 "in": "path", 10337 "required": true 10338 }, 10339 { 10340 "type": "integer", 10341 "description": "page number of results to return (1-based)", 10342 "name": "page", 10343 "in": "query" 10344 }, 10345 { 10346 "type": "integer", 10347 "description": "page size of results", 10348 "name": "limit", 10349 "in": "query" 10350 } 10351 ], 10352 "responses": { 10353 "200": { 10354 "$ref": "#/responses/LabelList" 10355 }, 10356 "404": { 10357 "$ref": "#/responses/notFound" 10358 } 10359 } 10360 }, 10361 "post": { 10362 "consumes": [ 10363 "application/json" 10364 ], 10365 "produces": [ 10366 "application/json" 10367 ], 10368 "tags": [ 10369 "issue" 10370 ], 10371 "summary": "Create a label", 10372 "operationId": "issueCreateLabel", 10373 "parameters": [ 10374 { 10375 "type": "string", 10376 "description": "owner of the repo", 10377 "name": "owner", 10378 "in": "path", 10379 "required": true 10380 }, 10381 { 10382 "type": "string", 10383 "description": "name of the repo", 10384 "name": "repo", 10385 "in": "path", 10386 "required": true 10387 }, 10388 { 10389 "name": "body", 10390 "in": "body", 10391 "schema": { 10392 "$ref": "#/definitions/CreateLabelOption" 10393 } 10394 } 10395 ], 10396 "responses": { 10397 "201": { 10398 "$ref": "#/responses/Label" 10399 }, 10400 "404": { 10401 "$ref": "#/responses/notFound" 10402 }, 10403 "422": { 10404 "$ref": "#/responses/validationError" 10405 } 10406 } 10407 } 10408 }, 10409 "/repos/{owner}/{repo}/labels/{id}": { 10410 "get": { 10411 "produces": [ 10412 "application/json" 10413 ], 10414 "tags": [ 10415 "issue" 10416 ], 10417 "summary": "Get a single label", 10418 "operationId": "issueGetLabel", 10419 "parameters": [ 10420 { 10421 "type": "string", 10422 "description": "owner of the repo", 10423 "name": "owner", 10424 "in": "path", 10425 "required": true 10426 }, 10427 { 10428 "type": "string", 10429 "description": "name of the repo", 10430 "name": "repo", 10431 "in": "path", 10432 "required": true 10433 }, 10434 { 10435 "type": "integer", 10436 "format": "int64", 10437 "description": "id of the label to get", 10438 "name": "id", 10439 "in": "path", 10440 "required": true 10441 } 10442 ], 10443 "responses": { 10444 "200": { 10445 "$ref": "#/responses/Label" 10446 }, 10447 "404": { 10448 "$ref": "#/responses/notFound" 10449 } 10450 } 10451 }, 10452 "delete": { 10453 "tags": [ 10454 "issue" 10455 ], 10456 "summary": "Delete a label", 10457 "operationId": "issueDeleteLabel", 10458 "parameters": [ 10459 { 10460 "type": "string", 10461 "description": "owner of the repo", 10462 "name": "owner", 10463 "in": "path", 10464 "required": true 10465 }, 10466 { 10467 "type": "string", 10468 "description": "name of the repo", 10469 "name": "repo", 10470 "in": "path", 10471 "required": true 10472 }, 10473 { 10474 "type": "integer", 10475 "format": "int64", 10476 "description": "id of the label to delete", 10477 "name": "id", 10478 "in": "path", 10479 "required": true 10480 } 10481 ], 10482 "responses": { 10483 "204": { 10484 "$ref": "#/responses/empty" 10485 }, 10486 "404": { 10487 "$ref": "#/responses/notFound" 10488 } 10489 } 10490 }, 10491 "patch": { 10492 "consumes": [ 10493 "application/json" 10494 ], 10495 "produces": [ 10496 "application/json" 10497 ], 10498 "tags": [ 10499 "issue" 10500 ], 10501 "summary": "Update a label", 10502 "operationId": "issueEditLabel", 10503 "parameters": [ 10504 { 10505 "type": "string", 10506 "description": "owner of the repo", 10507 "name": "owner", 10508 "in": "path", 10509 "required": true 10510 }, 10511 { 10512 "type": "string", 10513 "description": "name of the repo", 10514 "name": "repo", 10515 "in": "path", 10516 "required": true 10517 }, 10518 { 10519 "type": "integer", 10520 "format": "int64", 10521 "description": "id of the label to edit", 10522 "name": "id", 10523 "in": "path", 10524 "required": true 10525 }, 10526 { 10527 "name": "body", 10528 "in": "body", 10529 "schema": { 10530 "$ref": "#/definitions/EditLabelOption" 10531 } 10532 } 10533 ], 10534 "responses": { 10535 "200": { 10536 "$ref": "#/responses/Label" 10537 }, 10538 "404": { 10539 "$ref": "#/responses/notFound" 10540 }, 10541 "422": { 10542 "$ref": "#/responses/validationError" 10543 } 10544 } 10545 } 10546 }, 10547 "/repos/{owner}/{repo}/languages": { 10548 "get": { 10549 "produces": [ 10550 "application/json" 10551 ], 10552 "tags": [ 10553 "repository" 10554 ], 10555 "summary": "Get languages and number of bytes of code written", 10556 "operationId": "repoGetLanguages", 10557 "parameters": [ 10558 { 10559 "type": "string", 10560 "description": "owner of the repo", 10561 "name": "owner", 10562 "in": "path", 10563 "required": true 10564 }, 10565 { 10566 "type": "string", 10567 "description": "name of the repo", 10568 "name": "repo", 10569 "in": "path", 10570 "required": true 10571 } 10572 ], 10573 "responses": { 10574 "200": { 10575 "$ref": "#/responses/LanguageStatistics" 10576 }, 10577 "404": { 10578 "$ref": "#/responses/notFound" 10579 } 10580 } 10581 } 10582 }, 10583 "/repos/{owner}/{repo}/media/{filepath}": { 10584 "get": { 10585 "tags": [ 10586 "repository" 10587 ], 10588 "summary": "Get a file or it's LFS object from a repository", 10589 "operationId": "repoGetRawFileOrLFS", 10590 "parameters": [ 10591 { 10592 "type": "string", 10593 "description": "owner of the repo", 10594 "name": "owner", 10595 "in": "path", 10596 "required": true 10597 }, 10598 { 10599 "type": "string", 10600 "description": "name of the repo", 10601 "name": "repo", 10602 "in": "path", 10603 "required": true 10604 }, 10605 { 10606 "type": "string", 10607 "description": "filepath of the file to get", 10608 "name": "filepath", 10609 "in": "path", 10610 "required": true 10611 }, 10612 { 10613 "type": "string", 10614 "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)", 10615 "name": "ref", 10616 "in": "query" 10617 } 10618 ], 10619 "responses": { 10620 "200": { 10621 "description": "Returns raw file content." 10622 }, 10623 "404": { 10624 "$ref": "#/responses/notFound" 10625 } 10626 } 10627 } 10628 }, 10629 "/repos/{owner}/{repo}/milestones": { 10630 "get": { 10631 "produces": [ 10632 "application/json" 10633 ], 10634 "tags": [ 10635 "issue" 10636 ], 10637 "summary": "Get all of a repository's opened milestones", 10638 "operationId": "issueGetMilestonesList", 10639 "parameters": [ 10640 { 10641 "type": "string", 10642 "description": "owner of the repo", 10643 "name": "owner", 10644 "in": "path", 10645 "required": true 10646 }, 10647 { 10648 "type": "string", 10649 "description": "name of the repo", 10650 "name": "repo", 10651 "in": "path", 10652 "required": true 10653 }, 10654 { 10655 "type": "string", 10656 "description": "Milestone state, Recognized values are open, closed and all. Defaults to \"open\"", 10657 "name": "state", 10658 "in": "query" 10659 }, 10660 { 10661 "type": "string", 10662 "description": "filter by milestone name", 10663 "name": "name", 10664 "in": "query" 10665 }, 10666 { 10667 "type": "integer", 10668 "description": "page number of results to return (1-based)", 10669 "name": "page", 10670 "in": "query" 10671 }, 10672 { 10673 "type": "integer", 10674 "description": "page size of results", 10675 "name": "limit", 10676 "in": "query" 10677 } 10678 ], 10679 "responses": { 10680 "200": { 10681 "$ref": "#/responses/MilestoneList" 10682 }, 10683 "404": { 10684 "$ref": "#/responses/notFound" 10685 } 10686 } 10687 }, 10688 "post": { 10689 "consumes": [ 10690 "application/json" 10691 ], 10692 "produces": [ 10693 "application/json" 10694 ], 10695 "tags": [ 10696 "issue" 10697 ], 10698 "summary": "Create a milestone", 10699 "operationId": "issueCreateMilestone", 10700 "parameters": [ 10701 { 10702 "type": "string", 10703 "description": "owner of the repo", 10704 "name": "owner", 10705 "in": "path", 10706 "required": true 10707 }, 10708 { 10709 "type": "string", 10710 "description": "name of the repo", 10711 "name": "repo", 10712 "in": "path", 10713 "required": true 10714 }, 10715 { 10716 "name": "body", 10717 "in": "body", 10718 "schema": { 10719 "$ref": "#/definitions/CreateMilestoneOption" 10720 } 10721 } 10722 ], 10723 "responses": { 10724 "201": { 10725 "$ref": "#/responses/Milestone" 10726 }, 10727 "404": { 10728 "$ref": "#/responses/notFound" 10729 } 10730 } 10731 } 10732 }, 10733 "/repos/{owner}/{repo}/milestones/{id}": { 10734 "get": { 10735 "produces": [ 10736 "application/json" 10737 ], 10738 "tags": [ 10739 "issue" 10740 ], 10741 "summary": "Get a milestone", 10742 "operationId": "issueGetMilestone", 10743 "parameters": [ 10744 { 10745 "type": "string", 10746 "description": "owner of the repo", 10747 "name": "owner", 10748 "in": "path", 10749 "required": true 10750 }, 10751 { 10752 "type": "string", 10753 "description": "name of the repo", 10754 "name": "repo", 10755 "in": "path", 10756 "required": true 10757 }, 10758 { 10759 "type": "string", 10760 "description": "the milestone to get, identified by ID and if not available by name", 10761 "name": "id", 10762 "in": "path", 10763 "required": true 10764 } 10765 ], 10766 "responses": { 10767 "200": { 10768 "$ref": "#/responses/Milestone" 10769 }, 10770 "404": { 10771 "$ref": "#/responses/notFound" 10772 } 10773 } 10774 }, 10775 "delete": { 10776 "tags": [ 10777 "issue" 10778 ], 10779 "summary": "Delete a milestone", 10780 "operationId": "issueDeleteMilestone", 10781 "parameters": [ 10782 { 10783 "type": "string", 10784 "description": "owner of the repo", 10785 "name": "owner", 10786 "in": "path", 10787 "required": true 10788 }, 10789 { 10790 "type": "string", 10791 "description": "name of the repo", 10792 "name": "repo", 10793 "in": "path", 10794 "required": true 10795 }, 10796 { 10797 "type": "string", 10798 "description": "the milestone to delete, identified by ID and if not available by name", 10799 "name": "id", 10800 "in": "path", 10801 "required": true 10802 } 10803 ], 10804 "responses": { 10805 "204": { 10806 "$ref": "#/responses/empty" 10807 }, 10808 "404": { 10809 "$ref": "#/responses/notFound" 10810 } 10811 } 10812 }, 10813 "patch": { 10814 "consumes": [ 10815 "application/json" 10816 ], 10817 "produces": [ 10818 "application/json" 10819 ], 10820 "tags": [ 10821 "issue" 10822 ], 10823 "summary": "Update a milestone", 10824 "operationId": "issueEditMilestone", 10825 "parameters": [ 10826 { 10827 "type": "string", 10828 "description": "owner of the repo", 10829 "name": "owner", 10830 "in": "path", 10831 "required": true 10832 }, 10833 { 10834 "type": "string", 10835 "description": "name of the repo", 10836 "name": "repo", 10837 "in": "path", 10838 "required": true 10839 }, 10840 { 10841 "type": "string", 10842 "description": "the milestone to edit, identified by ID and if not available by name", 10843 "name": "id", 10844 "in": "path", 10845 "required": true 10846 }, 10847 { 10848 "name": "body", 10849 "in": "body", 10850 "schema": { 10851 "$ref": "#/definitions/EditMilestoneOption" 10852 } 10853 } 10854 ], 10855 "responses": { 10856 "200": { 10857 "$ref": "#/responses/Milestone" 10858 }, 10859 "404": { 10860 "$ref": "#/responses/notFound" 10861 } 10862 } 10863 } 10864 }, 10865 "/repos/{owner}/{repo}/mirror-sync": { 10866 "post": { 10867 "produces": [ 10868 "application/json" 10869 ], 10870 "tags": [ 10871 "repository" 10872 ], 10873 "summary": "Sync a mirrored repository", 10874 "operationId": "repoMirrorSync", 10875 "parameters": [ 10876 { 10877 "type": "string", 10878 "description": "owner of the repo to sync", 10879 "name": "owner", 10880 "in": "path", 10881 "required": true 10882 }, 10883 { 10884 "type": "string", 10885 "description": "name of the repo to sync", 10886 "name": "repo", 10887 "in": "path", 10888 "required": true 10889 } 10890 ], 10891 "responses": { 10892 "200": { 10893 "$ref": "#/responses/empty" 10894 }, 10895 "403": { 10896 "$ref": "#/responses/forbidden" 10897 }, 10898 "404": { 10899 "$ref": "#/responses/notFound" 10900 } 10901 } 10902 } 10903 }, 10904 "/repos/{owner}/{repo}/new_pin_allowed": { 10905 "get": { 10906 "produces": [ 10907 "application/json" 10908 ], 10909 "tags": [ 10910 "repository" 10911 ], 10912 "summary": "Returns if new Issue Pins are allowed", 10913 "operationId": "repoNewPinAllowed", 10914 "parameters": [ 10915 { 10916 "type": "string", 10917 "description": "owner of the repo", 10918 "name": "owner", 10919 "in": "path", 10920 "required": true 10921 }, 10922 { 10923 "type": "string", 10924 "description": "name of the repo", 10925 "name": "repo", 10926 "in": "path", 10927 "required": true 10928 } 10929 ], 10930 "responses": { 10931 "200": { 10932 "$ref": "#/responses/RepoNewIssuePinsAllowed" 10933 }, 10934 "404": { 10935 "$ref": "#/responses/notFound" 10936 } 10937 } 10938 } 10939 }, 10940 "/repos/{owner}/{repo}/notifications": { 10941 "get": { 10942 "consumes": [ 10943 "application/json" 10944 ], 10945 "produces": [ 10946 "application/json" 10947 ], 10948 "tags": [ 10949 "notification" 10950 ], 10951 "summary": "List users's notification threads on a specific repo", 10952 "operationId": "notifyGetRepoList", 10953 "parameters": [ 10954 { 10955 "type": "string", 10956 "description": "owner of the repo", 10957 "name": "owner", 10958 "in": "path", 10959 "required": true 10960 }, 10961 { 10962 "type": "string", 10963 "description": "name of the repo", 10964 "name": "repo", 10965 "in": "path", 10966 "required": true 10967 }, 10968 { 10969 "type": "boolean", 10970 "description": "If true, show notifications marked as read. Default value is false", 10971 "name": "all", 10972 "in": "query" 10973 }, 10974 { 10975 "type": "array", 10976 "items": { 10977 "type": "string" 10978 }, 10979 "collectionFormat": "multi", 10980 "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned", 10981 "name": "status-types", 10982 "in": "query" 10983 }, 10984 { 10985 "type": "array", 10986 "items": { 10987 "enum": [ 10988 "issue", 10989 "pull", 10990 "commit", 10991 "repository" 10992 ], 10993 "type": "string" 10994 }, 10995 "collectionFormat": "multi", 10996 "description": "filter notifications by subject type", 10997 "name": "subject-type", 10998 "in": "query" 10999 }, 11000 { 11001 "type": "string", 11002 "format": "date-time", 11003 "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format", 11004 "name": "since", 11005 "in": "query" 11006 }, 11007 { 11008 "type": "string", 11009 "format": "date-time", 11010 "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format", 11011 "name": "before", 11012 "in": "query" 11013 }, 11014 { 11015 "type": "integer", 11016 "description": "page number of results to return (1-based)", 11017 "name": "page", 11018 "in": "query" 11019 }, 11020 { 11021 "type": "integer", 11022 "description": "page size of results", 11023 "name": "limit", 11024 "in": "query" 11025 } 11026 ], 11027 "responses": { 11028 "200": { 11029 "$ref": "#/responses/NotificationThreadList" 11030 } 11031 } 11032 }, 11033 "put": { 11034 "consumes": [ 11035 "application/json" 11036 ], 11037 "produces": [ 11038 "application/json" 11039 ], 11040 "tags": [ 11041 "notification" 11042 ], 11043 "summary": "Mark notification threads as read, pinned or unread on a specific repo", 11044 "operationId": "notifyReadRepoList", 11045 "parameters": [ 11046 { 11047 "type": "string", 11048 "description": "owner of the repo", 11049 "name": "owner", 11050 "in": "path", 11051 "required": true 11052 }, 11053 { 11054 "type": "string", 11055 "description": "name of the repo", 11056 "name": "repo", 11057 "in": "path", 11058 "required": true 11059 }, 11060 { 11061 "type": "string", 11062 "description": "If true, mark all notifications on this repo. Default value is false", 11063 "name": "all", 11064 "in": "query" 11065 }, 11066 { 11067 "type": "array", 11068 "items": { 11069 "type": "string" 11070 }, 11071 "collectionFormat": "multi", 11072 "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.", 11073 "name": "status-types", 11074 "in": "query" 11075 }, 11076 { 11077 "type": "string", 11078 "description": "Status to mark notifications as. Defaults to read.", 11079 "name": "to-status", 11080 "in": "query" 11081 }, 11082 { 11083 "type": "string", 11084 "format": "date-time", 11085 "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.", 11086 "name": "last_read_at", 11087 "in": "query" 11088 } 11089 ], 11090 "responses": { 11091 "205": { 11092 "$ref": "#/responses/NotificationThreadList" 11093 } 11094 } 11095 } 11096 }, 11097 "/repos/{owner}/{repo}/pulls": { 11098 "get": { 11099 "produces": [ 11100 "application/json" 11101 ], 11102 "tags": [ 11103 "repository" 11104 ], 11105 "summary": "List a repo's pull requests", 11106 "operationId": "repoListPullRequests", 11107 "parameters": [ 11108 { 11109 "type": "string", 11110 "description": "owner of the repo", 11111 "name": "owner", 11112 "in": "path", 11113 "required": true 11114 }, 11115 { 11116 "type": "string", 11117 "description": "name of the repo", 11118 "name": "repo", 11119 "in": "path", 11120 "required": true 11121 }, 11122 { 11123 "enum": [ 11124 "closed", 11125 "open", 11126 "all" 11127 ], 11128 "type": "string", 11129 "description": "State of pull request: open or closed (optional)", 11130 "name": "state", 11131 "in": "query" 11132 }, 11133 { 11134 "enum": [ 11135 "oldest", 11136 "recentupdate", 11137 "leastupdate", 11138 "mostcomment", 11139 "leastcomment", 11140 "priority" 11141 ], 11142 "type": "string", 11143 "description": "Type of sort", 11144 "name": "sort", 11145 "in": "query" 11146 }, 11147 { 11148 "type": "integer", 11149 "format": "int64", 11150 "description": "ID of the milestone", 11151 "name": "milestone", 11152 "in": "query" 11153 }, 11154 { 11155 "type": "array", 11156 "items": { 11157 "type": "integer", 11158 "format": "int64" 11159 }, 11160 "collectionFormat": "multi", 11161 "description": "Label IDs", 11162 "name": "labels", 11163 "in": "query" 11164 }, 11165 { 11166 "type": "integer", 11167 "description": "page number of results to return (1-based)", 11168 "name": "page", 11169 "in": "query" 11170 }, 11171 { 11172 "type": "integer", 11173 "description": "page size of results", 11174 "name": "limit", 11175 "in": "query" 11176 } 11177 ], 11178 "responses": { 11179 "200": { 11180 "$ref": "#/responses/PullRequestList" 11181 }, 11182 "404": { 11183 "$ref": "#/responses/notFound" 11184 } 11185 } 11186 }, 11187 "post": { 11188 "consumes": [ 11189 "application/json" 11190 ], 11191 "produces": [ 11192 "application/json" 11193 ], 11194 "tags": [ 11195 "repository" 11196 ], 11197 "summary": "Create a pull request", 11198 "operationId": "repoCreatePullRequest", 11199 "parameters": [ 11200 { 11201 "type": "string", 11202 "description": "owner of the repo", 11203 "name": "owner", 11204 "in": "path", 11205 "required": true 11206 }, 11207 { 11208 "type": "string", 11209 "description": "name of the repo", 11210 "name": "repo", 11211 "in": "path", 11212 "required": true 11213 }, 11214 { 11215 "name": "body", 11216 "in": "body", 11217 "schema": { 11218 "$ref": "#/definitions/CreatePullRequestOption" 11219 } 11220 } 11221 ], 11222 "responses": { 11223 "201": { 11224 "$ref": "#/responses/PullRequest" 11225 }, 11226 "403": { 11227 "$ref": "#/responses/forbidden" 11228 }, 11229 "404": { 11230 "$ref": "#/responses/notFound" 11231 }, 11232 "409": { 11233 "$ref": "#/responses/error" 11234 }, 11235 "422": { 11236 "$ref": "#/responses/validationError" 11237 }, 11238 "423": { 11239 "$ref": "#/responses/repoArchivedError" 11240 } 11241 } 11242 } 11243 }, 11244 "/repos/{owner}/{repo}/pulls/pinned": { 11245 "get": { 11246 "produces": [ 11247 "application/json" 11248 ], 11249 "tags": [ 11250 "repository" 11251 ], 11252 "summary": "List a repo's pinned pull requests", 11253 "operationId": "repoListPinnedPullRequests", 11254 "parameters": [ 11255 { 11256 "type": "string", 11257 "description": "owner of the repo", 11258 "name": "owner", 11259 "in": "path", 11260 "required": true 11261 }, 11262 { 11263 "type": "string", 11264 "description": "name of the repo", 11265 "name": "repo", 11266 "in": "path", 11267 "required": true 11268 } 11269 ], 11270 "responses": { 11271 "200": { 11272 "$ref": "#/responses/PullRequestList" 11273 }, 11274 "404": { 11275 "$ref": "#/responses/notFound" 11276 } 11277 } 11278 } 11279 }, 11280 "/repos/{owner}/{repo}/pulls/{base}/{head}": { 11281 "get": { 11282 "produces": [ 11283 "application/json" 11284 ], 11285 "tags": [ 11286 "repository" 11287 ], 11288 "summary": "Get a pull request by base and head", 11289 "operationId": "repoGetPullRequestByBaseHead", 11290 "parameters": [ 11291 { 11292 "type": "string", 11293 "description": "owner of the repo", 11294 "name": "owner", 11295 "in": "path", 11296 "required": true 11297 }, 11298 { 11299 "type": "string", 11300 "description": "name of the repo", 11301 "name": "repo", 11302 "in": "path", 11303 "required": true 11304 }, 11305 { 11306 "type": "string", 11307 "description": "base of the pull request to get", 11308 "name": "base", 11309 "in": "path", 11310 "required": true 11311 }, 11312 { 11313 "type": "string", 11314 "description": "head of the pull request to get", 11315 "name": "head", 11316 "in": "path", 11317 "required": true 11318 } 11319 ], 11320 "responses": { 11321 "200": { 11322 "$ref": "#/responses/PullRequest" 11323 }, 11324 "404": { 11325 "$ref": "#/responses/notFound" 11326 } 11327 } 11328 } 11329 }, 11330 "/repos/{owner}/{repo}/pulls/{index}": { 11331 "get": { 11332 "produces": [ 11333 "application/json" 11334 ], 11335 "tags": [ 11336 "repository" 11337 ], 11338 "summary": "Get a pull request", 11339 "operationId": "repoGetPullRequest", 11340 "parameters": [ 11341 { 11342 "type": "string", 11343 "description": "owner of the repo", 11344 "name": "owner", 11345 "in": "path", 11346 "required": true 11347 }, 11348 { 11349 "type": "string", 11350 "description": "name of the repo", 11351 "name": "repo", 11352 "in": "path", 11353 "required": true 11354 }, 11355 { 11356 "type": "integer", 11357 "format": "int64", 11358 "description": "index of the pull request to get", 11359 "name": "index", 11360 "in": "path", 11361 "required": true 11362 } 11363 ], 11364 "responses": { 11365 "200": { 11366 "$ref": "#/responses/PullRequest" 11367 }, 11368 "404": { 11369 "$ref": "#/responses/notFound" 11370 } 11371 } 11372 }, 11373 "patch": { 11374 "consumes": [ 11375 "application/json" 11376 ], 11377 "produces": [ 11378 "application/json" 11379 ], 11380 "tags": [ 11381 "repository" 11382 ], 11383 "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.", 11384 "operationId": "repoEditPullRequest", 11385 "parameters": [ 11386 { 11387 "type": "string", 11388 "description": "owner of the repo", 11389 "name": "owner", 11390 "in": "path", 11391 "required": true 11392 }, 11393 { 11394 "type": "string", 11395 "description": "name of the repo", 11396 "name": "repo", 11397 "in": "path", 11398 "required": true 11399 }, 11400 { 11401 "type": "integer", 11402 "format": "int64", 11403 "description": "index of the pull request to edit", 11404 "name": "index", 11405 "in": "path", 11406 "required": true 11407 }, 11408 { 11409 "name": "body", 11410 "in": "body", 11411 "schema": { 11412 "$ref": "#/definitions/EditPullRequestOption" 11413 } 11414 } 11415 ], 11416 "responses": { 11417 "201": { 11418 "$ref": "#/responses/PullRequest" 11419 }, 11420 "403": { 11421 "$ref": "#/responses/forbidden" 11422 }, 11423 "404": { 11424 "$ref": "#/responses/notFound" 11425 }, 11426 "409": { 11427 "$ref": "#/responses/error" 11428 }, 11429 "412": { 11430 "$ref": "#/responses/error" 11431 }, 11432 "422": { 11433 "$ref": "#/responses/validationError" 11434 } 11435 } 11436 } 11437 }, 11438 "/repos/{owner}/{repo}/pulls/{index}.{diffType}": { 11439 "get": { 11440 "produces": [ 11441 "text/plain" 11442 ], 11443 "tags": [ 11444 "repository" 11445 ], 11446 "summary": "Get a pull request diff or patch", 11447 "operationId": "repoDownloadPullDiffOrPatch", 11448 "parameters": [ 11449 { 11450 "type": "string", 11451 "description": "owner of the repo", 11452 "name": "owner", 11453 "in": "path", 11454 "required": true 11455 }, 11456 { 11457 "type": "string", 11458 "description": "name of the repo", 11459 "name": "repo", 11460 "in": "path", 11461 "required": true 11462 }, 11463 { 11464 "type": "integer", 11465 "format": "int64", 11466 "description": "index of the pull request to get", 11467 "name": "index", 11468 "in": "path", 11469 "required": true 11470 }, 11471 { 11472 "enum": [ 11473 "diff", 11474 "patch" 11475 ], 11476 "type": "string", 11477 "description": "whether the output is diff or patch", 11478 "name": "diffType", 11479 "in": "path", 11480 "required": true 11481 }, 11482 { 11483 "type": "boolean", 11484 "description": "whether to include binary file changes. if true, the diff is applicable with `git apply`", 11485 "name": "binary", 11486 "in": "query" 11487 } 11488 ], 11489 "responses": { 11490 "200": { 11491 "$ref": "#/responses/string" 11492 }, 11493 "404": { 11494 "$ref": "#/responses/notFound" 11495 } 11496 } 11497 } 11498 }, 11499 "/repos/{owner}/{repo}/pulls/{index}/commits": { 11500 "get": { 11501 "produces": [ 11502 "application/json" 11503 ], 11504 "tags": [ 11505 "repository" 11506 ], 11507 "summary": "Get commits for a pull request", 11508 "operationId": "repoGetPullRequestCommits", 11509 "parameters": [ 11510 { 11511 "type": "string", 11512 "description": "owner of the repo", 11513 "name": "owner", 11514 "in": "path", 11515 "required": true 11516 }, 11517 { 11518 "type": "string", 11519 "description": "name of the repo", 11520 "name": "repo", 11521 "in": "path", 11522 "required": true 11523 }, 11524 { 11525 "type": "integer", 11526 "format": "int64", 11527 "description": "index of the pull request to get", 11528 "name": "index", 11529 "in": "path", 11530 "required": true 11531 }, 11532 { 11533 "type": "integer", 11534 "description": "page number of results to return (1-based)", 11535 "name": "page", 11536 "in": "query" 11537 }, 11538 { 11539 "type": "integer", 11540 "description": "page size of results", 11541 "name": "limit", 11542 "in": "query" 11543 }, 11544 { 11545 "type": "boolean", 11546 "description": "include verification for every commit (disable for speedup, default 'true')", 11547 "name": "verification", 11548 "in": "query" 11549 }, 11550 { 11551 "type": "boolean", 11552 "description": "include a list of affected files for every commit (disable for speedup, default 'true')", 11553 "name": "files", 11554 "in": "query" 11555 } 11556 ], 11557 "responses": { 11558 "200": { 11559 "$ref": "#/responses/CommitList" 11560 }, 11561 "404": { 11562 "$ref": "#/responses/notFound" 11563 } 11564 } 11565 } 11566 }, 11567 "/repos/{owner}/{repo}/pulls/{index}/files": { 11568 "get": { 11569 "produces": [ 11570 "application/json" 11571 ], 11572 "tags": [ 11573 "repository" 11574 ], 11575 "summary": "Get changed files for a pull request", 11576 "operationId": "repoGetPullRequestFiles", 11577 "parameters": [ 11578 { 11579 "type": "string", 11580 "description": "owner of the repo", 11581 "name": "owner", 11582 "in": "path", 11583 "required": true 11584 }, 11585 { 11586 "type": "string", 11587 "description": "name of the repo", 11588 "name": "repo", 11589 "in": "path", 11590 "required": true 11591 }, 11592 { 11593 "type": "integer", 11594 "format": "int64", 11595 "description": "index of the pull request to get", 11596 "name": "index", 11597 "in": "path", 11598 "required": true 11599 }, 11600 { 11601 "type": "string", 11602 "description": "skip to given file", 11603 "name": "skip-to", 11604 "in": "query" 11605 }, 11606 { 11607 "enum": [ 11608 "ignore-all", 11609 "ignore-change", 11610 "ignore-eol", 11611 "show-all" 11612 ], 11613 "type": "string", 11614 "description": "whitespace behavior", 11615 "name": "whitespace", 11616 "in": "query" 11617 }, 11618 { 11619 "type": "integer", 11620 "description": "page number of results to return (1-based)", 11621 "name": "page", 11622 "in": "query" 11623 }, 11624 { 11625 "type": "integer", 11626 "description": "page size of results", 11627 "name": "limit", 11628 "in": "query" 11629 } 11630 ], 11631 "responses": { 11632 "200": { 11633 "$ref": "#/responses/ChangedFileList" 11634 }, 11635 "404": { 11636 "$ref": "#/responses/notFound" 11637 } 11638 } 11639 } 11640 }, 11641 "/repos/{owner}/{repo}/pulls/{index}/merge": { 11642 "get": { 11643 "produces": [ 11644 "application/json" 11645 ], 11646 "tags": [ 11647 "repository" 11648 ], 11649 "summary": "Check if a pull request has been merged", 11650 "operationId": "repoPullRequestIsMerged", 11651 "parameters": [ 11652 { 11653 "type": "string", 11654 "description": "owner of the repo", 11655 "name": "owner", 11656 "in": "path", 11657 "required": true 11658 }, 11659 { 11660 "type": "string", 11661 "description": "name of the repo", 11662 "name": "repo", 11663 "in": "path", 11664 "required": true 11665 }, 11666 { 11667 "type": "integer", 11668 "format": "int64", 11669 "description": "index of the pull request", 11670 "name": "index", 11671 "in": "path", 11672 "required": true 11673 } 11674 ], 11675 "responses": { 11676 "204": { 11677 "description": "pull request has been merged" 11678 }, 11679 "404": { 11680 "description": "pull request has not been merged" 11681 } 11682 } 11683 }, 11684 "post": { 11685 "produces": [ 11686 "application/json" 11687 ], 11688 "tags": [ 11689 "repository" 11690 ], 11691 "summary": "Merge a pull request", 11692 "operationId": "repoMergePullRequest", 11693 "parameters": [ 11694 { 11695 "type": "string", 11696 "description": "owner of the repo", 11697 "name": "owner", 11698 "in": "path", 11699 "required": true 11700 }, 11701 { 11702 "type": "string", 11703 "description": "name of the repo", 11704 "name": "repo", 11705 "in": "path", 11706 "required": true 11707 }, 11708 { 11709 "type": "integer", 11710 "format": "int64", 11711 "description": "index of the pull request to merge", 11712 "name": "index", 11713 "in": "path", 11714 "required": true 11715 }, 11716 { 11717 "name": "body", 11718 "in": "body", 11719 "schema": { 11720 "$ref": "#/definitions/MergePullRequestOption" 11721 } 11722 } 11723 ], 11724 "responses": { 11725 "200": { 11726 "$ref": "#/responses/empty" 11727 }, 11728 "404": { 11729 "$ref": "#/responses/notFound" 11730 }, 11731 "405": { 11732 "$ref": "#/responses/empty" 11733 }, 11734 "409": { 11735 "$ref": "#/responses/error" 11736 }, 11737 "423": { 11738 "$ref": "#/responses/repoArchivedError" 11739 } 11740 } 11741 }, 11742 "delete": { 11743 "produces": [ 11744 "application/json" 11745 ], 11746 "tags": [ 11747 "repository" 11748 ], 11749 "summary": "Cancel the scheduled auto merge for the given pull request", 11750 "operationId": "repoCancelScheduledAutoMerge", 11751 "parameters": [ 11752 { 11753 "type": "string", 11754 "description": "owner of the repo", 11755 "name": "owner", 11756 "in": "path", 11757 "required": true 11758 }, 11759 { 11760 "type": "string", 11761 "description": "name of the repo", 11762 "name": "repo", 11763 "in": "path", 11764 "required": true 11765 }, 11766 { 11767 "type": "integer", 11768 "format": "int64", 11769 "description": "index of the pull request to merge", 11770 "name": "index", 11771 "in": "path", 11772 "required": true 11773 } 11774 ], 11775 "responses": { 11776 "204": { 11777 "$ref": "#/responses/empty" 11778 }, 11779 "403": { 11780 "$ref": "#/responses/forbidden" 11781 }, 11782 "404": { 11783 "$ref": "#/responses/notFound" 11784 }, 11785 "423": { 11786 "$ref": "#/responses/repoArchivedError" 11787 } 11788 } 11789 } 11790 }, 11791 "/repos/{owner}/{repo}/pulls/{index}/requested_reviewers": { 11792 "post": { 11793 "produces": [ 11794 "application/json" 11795 ], 11796 "tags": [ 11797 "repository" 11798 ], 11799 "summary": "create review requests for a pull request", 11800 "operationId": "repoCreatePullReviewRequests", 11801 "parameters": [ 11802 { 11803 "type": "string", 11804 "description": "owner of the repo", 11805 "name": "owner", 11806 "in": "path", 11807 "required": true 11808 }, 11809 { 11810 "type": "string", 11811 "description": "name of the repo", 11812 "name": "repo", 11813 "in": "path", 11814 "required": true 11815 }, 11816 { 11817 "type": "integer", 11818 "format": "int64", 11819 "description": "index of the pull request", 11820 "name": "index", 11821 "in": "path", 11822 "required": true 11823 }, 11824 { 11825 "name": "body", 11826 "in": "body", 11827 "required": true, 11828 "schema": { 11829 "$ref": "#/definitions/PullReviewRequestOptions" 11830 } 11831 } 11832 ], 11833 "responses": { 11834 "201": { 11835 "$ref": "#/responses/PullReviewList" 11836 }, 11837 "404": { 11838 "$ref": "#/responses/notFound" 11839 }, 11840 "422": { 11841 "$ref": "#/responses/validationError" 11842 } 11843 } 11844 }, 11845 "delete": { 11846 "produces": [ 11847 "application/json" 11848 ], 11849 "tags": [ 11850 "repository" 11851 ], 11852 "summary": "cancel review requests for a pull request", 11853 "operationId": "repoDeletePullReviewRequests", 11854 "parameters": [ 11855 { 11856 "type": "string", 11857 "description": "owner of the repo", 11858 "name": "owner", 11859 "in": "path", 11860 "required": true 11861 }, 11862 { 11863 "type": "string", 11864 "description": "name of the repo", 11865 "name": "repo", 11866 "in": "path", 11867 "required": true 11868 }, 11869 { 11870 "type": "integer", 11871 "format": "int64", 11872 "description": "index of the pull request", 11873 "name": "index", 11874 "in": "path", 11875 "required": true 11876 }, 11877 { 11878 "name": "body", 11879 "in": "body", 11880 "required": true, 11881 "schema": { 11882 "$ref": "#/definitions/PullReviewRequestOptions" 11883 } 11884 } 11885 ], 11886 "responses": { 11887 "204": { 11888 "$ref": "#/responses/empty" 11889 }, 11890 "403": { 11891 "$ref": "#/responses/forbidden" 11892 }, 11893 "404": { 11894 "$ref": "#/responses/notFound" 11895 }, 11896 "422": { 11897 "$ref": "#/responses/validationError" 11898 } 11899 } 11900 } 11901 }, 11902 "/repos/{owner}/{repo}/pulls/{index}/reviews": { 11903 "get": { 11904 "produces": [ 11905 "application/json" 11906 ], 11907 "tags": [ 11908 "repository" 11909 ], 11910 "summary": "List all reviews for a pull request", 11911 "operationId": "repoListPullReviews", 11912 "parameters": [ 11913 { 11914 "type": "string", 11915 "description": "owner of the repo", 11916 "name": "owner", 11917 "in": "path", 11918 "required": true 11919 }, 11920 { 11921 "type": "string", 11922 "description": "name of the repo", 11923 "name": "repo", 11924 "in": "path", 11925 "required": true 11926 }, 11927 { 11928 "type": "integer", 11929 "format": "int64", 11930 "description": "index of the pull request", 11931 "name": "index", 11932 "in": "path", 11933 "required": true 11934 }, 11935 { 11936 "type": "integer", 11937 "description": "page number of results to return (1-based)", 11938 "name": "page", 11939 "in": "query" 11940 }, 11941 { 11942 "type": "integer", 11943 "description": "page size of results", 11944 "name": "limit", 11945 "in": "query" 11946 } 11947 ], 11948 "responses": { 11949 "200": { 11950 "$ref": "#/responses/PullReviewList" 11951 }, 11952 "404": { 11953 "$ref": "#/responses/notFound" 11954 } 11955 } 11956 }, 11957 "post": { 11958 "produces": [ 11959 "application/json" 11960 ], 11961 "tags": [ 11962 "repository" 11963 ], 11964 "summary": "Create a review to an pull request", 11965 "operationId": "repoCreatePullReview", 11966 "parameters": [ 11967 { 11968 "type": "string", 11969 "description": "owner of the repo", 11970 "name": "owner", 11971 "in": "path", 11972 "required": true 11973 }, 11974 { 11975 "type": "string", 11976 "description": "name of the repo", 11977 "name": "repo", 11978 "in": "path", 11979 "required": true 11980 }, 11981 { 11982 "type": "integer", 11983 "format": "int64", 11984 "description": "index of the pull request", 11985 "name": "index", 11986 "in": "path", 11987 "required": true 11988 }, 11989 { 11990 "name": "body", 11991 "in": "body", 11992 "required": true, 11993 "schema": { 11994 "$ref": "#/definitions/CreatePullReviewOptions" 11995 } 11996 } 11997 ], 11998 "responses": { 11999 "200": { 12000 "$ref": "#/responses/PullReview" 12001 }, 12002 "404": { 12003 "$ref": "#/responses/notFound" 12004 }, 12005 "422": { 12006 "$ref": "#/responses/validationError" 12007 } 12008 } 12009 } 12010 }, 12011 "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}": { 12012 "get": { 12013 "produces": [ 12014 "application/json" 12015 ], 12016 "tags": [ 12017 "repository" 12018 ], 12019 "summary": "Get a specific review for a pull request", 12020 "operationId": "repoGetPullReview", 12021 "parameters": [ 12022 { 12023 "type": "string", 12024 "description": "owner of the repo", 12025 "name": "owner", 12026 "in": "path", 12027 "required": true 12028 }, 12029 { 12030 "type": "string", 12031 "description": "name of the repo", 12032 "name": "repo", 12033 "in": "path", 12034 "required": true 12035 }, 12036 { 12037 "type": "integer", 12038 "format": "int64", 12039 "description": "index of the pull request", 12040 "name": "index", 12041 "in": "path", 12042 "required": true 12043 }, 12044 { 12045 "type": "integer", 12046 "format": "int64", 12047 "description": "id of the review", 12048 "name": "id", 12049 "in": "path", 12050 "required": true 12051 } 12052 ], 12053 "responses": { 12054 "200": { 12055 "$ref": "#/responses/PullReview" 12056 }, 12057 "404": { 12058 "$ref": "#/responses/notFound" 12059 } 12060 } 12061 }, 12062 "post": { 12063 "produces": [ 12064 "application/json" 12065 ], 12066 "tags": [ 12067 "repository" 12068 ], 12069 "summary": "Submit a pending review to an pull request", 12070 "operationId": "repoSubmitPullReview", 12071 "parameters": [ 12072 { 12073 "type": "string", 12074 "description": "owner of the repo", 12075 "name": "owner", 12076 "in": "path", 12077 "required": true 12078 }, 12079 { 12080 "type": "string", 12081 "description": "name of the repo", 12082 "name": "repo", 12083 "in": "path", 12084 "required": true 12085 }, 12086 { 12087 "type": "integer", 12088 "format": "int64", 12089 "description": "index of the pull request", 12090 "name": "index", 12091 "in": "path", 12092 "required": true 12093 }, 12094 { 12095 "type": "integer", 12096 "format": "int64", 12097 "description": "id of the review", 12098 "name": "id", 12099 "in": "path", 12100 "required": true 12101 }, 12102 { 12103 "name": "body", 12104 "in": "body", 12105 "required": true, 12106 "schema": { 12107 "$ref": "#/definitions/SubmitPullReviewOptions" 12108 } 12109 } 12110 ], 12111 "responses": { 12112 "200": { 12113 "$ref": "#/responses/PullReview" 12114 }, 12115 "404": { 12116 "$ref": "#/responses/notFound" 12117 }, 12118 "422": { 12119 "$ref": "#/responses/validationError" 12120 } 12121 } 12122 }, 12123 "delete": { 12124 "produces": [ 12125 "application/json" 12126 ], 12127 "tags": [ 12128 "repository" 12129 ], 12130 "summary": "Delete a specific review from a pull request", 12131 "operationId": "repoDeletePullReview", 12132 "parameters": [ 12133 { 12134 "type": "string", 12135 "description": "owner of the repo", 12136 "name": "owner", 12137 "in": "path", 12138 "required": true 12139 }, 12140 { 12141 "type": "string", 12142 "description": "name of the repo", 12143 "name": "repo", 12144 "in": "path", 12145 "required": true 12146 }, 12147 { 12148 "type": "integer", 12149 "format": "int64", 12150 "description": "index of the pull request", 12151 "name": "index", 12152 "in": "path", 12153 "required": true 12154 }, 12155 { 12156 "type": "integer", 12157 "format": "int64", 12158 "description": "id of the review", 12159 "name": "id", 12160 "in": "path", 12161 "required": true 12162 } 12163 ], 12164 "responses": { 12165 "204": { 12166 "$ref": "#/responses/empty" 12167 }, 12168 "403": { 12169 "$ref": "#/responses/forbidden" 12170 }, 12171 "404": { 12172 "$ref": "#/responses/notFound" 12173 } 12174 } 12175 } 12176 }, 12177 "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments": { 12178 "get": { 12179 "produces": [ 12180 "application/json" 12181 ], 12182 "tags": [ 12183 "repository" 12184 ], 12185 "summary": "Get a specific review for a pull request", 12186 "operationId": "repoGetPullReviewComments", 12187 "parameters": [ 12188 { 12189 "type": "string", 12190 "description": "owner of the repo", 12191 "name": "owner", 12192 "in": "path", 12193 "required": true 12194 }, 12195 { 12196 "type": "string", 12197 "description": "name of the repo", 12198 "name": "repo", 12199 "in": "path", 12200 "required": true 12201 }, 12202 { 12203 "type": "integer", 12204 "format": "int64", 12205 "description": "index of the pull request", 12206 "name": "index", 12207 "in": "path", 12208 "required": true 12209 }, 12210 { 12211 "type": "integer", 12212 "format": "int64", 12213 "description": "id of the review", 12214 "name": "id", 12215 "in": "path", 12216 "required": true 12217 } 12218 ], 12219 "responses": { 12220 "200": { 12221 "$ref": "#/responses/PullReviewCommentList" 12222 }, 12223 "404": { 12224 "$ref": "#/responses/notFound" 12225 } 12226 } 12227 } 12228 }, 12229 "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/dismissals": { 12230 "post": { 12231 "produces": [ 12232 "application/json" 12233 ], 12234 "tags": [ 12235 "repository" 12236 ], 12237 "summary": "Dismiss a review for a pull request", 12238 "operationId": "repoDismissPullReview", 12239 "parameters": [ 12240 { 12241 "type": "string", 12242 "description": "owner of the repo", 12243 "name": "owner", 12244 "in": "path", 12245 "required": true 12246 }, 12247 { 12248 "type": "string", 12249 "description": "name of the repo", 12250 "name": "repo", 12251 "in": "path", 12252 "required": true 12253 }, 12254 { 12255 "type": "integer", 12256 "format": "int64", 12257 "description": "index of the pull request", 12258 "name": "index", 12259 "in": "path", 12260 "required": true 12261 }, 12262 { 12263 "type": "integer", 12264 "format": "int64", 12265 "description": "id of the review", 12266 "name": "id", 12267 "in": "path", 12268 "required": true 12269 }, 12270 { 12271 "name": "body", 12272 "in": "body", 12273 "required": true, 12274 "schema": { 12275 "$ref": "#/definitions/DismissPullReviewOptions" 12276 } 12277 } 12278 ], 12279 "responses": { 12280 "200": { 12281 "$ref": "#/responses/PullReview" 12282 }, 12283 "403": { 12284 "$ref": "#/responses/forbidden" 12285 }, 12286 "404": { 12287 "$ref": "#/responses/notFound" 12288 }, 12289 "422": { 12290 "$ref": "#/responses/validationError" 12291 } 12292 } 12293 } 12294 }, 12295 "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/undismissals": { 12296 "post": { 12297 "produces": [ 12298 "application/json" 12299 ], 12300 "tags": [ 12301 "repository" 12302 ], 12303 "summary": "Cancel to dismiss a review for a pull request", 12304 "operationId": "repoUnDismissPullReview", 12305 "parameters": [ 12306 { 12307 "type": "string", 12308 "description": "owner of the repo", 12309 "name": "owner", 12310 "in": "path", 12311 "required": true 12312 }, 12313 { 12314 "type": "string", 12315 "description": "name of the repo", 12316 "name": "repo", 12317 "in": "path", 12318 "required": true 12319 }, 12320 { 12321 "type": "integer", 12322 "format": "int64", 12323 "description": "index of the pull request", 12324 "name": "index", 12325 "in": "path", 12326 "required": true 12327 }, 12328 { 12329 "type": "integer", 12330 "format": "int64", 12331 "description": "id of the review", 12332 "name": "id", 12333 "in": "path", 12334 "required": true 12335 } 12336 ], 12337 "responses": { 12338 "200": { 12339 "$ref": "#/responses/PullReview" 12340 }, 12341 "403": { 12342 "$ref": "#/responses/forbidden" 12343 }, 12344 "404": { 12345 "$ref": "#/responses/notFound" 12346 }, 12347 "422": { 12348 "$ref": "#/responses/validationError" 12349 } 12350 } 12351 } 12352 }, 12353 "/repos/{owner}/{repo}/pulls/{index}/update": { 12354 "post": { 12355 "produces": [ 12356 "application/json" 12357 ], 12358 "tags": [ 12359 "repository" 12360 ], 12361 "summary": "Merge PR's baseBranch into headBranch", 12362 "operationId": "repoUpdatePullRequest", 12363 "parameters": [ 12364 { 12365 "type": "string", 12366 "description": "owner of the repo", 12367 "name": "owner", 12368 "in": "path", 12369 "required": true 12370 }, 12371 { 12372 "type": "string", 12373 "description": "name of the repo", 12374 "name": "repo", 12375 "in": "path", 12376 "required": true 12377 }, 12378 { 12379 "type": "integer", 12380 "format": "int64", 12381 "description": "index of the pull request to get", 12382 "name": "index", 12383 "in": "path", 12384 "required": true 12385 }, 12386 { 12387 "enum": [ 12388 "merge", 12389 "rebase" 12390 ], 12391 "type": "string", 12392 "description": "how to update pull request", 12393 "name": "style", 12394 "in": "query" 12395 } 12396 ], 12397 "responses": { 12398 "200": { 12399 "$ref": "#/responses/empty" 12400 }, 12401 "403": { 12402 "$ref": "#/responses/forbidden" 12403 }, 12404 "404": { 12405 "$ref": "#/responses/notFound" 12406 }, 12407 "409": { 12408 "$ref": "#/responses/error" 12409 }, 12410 "422": { 12411 "$ref": "#/responses/validationError" 12412 } 12413 } 12414 } 12415 }, 12416 "/repos/{owner}/{repo}/push_mirrors": { 12417 "get": { 12418 "produces": [ 12419 "application/json" 12420 ], 12421 "tags": [ 12422 "repository" 12423 ], 12424 "summary": "Get all push mirrors of the repository", 12425 "operationId": "repoListPushMirrors", 12426 "parameters": [ 12427 { 12428 "type": "string", 12429 "description": "owner of the repo", 12430 "name": "owner", 12431 "in": "path", 12432 "required": true 12433 }, 12434 { 12435 "type": "string", 12436 "description": "name of the repo", 12437 "name": "repo", 12438 "in": "path", 12439 "required": true 12440 }, 12441 { 12442 "type": "integer", 12443 "description": "page number of results to return (1-based)", 12444 "name": "page", 12445 "in": "query" 12446 }, 12447 { 12448 "type": "integer", 12449 "description": "page size of results", 12450 "name": "limit", 12451 "in": "query" 12452 } 12453 ], 12454 "responses": { 12455 "200": { 12456 "$ref": "#/responses/PushMirrorList" 12457 }, 12458 "400": { 12459 "$ref": "#/responses/error" 12460 }, 12461 "403": { 12462 "$ref": "#/responses/forbidden" 12463 }, 12464 "404": { 12465 "$ref": "#/responses/notFound" 12466 } 12467 } 12468 }, 12469 "post": { 12470 "consumes": [ 12471 "application/json" 12472 ], 12473 "produces": [ 12474 "application/json" 12475 ], 12476 "tags": [ 12477 "repository" 12478 ], 12479 "summary": "add a push mirror to the repository", 12480 "operationId": "repoAddPushMirror", 12481 "parameters": [ 12482 { 12483 "type": "string", 12484 "description": "owner of the repo", 12485 "name": "owner", 12486 "in": "path", 12487 "required": true 12488 }, 12489 { 12490 "type": "string", 12491 "description": "name of the repo", 12492 "name": "repo", 12493 "in": "path", 12494 "required": true 12495 }, 12496 { 12497 "name": "body", 12498 "in": "body", 12499 "schema": { 12500 "$ref": "#/definitions/CreatePushMirrorOption" 12501 } 12502 } 12503 ], 12504 "responses": { 12505 "200": { 12506 "$ref": "#/responses/PushMirror" 12507 }, 12508 "400": { 12509 "$ref": "#/responses/error" 12510 }, 12511 "403": { 12512 "$ref": "#/responses/forbidden" 12513 }, 12514 "404": { 12515 "$ref": "#/responses/notFound" 12516 } 12517 } 12518 } 12519 }, 12520 "/repos/{owner}/{repo}/push_mirrors-sync": { 12521 "post": { 12522 "produces": [ 12523 "application/json" 12524 ], 12525 "tags": [ 12526 "repository" 12527 ], 12528 "summary": "Sync all push mirrored repository", 12529 "operationId": "repoPushMirrorSync", 12530 "parameters": [ 12531 { 12532 "type": "string", 12533 "description": "owner of the repo to sync", 12534 "name": "owner", 12535 "in": "path", 12536 "required": true 12537 }, 12538 { 12539 "type": "string", 12540 "description": "name of the repo to sync", 12541 "name": "repo", 12542 "in": "path", 12543 "required": true 12544 } 12545 ], 12546 "responses": { 12547 "200": { 12548 "$ref": "#/responses/empty" 12549 }, 12550 "400": { 12551 "$ref": "#/responses/error" 12552 }, 12553 "403": { 12554 "$ref": "#/responses/forbidden" 12555 }, 12556 "404": { 12557 "$ref": "#/responses/notFound" 12558 } 12559 } 12560 } 12561 }, 12562 "/repos/{owner}/{repo}/push_mirrors/{name}": { 12563 "get": { 12564 "produces": [ 12565 "application/json" 12566 ], 12567 "tags": [ 12568 "repository" 12569 ], 12570 "summary": "Get push mirror of the repository by remoteName", 12571 "operationId": "repoGetPushMirrorByRemoteName", 12572 "parameters": [ 12573 { 12574 "type": "string", 12575 "description": "owner of the repo", 12576 "name": "owner", 12577 "in": "path", 12578 "required": true 12579 }, 12580 { 12581 "type": "string", 12582 "description": "name of the repo", 12583 "name": "repo", 12584 "in": "path", 12585 "required": true 12586 }, 12587 { 12588 "type": "string", 12589 "description": "remote name of push mirror", 12590 "name": "name", 12591 "in": "path", 12592 "required": true 12593 } 12594 ], 12595 "responses": { 12596 "200": { 12597 "$ref": "#/responses/PushMirror" 12598 }, 12599 "400": { 12600 "$ref": "#/responses/error" 12601 }, 12602 "403": { 12603 "$ref": "#/responses/forbidden" 12604 }, 12605 "404": { 12606 "$ref": "#/responses/notFound" 12607 } 12608 } 12609 }, 12610 "delete": { 12611 "produces": [ 12612 "application/json" 12613 ], 12614 "tags": [ 12615 "repository" 12616 ], 12617 "summary": "deletes a push mirror from a repository by remoteName", 12618 "operationId": "repoDeletePushMirror", 12619 "parameters": [ 12620 { 12621 "type": "string", 12622 "description": "owner of the repo", 12623 "name": "owner", 12624 "in": "path", 12625 "required": true 12626 }, 12627 { 12628 "type": "string", 12629 "description": "name of the repo", 12630 "name": "repo", 12631 "in": "path", 12632 "required": true 12633 }, 12634 { 12635 "type": "string", 12636 "description": "remote name of the pushMirror", 12637 "name": "name", 12638 "in": "path", 12639 "required": true 12640 } 12641 ], 12642 "responses": { 12643 "204": { 12644 "$ref": "#/responses/empty" 12645 }, 12646 "400": { 12647 "$ref": "#/responses/error" 12648 }, 12649 "404": { 12650 "$ref": "#/responses/notFound" 12651 } 12652 } 12653 } 12654 }, 12655 "/repos/{owner}/{repo}/raw/{filepath}": { 12656 "get": { 12657 "produces": [ 12658 "application/json" 12659 ], 12660 "tags": [ 12661 "repository" 12662 ], 12663 "summary": "Get a file from a repository", 12664 "operationId": "repoGetRawFile", 12665 "parameters": [ 12666 { 12667 "type": "string", 12668 "description": "owner of the repo", 12669 "name": "owner", 12670 "in": "path", 12671 "required": true 12672 }, 12673 { 12674 "type": "string", 12675 "description": "name of the repo", 12676 "name": "repo", 12677 "in": "path", 12678 "required": true 12679 }, 12680 { 12681 "type": "string", 12682 "description": "filepath of the file to get", 12683 "name": "filepath", 12684 "in": "path", 12685 "required": true 12686 }, 12687 { 12688 "type": "string", 12689 "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)", 12690 "name": "ref", 12691 "in": "query" 12692 } 12693 ], 12694 "responses": { 12695 "200": { 12696 "description": "Returns raw file content." 12697 }, 12698 "404": { 12699 "$ref": "#/responses/notFound" 12700 } 12701 } 12702 } 12703 }, 12704 "/repos/{owner}/{repo}/releases": { 12705 "get": { 12706 "produces": [ 12707 "application/json" 12708 ], 12709 "tags": [ 12710 "repository" 12711 ], 12712 "summary": "List a repo's releases", 12713 "operationId": "repoListReleases", 12714 "parameters": [ 12715 { 12716 "type": "string", 12717 "description": "owner of the repo", 12718 "name": "owner", 12719 "in": "path", 12720 "required": true 12721 }, 12722 { 12723 "type": "string", 12724 "description": "name of the repo", 12725 "name": "repo", 12726 "in": "path", 12727 "required": true 12728 }, 12729 { 12730 "type": "boolean", 12731 "description": "filter (exclude / include) drafts, if you dont have repo write access none will show", 12732 "name": "draft", 12733 "in": "query" 12734 }, 12735 { 12736 "type": "boolean", 12737 "description": "filter (exclude / include) pre-releases", 12738 "name": "pre-release", 12739 "in": "query" 12740 }, 12741 { 12742 "type": "integer", 12743 "description": "page number of results to return (1-based)", 12744 "name": "page", 12745 "in": "query" 12746 }, 12747 { 12748 "type": "integer", 12749 "description": "page size of results", 12750 "name": "limit", 12751 "in": "query" 12752 } 12753 ], 12754 "responses": { 12755 "200": { 12756 "$ref": "#/responses/ReleaseList" 12757 }, 12758 "404": { 12759 "$ref": "#/responses/notFound" 12760 } 12761 } 12762 }, 12763 "post": { 12764 "consumes": [ 12765 "application/json" 12766 ], 12767 "produces": [ 12768 "application/json" 12769 ], 12770 "tags": [ 12771 "repository" 12772 ], 12773 "summary": "Create a release", 12774 "operationId": "repoCreateRelease", 12775 "parameters": [ 12776 { 12777 "type": "string", 12778 "description": "owner of the repo", 12779 "name": "owner", 12780 "in": "path", 12781 "required": true 12782 }, 12783 { 12784 "type": "string", 12785 "description": "name of the repo", 12786 "name": "repo", 12787 "in": "path", 12788 "required": true 12789 }, 12790 { 12791 "name": "body", 12792 "in": "body", 12793 "schema": { 12794 "$ref": "#/definitions/CreateReleaseOption" 12795 } 12796 } 12797 ], 12798 "responses": { 12799 "201": { 12800 "$ref": "#/responses/Release" 12801 }, 12802 "404": { 12803 "$ref": "#/responses/notFound" 12804 }, 12805 "409": { 12806 "$ref": "#/responses/error" 12807 }, 12808 "422": { 12809 "$ref": "#/responses/validationError" 12810 } 12811 } 12812 } 12813 }, 12814 "/repos/{owner}/{repo}/releases/latest": { 12815 "get": { 12816 "produces": [ 12817 "application/json" 12818 ], 12819 "tags": [ 12820 "repository" 12821 ], 12822 "summary": "Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at", 12823 "operationId": "repoGetLatestRelease", 12824 "parameters": [ 12825 { 12826 "type": "string", 12827 "description": "owner of the repo", 12828 "name": "owner", 12829 "in": "path", 12830 "required": true 12831 }, 12832 { 12833 "type": "string", 12834 "description": "name of the repo", 12835 "name": "repo", 12836 "in": "path", 12837 "required": true 12838 } 12839 ], 12840 "responses": { 12841 "200": { 12842 "$ref": "#/responses/Release" 12843 }, 12844 "404": { 12845 "$ref": "#/responses/notFound" 12846 } 12847 } 12848 } 12849 }, 12850 "/repos/{owner}/{repo}/releases/tags/{tag}": { 12851 "get": { 12852 "produces": [ 12853 "application/json" 12854 ], 12855 "tags": [ 12856 "repository" 12857 ], 12858 "summary": "Get a release by tag name", 12859 "operationId": "repoGetReleaseByTag", 12860 "parameters": [ 12861 { 12862 "type": "string", 12863 "description": "owner of the repo", 12864 "name": "owner", 12865 "in": "path", 12866 "required": true 12867 }, 12868 { 12869 "type": "string", 12870 "description": "name of the repo", 12871 "name": "repo", 12872 "in": "path", 12873 "required": true 12874 }, 12875 { 12876 "type": "string", 12877 "description": "tag name of the release to get", 12878 "name": "tag", 12879 "in": "path", 12880 "required": true 12881 } 12882 ], 12883 "responses": { 12884 "200": { 12885 "$ref": "#/responses/Release" 12886 }, 12887 "404": { 12888 "$ref": "#/responses/notFound" 12889 } 12890 } 12891 }, 12892 "delete": { 12893 "tags": [ 12894 "repository" 12895 ], 12896 "summary": "Delete a release by tag name", 12897 "operationId": "repoDeleteReleaseByTag", 12898 "parameters": [ 12899 { 12900 "type": "string", 12901 "description": "owner of the repo", 12902 "name": "owner", 12903 "in": "path", 12904 "required": true 12905 }, 12906 { 12907 "type": "string", 12908 "description": "name of the repo", 12909 "name": "repo", 12910 "in": "path", 12911 "required": true 12912 }, 12913 { 12914 "type": "string", 12915 "description": "tag name of the release to delete", 12916 "name": "tag", 12917 "in": "path", 12918 "required": true 12919 } 12920 ], 12921 "responses": { 12922 "204": { 12923 "$ref": "#/responses/empty" 12924 }, 12925 "404": { 12926 "$ref": "#/responses/notFound" 12927 }, 12928 "422": { 12929 "$ref": "#/responses/validationError" 12930 } 12931 } 12932 } 12933 }, 12934 "/repos/{owner}/{repo}/releases/{id}": { 12935 "get": { 12936 "produces": [ 12937 "application/json" 12938 ], 12939 "tags": [ 12940 "repository" 12941 ], 12942 "summary": "Get a release", 12943 "operationId": "repoGetRelease", 12944 "parameters": [ 12945 { 12946 "type": "string", 12947 "description": "owner of the repo", 12948 "name": "owner", 12949 "in": "path", 12950 "required": true 12951 }, 12952 { 12953 "type": "string", 12954 "description": "name of the repo", 12955 "name": "repo", 12956 "in": "path", 12957 "required": true 12958 }, 12959 { 12960 "type": "integer", 12961 "format": "int64", 12962 "description": "id of the release to get", 12963 "name": "id", 12964 "in": "path", 12965 "required": true 12966 } 12967 ], 12968 "responses": { 12969 "200": { 12970 "$ref": "#/responses/Release" 12971 }, 12972 "404": { 12973 "$ref": "#/responses/notFound" 12974 } 12975 } 12976 }, 12977 "delete": { 12978 "tags": [ 12979 "repository" 12980 ], 12981 "summary": "Delete a release", 12982 "operationId": "repoDeleteRelease", 12983 "parameters": [ 12984 { 12985 "type": "string", 12986 "description": "owner of the repo", 12987 "name": "owner", 12988 "in": "path", 12989 "required": true 12990 }, 12991 { 12992 "type": "string", 12993 "description": "name of the repo", 12994 "name": "repo", 12995 "in": "path", 12996 "required": true 12997 }, 12998 { 12999 "type": "integer", 13000 "format": "int64", 13001 "description": "id of the release to delete", 13002 "name": "id", 13003 "in": "path", 13004 "required": true 13005 } 13006 ], 13007 "responses": { 13008 "204": { 13009 "$ref": "#/responses/empty" 13010 }, 13011 "404": { 13012 "$ref": "#/responses/notFound" 13013 }, 13014 "422": { 13015 "$ref": "#/responses/validationError" 13016 } 13017 } 13018 }, 13019 "patch": { 13020 "consumes": [ 13021 "application/json" 13022 ], 13023 "produces": [ 13024 "application/json" 13025 ], 13026 "tags": [ 13027 "repository" 13028 ], 13029 "summary": "Update a release", 13030 "operationId": "repoEditRelease", 13031 "parameters": [ 13032 { 13033 "type": "string", 13034 "description": "owner of the repo", 13035 "name": "owner", 13036 "in": "path", 13037 "required": true 13038 }, 13039 { 13040 "type": "string", 13041 "description": "name of the repo", 13042 "name": "repo", 13043 "in": "path", 13044 "required": true 13045 }, 13046 { 13047 "type": "integer", 13048 "format": "int64", 13049 "description": "id of the release to edit", 13050 "name": "id", 13051 "in": "path", 13052 "required": true 13053 }, 13054 { 13055 "name": "body", 13056 "in": "body", 13057 "schema": { 13058 "$ref": "#/definitions/EditReleaseOption" 13059 } 13060 } 13061 ], 13062 "responses": { 13063 "200": { 13064 "$ref": "#/responses/Release" 13065 }, 13066 "404": { 13067 "$ref": "#/responses/notFound" 13068 } 13069 } 13070 } 13071 }, 13072 "/repos/{owner}/{repo}/releases/{id}/assets": { 13073 "get": { 13074 "produces": [ 13075 "application/json" 13076 ], 13077 "tags": [ 13078 "repository" 13079 ], 13080 "summary": "List release's attachments", 13081 "operationId": "repoListReleaseAttachments", 13082 "parameters": [ 13083 { 13084 "type": "string", 13085 "description": "owner of the repo", 13086 "name": "owner", 13087 "in": "path", 13088 "required": true 13089 }, 13090 { 13091 "type": "string", 13092 "description": "name of the repo", 13093 "name": "repo", 13094 "in": "path", 13095 "required": true 13096 }, 13097 { 13098 "type": "integer", 13099 "format": "int64", 13100 "description": "id of the release", 13101 "name": "id", 13102 "in": "path", 13103 "required": true 13104 } 13105 ], 13106 "responses": { 13107 "200": { 13108 "$ref": "#/responses/AttachmentList" 13109 }, 13110 "404": { 13111 "$ref": "#/responses/notFound" 13112 } 13113 } 13114 }, 13115 "post": { 13116 "consumes": [ 13117 "multipart/form-data", 13118 "application/octet-stream" 13119 ], 13120 "produces": [ 13121 "application/json" 13122 ], 13123 "tags": [ 13124 "repository" 13125 ], 13126 "summary": "Create a release attachment", 13127 "operationId": "repoCreateReleaseAttachment", 13128 "parameters": [ 13129 { 13130 "type": "string", 13131 "description": "owner of the repo", 13132 "name": "owner", 13133 "in": "path", 13134 "required": true 13135 }, 13136 { 13137 "type": "string", 13138 "description": "name of the repo", 13139 "name": "repo", 13140 "in": "path", 13141 "required": true 13142 }, 13143 { 13144 "type": "integer", 13145 "format": "int64", 13146 "description": "id of the release", 13147 "name": "id", 13148 "in": "path", 13149 "required": true 13150 }, 13151 { 13152 "type": "string", 13153 "description": "name of the attachment", 13154 "name": "name", 13155 "in": "query" 13156 }, 13157 { 13158 "type": "file", 13159 "description": "attachment to upload", 13160 "name": "attachment", 13161 "in": "formData" 13162 } 13163 ], 13164 "responses": { 13165 "201": { 13166 "$ref": "#/responses/Attachment" 13167 }, 13168 "400": { 13169 "$ref": "#/responses/error" 13170 }, 13171 "404": { 13172 "$ref": "#/responses/notFound" 13173 } 13174 } 13175 } 13176 }, 13177 "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": { 13178 "get": { 13179 "produces": [ 13180 "application/json" 13181 ], 13182 "tags": [ 13183 "repository" 13184 ], 13185 "summary": "Get a release attachment", 13186 "operationId": "repoGetReleaseAttachment", 13187 "parameters": [ 13188 { 13189 "type": "string", 13190 "description": "owner of the repo", 13191 "name": "owner", 13192 "in": "path", 13193 "required": true 13194 }, 13195 { 13196 "type": "string", 13197 "description": "name of the repo", 13198 "name": "repo", 13199 "in": "path", 13200 "required": true 13201 }, 13202 { 13203 "type": "integer", 13204 "format": "int64", 13205 "description": "id of the release", 13206 "name": "id", 13207 "in": "path", 13208 "required": true 13209 }, 13210 { 13211 "type": "integer", 13212 "format": "int64", 13213 "description": "id of the attachment to get", 13214 "name": "attachment_id", 13215 "in": "path", 13216 "required": true 13217 } 13218 ], 13219 "responses": { 13220 "200": { 13221 "$ref": "#/responses/Attachment" 13222 }, 13223 "404": { 13224 "$ref": "#/responses/notFound" 13225 } 13226 } 13227 }, 13228 "delete": { 13229 "produces": [ 13230 "application/json" 13231 ], 13232 "tags": [ 13233 "repository" 13234 ], 13235 "summary": "Delete a release attachment", 13236 "operationId": "repoDeleteReleaseAttachment", 13237 "parameters": [ 13238 { 13239 "type": "string", 13240 "description": "owner of the repo", 13241 "name": "owner", 13242 "in": "path", 13243 "required": true 13244 }, 13245 { 13246 "type": "string", 13247 "description": "name of the repo", 13248 "name": "repo", 13249 "in": "path", 13250 "required": true 13251 }, 13252 { 13253 "type": "integer", 13254 "format": "int64", 13255 "description": "id of the release", 13256 "name": "id", 13257 "in": "path", 13258 "required": true 13259 }, 13260 { 13261 "type": "integer", 13262 "format": "int64", 13263 "description": "id of the attachment to delete", 13264 "name": "attachment_id", 13265 "in": "path", 13266 "required": true 13267 } 13268 ], 13269 "responses": { 13270 "204": { 13271 "$ref": "#/responses/empty" 13272 }, 13273 "404": { 13274 "$ref": "#/responses/notFound" 13275 } 13276 } 13277 }, 13278 "patch": { 13279 "consumes": [ 13280 "application/json" 13281 ], 13282 "produces": [ 13283 "application/json" 13284 ], 13285 "tags": [ 13286 "repository" 13287 ], 13288 "summary": "Edit a release attachment", 13289 "operationId": "repoEditReleaseAttachment", 13290 "parameters": [ 13291 { 13292 "type": "string", 13293 "description": "owner of the repo", 13294 "name": "owner", 13295 "in": "path", 13296 "required": true 13297 }, 13298 { 13299 "type": "string", 13300 "description": "name of the repo", 13301 "name": "repo", 13302 "in": "path", 13303 "required": true 13304 }, 13305 { 13306 "type": "integer", 13307 "format": "int64", 13308 "description": "id of the release", 13309 "name": "id", 13310 "in": "path", 13311 "required": true 13312 }, 13313 { 13314 "type": "integer", 13315 "format": "int64", 13316 "description": "id of the attachment to edit", 13317 "name": "attachment_id", 13318 "in": "path", 13319 "required": true 13320 }, 13321 { 13322 "name": "body", 13323 "in": "body", 13324 "schema": { 13325 "$ref": "#/definitions/EditAttachmentOptions" 13326 } 13327 } 13328 ], 13329 "responses": { 13330 "201": { 13331 "$ref": "#/responses/Attachment" 13332 }, 13333 "404": { 13334 "$ref": "#/responses/notFound" 13335 } 13336 } 13337 } 13338 }, 13339 "/repos/{owner}/{repo}/reviewers": { 13340 "get": { 13341 "produces": [ 13342 "application/json" 13343 ], 13344 "tags": [ 13345 "repository" 13346 ], 13347 "summary": "Return all users that can be requested to review in this repo", 13348 "operationId": "repoGetReviewers", 13349 "parameters": [ 13350 { 13351 "type": "string", 13352 "description": "owner of the repo", 13353 "name": "owner", 13354 "in": "path", 13355 "required": true 13356 }, 13357 { 13358 "type": "string", 13359 "description": "name of the repo", 13360 "name": "repo", 13361 "in": "path", 13362 "required": true 13363 } 13364 ], 13365 "responses": { 13366 "200": { 13367 "$ref": "#/responses/UserList" 13368 }, 13369 "404": { 13370 "$ref": "#/responses/notFound" 13371 } 13372 } 13373 } 13374 }, 13375 "/repos/{owner}/{repo}/signing-key.gpg": { 13376 "get": { 13377 "produces": [ 13378 "text/plain" 13379 ], 13380 "tags": [ 13381 "repository" 13382 ], 13383 "summary": "Get signing-key.gpg for given repository", 13384 "operationId": "repoSigningKey", 13385 "parameters": [ 13386 { 13387 "type": "string", 13388 "description": "owner of the repo", 13389 "name": "owner", 13390 "in": "path", 13391 "required": true 13392 }, 13393 { 13394 "type": "string", 13395 "description": "name of the repo", 13396 "name": "repo", 13397 "in": "path", 13398 "required": true 13399 } 13400 ], 13401 "responses": { 13402 "200": { 13403 "description": "GPG armored public key", 13404 "schema": { 13405 "type": "string" 13406 } 13407 } 13408 } 13409 } 13410 }, 13411 "/repos/{owner}/{repo}/stargazers": { 13412 "get": { 13413 "produces": [ 13414 "application/json" 13415 ], 13416 "tags": [ 13417 "repository" 13418 ], 13419 "summary": "List a repo's stargazers", 13420 "operationId": "repoListStargazers", 13421 "parameters": [ 13422 { 13423 "type": "string", 13424 "description": "owner of the repo", 13425 "name": "owner", 13426 "in": "path", 13427 "required": true 13428 }, 13429 { 13430 "type": "string", 13431 "description": "name of the repo", 13432 "name": "repo", 13433 "in": "path", 13434 "required": true 13435 }, 13436 { 13437 "type": "integer", 13438 "description": "page number of results to return (1-based)", 13439 "name": "page", 13440 "in": "query" 13441 }, 13442 { 13443 "type": "integer", 13444 "description": "page size of results", 13445 "name": "limit", 13446 "in": "query" 13447 } 13448 ], 13449 "responses": { 13450 "200": { 13451 "$ref": "#/responses/UserList" 13452 }, 13453 "404": { 13454 "$ref": "#/responses/notFound" 13455 } 13456 } 13457 } 13458 }, 13459 "/repos/{owner}/{repo}/statuses/{sha}": { 13460 "get": { 13461 "produces": [ 13462 "application/json" 13463 ], 13464 "tags": [ 13465 "repository" 13466 ], 13467 "summary": "Get a commit's statuses", 13468 "operationId": "repoListStatuses", 13469 "parameters": [ 13470 { 13471 "type": "string", 13472 "description": "owner of the repo", 13473 "name": "owner", 13474 "in": "path", 13475 "required": true 13476 }, 13477 { 13478 "type": "string", 13479 "description": "name of the repo", 13480 "name": "repo", 13481 "in": "path", 13482 "required": true 13483 }, 13484 { 13485 "type": "string", 13486 "description": "sha of the commit", 13487 "name": "sha", 13488 "in": "path", 13489 "required": true 13490 }, 13491 { 13492 "enum": [ 13493 "oldest", 13494 "recentupdate", 13495 "leastupdate", 13496 "leastindex", 13497 "highestindex" 13498 ], 13499 "type": "string", 13500 "description": "type of sort", 13501 "name": "sort", 13502 "in": "query" 13503 }, 13504 { 13505 "enum": [ 13506 "pending", 13507 "success", 13508 "error", 13509 "failure", 13510 "warning" 13511 ], 13512 "type": "string", 13513 "description": "type of state", 13514 "name": "state", 13515 "in": "query" 13516 }, 13517 { 13518 "type": "integer", 13519 "description": "page number of results to return (1-based)", 13520 "name": "page", 13521 "in": "query" 13522 }, 13523 { 13524 "type": "integer", 13525 "description": "page size of results", 13526 "name": "limit", 13527 "in": "query" 13528 } 13529 ], 13530 "responses": { 13531 "200": { 13532 "$ref": "#/responses/CommitStatusList" 13533 }, 13534 "400": { 13535 "$ref": "#/responses/error" 13536 }, 13537 "404": { 13538 "$ref": "#/responses/notFound" 13539 } 13540 } 13541 }, 13542 "post": { 13543 "produces": [ 13544 "application/json" 13545 ], 13546 "tags": [ 13547 "repository" 13548 ], 13549 "summary": "Create a commit status", 13550 "operationId": "repoCreateStatus", 13551 "parameters": [ 13552 { 13553 "type": "string", 13554 "description": "owner of the repo", 13555 "name": "owner", 13556 "in": "path", 13557 "required": true 13558 }, 13559 { 13560 "type": "string", 13561 "description": "name of the repo", 13562 "name": "repo", 13563 "in": "path", 13564 "required": true 13565 }, 13566 { 13567 "type": "string", 13568 "description": "sha of the commit", 13569 "name": "sha", 13570 "in": "path", 13571 "required": true 13572 }, 13573 { 13574 "name": "body", 13575 "in": "body", 13576 "schema": { 13577 "$ref": "#/definitions/CreateStatusOption" 13578 } 13579 } 13580 ], 13581 "responses": { 13582 "201": { 13583 "$ref": "#/responses/CommitStatus" 13584 }, 13585 "400": { 13586 "$ref": "#/responses/error" 13587 }, 13588 "404": { 13589 "$ref": "#/responses/notFound" 13590 } 13591 } 13592 } 13593 }, 13594 "/repos/{owner}/{repo}/subscribers": { 13595 "get": { 13596 "produces": [ 13597 "application/json" 13598 ], 13599 "tags": [ 13600 "repository" 13601 ], 13602 "summary": "List a repo's watchers", 13603 "operationId": "repoListSubscribers", 13604 "parameters": [ 13605 { 13606 "type": "string", 13607 "description": "owner of the repo", 13608 "name": "owner", 13609 "in": "path", 13610 "required": true 13611 }, 13612 { 13613 "type": "string", 13614 "description": "name of the repo", 13615 "name": "repo", 13616 "in": "path", 13617 "required": true 13618 }, 13619 { 13620 "type": "integer", 13621 "description": "page number of results to return (1-based)", 13622 "name": "page", 13623 "in": "query" 13624 }, 13625 { 13626 "type": "integer", 13627 "description": "page size of results", 13628 "name": "limit", 13629 "in": "query" 13630 } 13631 ], 13632 "responses": { 13633 "200": { 13634 "$ref": "#/responses/UserList" 13635 }, 13636 "404": { 13637 "$ref": "#/responses/notFound" 13638 } 13639 } 13640 } 13641 }, 13642 "/repos/{owner}/{repo}/subscription": { 13643 "get": { 13644 "tags": [ 13645 "repository" 13646 ], 13647 "summary": "Check if the current user is watching a repo", 13648 "operationId": "userCurrentCheckSubscription", 13649 "parameters": [ 13650 { 13651 "type": "string", 13652 "description": "owner of the repo", 13653 "name": "owner", 13654 "in": "path", 13655 "required": true 13656 }, 13657 { 13658 "type": "string", 13659 "description": "name of the repo", 13660 "name": "repo", 13661 "in": "path", 13662 "required": true 13663 } 13664 ], 13665 "responses": { 13666 "200": { 13667 "$ref": "#/responses/WatchInfo" 13668 }, 13669 "404": { 13670 "description": "User is not watching this repo or repo do not exist" 13671 } 13672 } 13673 }, 13674 "put": { 13675 "tags": [ 13676 "repository" 13677 ], 13678 "summary": "Watch a repo", 13679 "operationId": "userCurrentPutSubscription", 13680 "parameters": [ 13681 { 13682 "type": "string", 13683 "description": "owner of the repo", 13684 "name": "owner", 13685 "in": "path", 13686 "required": true 13687 }, 13688 { 13689 "type": "string", 13690 "description": "name of the repo", 13691 "name": "repo", 13692 "in": "path", 13693 "required": true 13694 } 13695 ], 13696 "responses": { 13697 "200": { 13698 "$ref": "#/responses/WatchInfo" 13699 }, 13700 "403": { 13701 "$ref": "#/responses/forbidden" 13702 }, 13703 "404": { 13704 "$ref": "#/responses/notFound" 13705 } 13706 } 13707 }, 13708 "delete": { 13709 "tags": [ 13710 "repository" 13711 ], 13712 "summary": "Unwatch a repo", 13713 "operationId": "userCurrentDeleteSubscription", 13714 "parameters": [ 13715 { 13716 "type": "string", 13717 "description": "owner of the repo", 13718 "name": "owner", 13719 "in": "path", 13720 "required": true 13721 }, 13722 { 13723 "type": "string", 13724 "description": "name of the repo", 13725 "name": "repo", 13726 "in": "path", 13727 "required": true 13728 } 13729 ], 13730 "responses": { 13731 "204": { 13732 "$ref": "#/responses/empty" 13733 }, 13734 "404": { 13735 "$ref": "#/responses/notFound" 13736 } 13737 } 13738 } 13739 }, 13740 "/repos/{owner}/{repo}/tags": { 13741 "get": { 13742 "produces": [ 13743 "application/json" 13744 ], 13745 "tags": [ 13746 "repository" 13747 ], 13748 "summary": "List a repository's tags", 13749 "operationId": "repoListTags", 13750 "parameters": [ 13751 { 13752 "type": "string", 13753 "description": "owner of the repo", 13754 "name": "owner", 13755 "in": "path", 13756 "required": true 13757 }, 13758 { 13759 "type": "string", 13760 "description": "name of the repo", 13761 "name": "repo", 13762 "in": "path", 13763 "required": true 13764 }, 13765 { 13766 "type": "integer", 13767 "description": "page number of results to return (1-based)", 13768 "name": "page", 13769 "in": "query" 13770 }, 13771 { 13772 "type": "integer", 13773 "description": "page size of results, default maximum page size is 50", 13774 "name": "limit", 13775 "in": "query" 13776 } 13777 ], 13778 "responses": { 13779 "200": { 13780 "$ref": "#/responses/TagList" 13781 }, 13782 "404": { 13783 "$ref": "#/responses/notFound" 13784 } 13785 } 13786 }, 13787 "post": { 13788 "produces": [ 13789 "application/json" 13790 ], 13791 "tags": [ 13792 "repository" 13793 ], 13794 "summary": "Create a new git tag in a repository", 13795 "operationId": "repoCreateTag", 13796 "parameters": [ 13797 { 13798 "type": "string", 13799 "description": "owner of the repo", 13800 "name": "owner", 13801 "in": "path", 13802 "required": true 13803 }, 13804 { 13805 "type": "string", 13806 "description": "name of the repo", 13807 "name": "repo", 13808 "in": "path", 13809 "required": true 13810 }, 13811 { 13812 "name": "body", 13813 "in": "body", 13814 "schema": { 13815 "$ref": "#/definitions/CreateTagOption" 13816 } 13817 } 13818 ], 13819 "responses": { 13820 "200": { 13821 "$ref": "#/responses/Tag" 13822 }, 13823 "404": { 13824 "$ref": "#/responses/notFound" 13825 }, 13826 "405": { 13827 "$ref": "#/responses/empty" 13828 }, 13829 "409": { 13830 "$ref": "#/responses/conflict" 13831 }, 13832 "422": { 13833 "$ref": "#/responses/validationError" 13834 }, 13835 "423": { 13836 "$ref": "#/responses/repoArchivedError" 13837 } 13838 } 13839 } 13840 }, 13841 "/repos/{owner}/{repo}/tags/{tag}": { 13842 "get": { 13843 "produces": [ 13844 "application/json" 13845 ], 13846 "tags": [ 13847 "repository" 13848 ], 13849 "summary": "Get the tag of a repository by tag name", 13850 "operationId": "repoGetTag", 13851 "parameters": [ 13852 { 13853 "type": "string", 13854 "description": "owner of the repo", 13855 "name": "owner", 13856 "in": "path", 13857 "required": true 13858 }, 13859 { 13860 "type": "string", 13861 "description": "name of the repo", 13862 "name": "repo", 13863 "in": "path", 13864 "required": true 13865 }, 13866 { 13867 "type": "string", 13868 "description": "name of tag", 13869 "name": "tag", 13870 "in": "path", 13871 "required": true 13872 } 13873 ], 13874 "responses": { 13875 "200": { 13876 "$ref": "#/responses/Tag" 13877 }, 13878 "404": { 13879 "$ref": "#/responses/notFound" 13880 } 13881 } 13882 }, 13883 "delete": { 13884 "produces": [ 13885 "application/json" 13886 ], 13887 "tags": [ 13888 "repository" 13889 ], 13890 "summary": "Delete a repository's tag by name", 13891 "operationId": "repoDeleteTag", 13892 "parameters": [ 13893 { 13894 "type": "string", 13895 "description": "owner of the repo", 13896 "name": "owner", 13897 "in": "path", 13898 "required": true 13899 }, 13900 { 13901 "type": "string", 13902 "description": "name of the repo", 13903 "name": "repo", 13904 "in": "path", 13905 "required": true 13906 }, 13907 { 13908 "type": "string", 13909 "description": "name of tag to delete", 13910 "name": "tag", 13911 "in": "path", 13912 "required": true 13913 } 13914 ], 13915 "responses": { 13916 "204": { 13917 "$ref": "#/responses/empty" 13918 }, 13919 "404": { 13920 "$ref": "#/responses/notFound" 13921 }, 13922 "405": { 13923 "$ref": "#/responses/empty" 13924 }, 13925 "409": { 13926 "$ref": "#/responses/conflict" 13927 }, 13928 "422": { 13929 "$ref": "#/responses/validationError" 13930 }, 13931 "423": { 13932 "$ref": "#/responses/repoArchivedError" 13933 } 13934 } 13935 } 13936 }, 13937 "/repos/{owner}/{repo}/teams": { 13938 "get": { 13939 "produces": [ 13940 "application/json" 13941 ], 13942 "tags": [ 13943 "repository" 13944 ], 13945 "summary": "List a repository's teams", 13946 "operationId": "repoListTeams", 13947 "parameters": [ 13948 { 13949 "type": "string", 13950 "description": "owner of the repo", 13951 "name": "owner", 13952 "in": "path", 13953 "required": true 13954 }, 13955 { 13956 "type": "string", 13957 "description": "name of the repo", 13958 "name": "repo", 13959 "in": "path", 13960 "required": true 13961 } 13962 ], 13963 "responses": { 13964 "200": { 13965 "$ref": "#/responses/TeamList" 13966 }, 13967 "404": { 13968 "$ref": "#/responses/notFound" 13969 } 13970 } 13971 } 13972 }, 13973 "/repos/{owner}/{repo}/teams/{team}": { 13974 "get": { 13975 "produces": [ 13976 "application/json" 13977 ], 13978 "tags": [ 13979 "repository" 13980 ], 13981 "summary": "Check if a team is assigned to a repository", 13982 "operationId": "repoCheckTeam", 13983 "parameters": [ 13984 { 13985 "type": "string", 13986 "description": "owner of the repo", 13987 "name": "owner", 13988 "in": "path", 13989 "required": true 13990 }, 13991 { 13992 "type": "string", 13993 "description": "name of the repo", 13994 "name": "repo", 13995 "in": "path", 13996 "required": true 13997 }, 13998 { 13999 "type": "string", 14000 "description": "team name", 14001 "name": "team", 14002 "in": "path", 14003 "required": true 14004 } 14005 ], 14006 "responses": { 14007 "200": { 14008 "$ref": "#/responses/Team" 14009 }, 14010 "404": { 14011 "$ref": "#/responses/notFound" 14012 }, 14013 "405": { 14014 "$ref": "#/responses/error" 14015 } 14016 } 14017 }, 14018 "put": { 14019 "produces": [ 14020 "application/json" 14021 ], 14022 "tags": [ 14023 "repository" 14024 ], 14025 "summary": "Add a team to a repository", 14026 "operationId": "repoAddTeam", 14027 "parameters": [ 14028 { 14029 "type": "string", 14030 "description": "owner of the repo", 14031 "name": "owner", 14032 "in": "path", 14033 "required": true 14034 }, 14035 { 14036 "type": "string", 14037 "description": "name of the repo", 14038 "name": "repo", 14039 "in": "path", 14040 "required": true 14041 }, 14042 { 14043 "type": "string", 14044 "description": "team name", 14045 "name": "team", 14046 "in": "path", 14047 "required": true 14048 } 14049 ], 14050 "responses": { 14051 "204": { 14052 "$ref": "#/responses/empty" 14053 }, 14054 "404": { 14055 "$ref": "#/responses/notFound" 14056 }, 14057 "405": { 14058 "$ref": "#/responses/error" 14059 }, 14060 "422": { 14061 "$ref": "#/responses/validationError" 14062 } 14063 } 14064 }, 14065 "delete": { 14066 "produces": [ 14067 "application/json" 14068 ], 14069 "tags": [ 14070 "repository" 14071 ], 14072 "summary": "Delete a team from a repository", 14073 "operationId": "repoDeleteTeam", 14074 "parameters": [ 14075 { 14076 "type": "string", 14077 "description": "owner of the repo", 14078 "name": "owner", 14079 "in": "path", 14080 "required": true 14081 }, 14082 { 14083 "type": "string", 14084 "description": "name of the repo", 14085 "name": "repo", 14086 "in": "path", 14087 "required": true 14088 }, 14089 { 14090 "type": "string", 14091 "description": "team name", 14092 "name": "team", 14093 "in": "path", 14094 "required": true 14095 } 14096 ], 14097 "responses": { 14098 "204": { 14099 "$ref": "#/responses/empty" 14100 }, 14101 "404": { 14102 "$ref": "#/responses/notFound" 14103 }, 14104 "405": { 14105 "$ref": "#/responses/error" 14106 }, 14107 "422": { 14108 "$ref": "#/responses/validationError" 14109 } 14110 } 14111 } 14112 }, 14113 "/repos/{owner}/{repo}/times": { 14114 "get": { 14115 "produces": [ 14116 "application/json" 14117 ], 14118 "tags": [ 14119 "repository" 14120 ], 14121 "summary": "List a repo's tracked times", 14122 "operationId": "repoTrackedTimes", 14123 "parameters": [ 14124 { 14125 "type": "string", 14126 "description": "owner of the repo", 14127 "name": "owner", 14128 "in": "path", 14129 "required": true 14130 }, 14131 { 14132 "type": "string", 14133 "description": "name of the repo", 14134 "name": "repo", 14135 "in": "path", 14136 "required": true 14137 }, 14138 { 14139 "type": "string", 14140 "description": "optional filter by user (available for issue managers)", 14141 "name": "user", 14142 "in": "query" 14143 }, 14144 { 14145 "type": "string", 14146 "format": "date-time", 14147 "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format", 14148 "name": "since", 14149 "in": "query" 14150 }, 14151 { 14152 "type": "string", 14153 "format": "date-time", 14154 "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format", 14155 "name": "before", 14156 "in": "query" 14157 }, 14158 { 14159 "type": "integer", 14160 "description": "page number of results to return (1-based)", 14161 "name": "page", 14162 "in": "query" 14163 }, 14164 { 14165 "type": "integer", 14166 "description": "page size of results", 14167 "name": "limit", 14168 "in": "query" 14169 } 14170 ], 14171 "responses": { 14172 "200": { 14173 "$ref": "#/responses/TrackedTimeList" 14174 }, 14175 "400": { 14176 "$ref": "#/responses/error" 14177 }, 14178 "403": { 14179 "$ref": "#/responses/forbidden" 14180 }, 14181 "404": { 14182 "$ref": "#/responses/notFound" 14183 } 14184 } 14185 } 14186 }, 14187 "/repos/{owner}/{repo}/times/{user}": { 14188 "get": { 14189 "produces": [ 14190 "application/json" 14191 ], 14192 "tags": [ 14193 "repository" 14194 ], 14195 "summary": "List a user's tracked times in a repo", 14196 "operationId": "userTrackedTimes", 14197 "deprecated": true, 14198 "parameters": [ 14199 { 14200 "type": "string", 14201 "description": "owner of the repo", 14202 "name": "owner", 14203 "in": "path", 14204 "required": true 14205 }, 14206 { 14207 "type": "string", 14208 "description": "name of the repo", 14209 "name": "repo", 14210 "in": "path", 14211 "required": true 14212 }, 14213 { 14214 "type": "string", 14215 "description": "username of user", 14216 "name": "user", 14217 "in": "path", 14218 "required": true 14219 } 14220 ], 14221 "responses": { 14222 "200": { 14223 "$ref": "#/responses/TrackedTimeList" 14224 }, 14225 "400": { 14226 "$ref": "#/responses/error" 14227 }, 14228 "403": { 14229 "$ref": "#/responses/forbidden" 14230 }, 14231 "404": { 14232 "$ref": "#/responses/notFound" 14233 } 14234 } 14235 } 14236 }, 14237 "/repos/{owner}/{repo}/topics": { 14238 "get": { 14239 "produces": [ 14240 "application/json" 14241 ], 14242 "tags": [ 14243 "repository" 14244 ], 14245 "summary": "Get list of topics that a repository has", 14246 "operationId": "repoListTopics", 14247 "parameters": [ 14248 { 14249 "type": "string", 14250 "description": "owner of the repo", 14251 "name": "owner", 14252 "in": "path", 14253 "required": true 14254 }, 14255 { 14256 "type": "string", 14257 "description": "name of the repo", 14258 "name": "repo", 14259 "in": "path", 14260 "required": true 14261 }, 14262 { 14263 "type": "integer", 14264 "description": "page number of results to return (1-based)", 14265 "name": "page", 14266 "in": "query" 14267 }, 14268 { 14269 "type": "integer", 14270 "description": "page size of results", 14271 "name": "limit", 14272 "in": "query" 14273 } 14274 ], 14275 "responses": { 14276 "200": { 14277 "$ref": "#/responses/TopicNames" 14278 }, 14279 "404": { 14280 "$ref": "#/responses/notFound" 14281 } 14282 } 14283 }, 14284 "put": { 14285 "produces": [ 14286 "application/json" 14287 ], 14288 "tags": [ 14289 "repository" 14290 ], 14291 "summary": "Replace list of topics for a repository", 14292 "operationId": "repoUpdateTopics", 14293 "parameters": [ 14294 { 14295 "type": "string", 14296 "description": "owner of the repo", 14297 "name": "owner", 14298 "in": "path", 14299 "required": true 14300 }, 14301 { 14302 "type": "string", 14303 "description": "name of the repo", 14304 "name": "repo", 14305 "in": "path", 14306 "required": true 14307 }, 14308 { 14309 "name": "body", 14310 "in": "body", 14311 "schema": { 14312 "$ref": "#/definitions/RepoTopicOptions" 14313 } 14314 } 14315 ], 14316 "responses": { 14317 "204": { 14318 "$ref": "#/responses/empty" 14319 }, 14320 "404": { 14321 "$ref": "#/responses/notFound" 14322 }, 14323 "422": { 14324 "$ref": "#/responses/invalidTopicsError" 14325 } 14326 } 14327 } 14328 }, 14329 "/repos/{owner}/{repo}/topics/{topic}": { 14330 "put": { 14331 "produces": [ 14332 "application/json" 14333 ], 14334 "tags": [ 14335 "repository" 14336 ], 14337 "summary": "Add a topic to a repository", 14338 "operationId": "repoAddTopic", 14339 "parameters": [ 14340 { 14341 "type": "string", 14342 "description": "owner of the repo", 14343 "name": "owner", 14344 "in": "path", 14345 "required": true 14346 }, 14347 { 14348 "type": "string", 14349 "description": "name of the repo", 14350 "name": "repo", 14351 "in": "path", 14352 "required": true 14353 }, 14354 { 14355 "type": "string", 14356 "description": "name of the topic to add", 14357 "name": "topic", 14358 "in": "path", 14359 "required": true 14360 } 14361 ], 14362 "responses": { 14363 "204": { 14364 "$ref": "#/responses/empty" 14365 }, 14366 "404": { 14367 "$ref": "#/responses/notFound" 14368 }, 14369 "422": { 14370 "$ref": "#/responses/invalidTopicsError" 14371 } 14372 } 14373 }, 14374 "delete": { 14375 "produces": [ 14376 "application/json" 14377 ], 14378 "tags": [ 14379 "repository" 14380 ], 14381 "summary": "Delete a topic from a repository", 14382 "operationId": "repoDeleteTopic", 14383 "parameters": [ 14384 { 14385 "type": "string", 14386 "description": "owner of the repo", 14387 "name": "owner", 14388 "in": "path", 14389 "required": true 14390 }, 14391 { 14392 "type": "string", 14393 "description": "name of the repo", 14394 "name": "repo", 14395 "in": "path", 14396 "required": true 14397 }, 14398 { 14399 "type": "string", 14400 "description": "name of the topic to delete", 14401 "name": "topic", 14402 "in": "path", 14403 "required": true 14404 } 14405 ], 14406 "responses": { 14407 "204": { 14408 "$ref": "#/responses/empty" 14409 }, 14410 "404": { 14411 "$ref": "#/responses/notFound" 14412 }, 14413 "422": { 14414 "$ref": "#/responses/invalidTopicsError" 14415 } 14416 } 14417 } 14418 }, 14419 "/repos/{owner}/{repo}/transfer": { 14420 "post": { 14421 "produces": [ 14422 "application/json" 14423 ], 14424 "tags": [ 14425 "repository" 14426 ], 14427 "summary": "Transfer a repo ownership", 14428 "operationId": "repoTransfer", 14429 "parameters": [ 14430 { 14431 "type": "string", 14432 "description": "owner of the repo to transfer", 14433 "name": "owner", 14434 "in": "path", 14435 "required": true 14436 }, 14437 { 14438 "type": "string", 14439 "description": "name of the repo to transfer", 14440 "name": "repo", 14441 "in": "path", 14442 "required": true 14443 }, 14444 { 14445 "description": "Transfer Options", 14446 "name": "body", 14447 "in": "body", 14448 "required": true, 14449 "schema": { 14450 "$ref": "#/definitions/TransferRepoOption" 14451 } 14452 } 14453 ], 14454 "responses": { 14455 "202": { 14456 "$ref": "#/responses/Repository" 14457 }, 14458 "403": { 14459 "$ref": "#/responses/forbidden" 14460 }, 14461 "404": { 14462 "$ref": "#/responses/notFound" 14463 }, 14464 "422": { 14465 "$ref": "#/responses/validationError" 14466 } 14467 } 14468 } 14469 }, 14470 "/repos/{owner}/{repo}/transfer/accept": { 14471 "post": { 14472 "produces": [ 14473 "application/json" 14474 ], 14475 "tags": [ 14476 "repository" 14477 ], 14478 "summary": "Accept a repo transfer", 14479 "operationId": "acceptRepoTransfer", 14480 "parameters": [ 14481 { 14482 "type": "string", 14483 "description": "owner of the repo to transfer", 14484 "name": "owner", 14485 "in": "path", 14486 "required": true 14487 }, 14488 { 14489 "type": "string", 14490 "description": "name of the repo to transfer", 14491 "name": "repo", 14492 "in": "path", 14493 "required": true 14494 } 14495 ], 14496 "responses": { 14497 "202": { 14498 "$ref": "#/responses/Repository" 14499 }, 14500 "403": { 14501 "$ref": "#/responses/forbidden" 14502 }, 14503 "404": { 14504 "$ref": "#/responses/notFound" 14505 } 14506 } 14507 } 14508 }, 14509 "/repos/{owner}/{repo}/transfer/reject": { 14510 "post": { 14511 "produces": [ 14512 "application/json" 14513 ], 14514 "tags": [ 14515 "repository" 14516 ], 14517 "summary": "Reject a repo transfer", 14518 "operationId": "rejectRepoTransfer", 14519 "parameters": [ 14520 { 14521 "type": "string", 14522 "description": "owner of the repo to transfer", 14523 "name": "owner", 14524 "in": "path", 14525 "required": true 14526 }, 14527 { 14528 "type": "string", 14529 "description": "name of the repo to transfer", 14530 "name": "repo", 14531 "in": "path", 14532 "required": true 14533 } 14534 ], 14535 "responses": { 14536 "200": { 14537 "$ref": "#/responses/Repository" 14538 }, 14539 "403": { 14540 "$ref": "#/responses/forbidden" 14541 }, 14542 "404": { 14543 "$ref": "#/responses/notFound" 14544 } 14545 } 14546 } 14547 }, 14548 "/repos/{owner}/{repo}/wiki/new": { 14549 "post": { 14550 "consumes": [ 14551 "application/json" 14552 ], 14553 "tags": [ 14554 "repository" 14555 ], 14556 "summary": "Create a wiki page", 14557 "operationId": "repoCreateWikiPage", 14558 "parameters": [ 14559 { 14560 "type": "string", 14561 "description": "owner of the repo", 14562 "name": "owner", 14563 "in": "path", 14564 "required": true 14565 }, 14566 { 14567 "type": "string", 14568 "description": "name of the repo", 14569 "name": "repo", 14570 "in": "path", 14571 "required": true 14572 }, 14573 { 14574 "name": "body", 14575 "in": "body", 14576 "schema": { 14577 "$ref": "#/definitions/CreateWikiPageOptions" 14578 } 14579 } 14580 ], 14581 "responses": { 14582 "201": { 14583 "$ref": "#/responses/WikiPage" 14584 }, 14585 "400": { 14586 "$ref": "#/responses/error" 14587 }, 14588 "403": { 14589 "$ref": "#/responses/forbidden" 14590 }, 14591 "404": { 14592 "$ref": "#/responses/notFound" 14593 }, 14594 "423": { 14595 "$ref": "#/responses/repoArchivedError" 14596 } 14597 } 14598 } 14599 }, 14600 "/repos/{owner}/{repo}/wiki/page/{pageName}": { 14601 "get": { 14602 "produces": [ 14603 "application/json" 14604 ], 14605 "tags": [ 14606 "repository" 14607 ], 14608 "summary": "Get a wiki page", 14609 "operationId": "repoGetWikiPage", 14610 "parameters": [ 14611 { 14612 "type": "string", 14613 "description": "owner of the repo", 14614 "name": "owner", 14615 "in": "path", 14616 "required": true 14617 }, 14618 { 14619 "type": "string", 14620 "description": "name of the repo", 14621 "name": "repo", 14622 "in": "path", 14623 "required": true 14624 }, 14625 { 14626 "type": "string", 14627 "description": "name of the page", 14628 "name": "pageName", 14629 "in": "path", 14630 "required": true 14631 } 14632 ], 14633 "responses": { 14634 "200": { 14635 "$ref": "#/responses/WikiPage" 14636 }, 14637 "404": { 14638 "$ref": "#/responses/notFound" 14639 } 14640 } 14641 }, 14642 "delete": { 14643 "tags": [ 14644 "repository" 14645 ], 14646 "summary": "Delete a wiki page", 14647 "operationId": "repoDeleteWikiPage", 14648 "parameters": [ 14649 { 14650 "type": "string", 14651 "description": "owner of the repo", 14652 "name": "owner", 14653 "in": "path", 14654 "required": true 14655 }, 14656 { 14657 "type": "string", 14658 "description": "name of the repo", 14659 "name": "repo", 14660 "in": "path", 14661 "required": true 14662 }, 14663 { 14664 "type": "string", 14665 "description": "name of the page", 14666 "name": "pageName", 14667 "in": "path", 14668 "required": true 14669 } 14670 ], 14671 "responses": { 14672 "204": { 14673 "$ref": "#/responses/empty" 14674 }, 14675 "403": { 14676 "$ref": "#/responses/forbidden" 14677 }, 14678 "404": { 14679 "$ref": "#/responses/notFound" 14680 }, 14681 "423": { 14682 "$ref": "#/responses/repoArchivedError" 14683 } 14684 } 14685 }, 14686 "patch": { 14687 "consumes": [ 14688 "application/json" 14689 ], 14690 "tags": [ 14691 "repository" 14692 ], 14693 "summary": "Edit a wiki page", 14694 "operationId": "repoEditWikiPage", 14695 "parameters": [ 14696 { 14697 "type": "string", 14698 "description": "owner of the repo", 14699 "name": "owner", 14700 "in": "path", 14701 "required": true 14702 }, 14703 { 14704 "type": "string", 14705 "description": "name of the repo", 14706 "name": "repo", 14707 "in": "path", 14708 "required": true 14709 }, 14710 { 14711 "type": "string", 14712 "description": "name of the page", 14713 "name": "pageName", 14714 "in": "path", 14715 "required": true 14716 }, 14717 { 14718 "name": "body", 14719 "in": "body", 14720 "schema": { 14721 "$ref": "#/definitions/CreateWikiPageOptions" 14722 } 14723 } 14724 ], 14725 "responses": { 14726 "200": { 14727 "$ref": "#/responses/WikiPage" 14728 }, 14729 "400": { 14730 "$ref": "#/responses/error" 14731 }, 14732 "403": { 14733 "$ref": "#/responses/forbidden" 14734 }, 14735 "404": { 14736 "$ref": "#/responses/notFound" 14737 }, 14738 "423": { 14739 "$ref": "#/responses/repoArchivedError" 14740 } 14741 } 14742 } 14743 }, 14744 "/repos/{owner}/{repo}/wiki/pages": { 14745 "get": { 14746 "produces": [ 14747 "application/json" 14748 ], 14749 "tags": [ 14750 "repository" 14751 ], 14752 "summary": "Get all wiki pages", 14753 "operationId": "repoGetWikiPages", 14754 "parameters": [ 14755 { 14756 "type": "string", 14757 "description": "owner of the repo", 14758 "name": "owner", 14759 "in": "path", 14760 "required": true 14761 }, 14762 { 14763 "type": "string", 14764 "description": "name of the repo", 14765 "name": "repo", 14766 "in": "path", 14767 "required": true 14768 }, 14769 { 14770 "type": "integer", 14771 "description": "page number of results to return (1-based)", 14772 "name": "page", 14773 "in": "query" 14774 }, 14775 { 14776 "type": "integer", 14777 "description": "page size of results", 14778 "name": "limit", 14779 "in": "query" 14780 } 14781 ], 14782 "responses": { 14783 "200": { 14784 "$ref": "#/responses/WikiPageList" 14785 }, 14786 "404": { 14787 "$ref": "#/responses/notFound" 14788 } 14789 } 14790 } 14791 }, 14792 "/repos/{owner}/{repo}/wiki/revisions/{pageName}": { 14793 "get": { 14794 "produces": [ 14795 "application/json" 14796 ], 14797 "tags": [ 14798 "repository" 14799 ], 14800 "summary": "Get revisions of a wiki page", 14801 "operationId": "repoGetWikiPageRevisions", 14802 "parameters": [ 14803 { 14804 "type": "string", 14805 "description": "owner of the repo", 14806 "name": "owner", 14807 "in": "path", 14808 "required": true 14809 }, 14810 { 14811 "type": "string", 14812 "description": "name of the repo", 14813 "name": "repo", 14814 "in": "path", 14815 "required": true 14816 }, 14817 { 14818 "type": "string", 14819 "description": "name of the page", 14820 "name": "pageName", 14821 "in": "path", 14822 "required": true 14823 }, 14824 { 14825 "type": "integer", 14826 "description": "page number of results to return (1-based)", 14827 "name": "page", 14828 "in": "query" 14829 } 14830 ], 14831 "responses": { 14832 "200": { 14833 "$ref": "#/responses/WikiCommitList" 14834 }, 14835 "404": { 14836 "$ref": "#/responses/notFound" 14837 } 14838 } 14839 } 14840 }, 14841 "/repos/{template_owner}/{template_repo}/generate": { 14842 "post": { 14843 "consumes": [ 14844 "application/json" 14845 ], 14846 "produces": [ 14847 "application/json" 14848 ], 14849 "tags": [ 14850 "repository" 14851 ], 14852 "summary": "Create a repository using a template", 14853 "operationId": "generateRepo", 14854 "parameters": [ 14855 { 14856 "type": "string", 14857 "description": "name of the template repository owner", 14858 "name": "template_owner", 14859 "in": "path", 14860 "required": true 14861 }, 14862 { 14863 "type": "string", 14864 "description": "name of the template repository", 14865 "name": "template_repo", 14866 "in": "path", 14867 "required": true 14868 }, 14869 { 14870 "name": "body", 14871 "in": "body", 14872 "schema": { 14873 "$ref": "#/definitions/GenerateRepoOption" 14874 } 14875 } 14876 ], 14877 "responses": { 14878 "201": { 14879 "$ref": "#/responses/Repository" 14880 }, 14881 "403": { 14882 "$ref": "#/responses/forbidden" 14883 }, 14884 "404": { 14885 "$ref": "#/responses/notFound" 14886 }, 14887 "409": { 14888 "description": "The repository with the same name already exists." 14889 }, 14890 "422": { 14891 "$ref": "#/responses/validationError" 14892 } 14893 } 14894 } 14895 }, 14896 "/repositories/{id}": { 14897 "get": { 14898 "produces": [ 14899 "application/json" 14900 ], 14901 "tags": [ 14902 "repository" 14903 ], 14904 "summary": "Get a repository by id", 14905 "operationId": "repoGetByID", 14906 "parameters": [ 14907 { 14908 "type": "integer", 14909 "format": "int64", 14910 "description": "id of the repo to get", 14911 "name": "id", 14912 "in": "path", 14913 "required": true 14914 } 14915 ], 14916 "responses": { 14917 "200": { 14918 "$ref": "#/responses/Repository" 14919 }, 14920 "404": { 14921 "$ref": "#/responses/notFound" 14922 } 14923 } 14924 } 14925 }, 14926 "/settings/api": { 14927 "get": { 14928 "produces": [ 14929 "application/json" 14930 ], 14931 "tags": [ 14932 "settings" 14933 ], 14934 "summary": "Get instance's global settings for api", 14935 "operationId": "getGeneralAPISettings", 14936 "responses": { 14937 "200": { 14938 "$ref": "#/responses/GeneralAPISettings" 14939 } 14940 } 14941 } 14942 }, 14943 "/settings/attachment": { 14944 "get": { 14945 "produces": [ 14946 "application/json" 14947 ], 14948 "tags": [ 14949 "settings" 14950 ], 14951 "summary": "Get instance's global settings for Attachment", 14952 "operationId": "getGeneralAttachmentSettings", 14953 "responses": { 14954 "200": { 14955 "$ref": "#/responses/GeneralAttachmentSettings" 14956 } 14957 } 14958 } 14959 }, 14960 "/settings/repository": { 14961 "get": { 14962 "produces": [ 14963 "application/json" 14964 ], 14965 "tags": [ 14966 "settings" 14967 ], 14968 "summary": "Get instance's global settings for repositories", 14969 "operationId": "getGeneralRepositorySettings", 14970 "responses": { 14971 "200": { 14972 "$ref": "#/responses/GeneralRepoSettings" 14973 } 14974 } 14975 } 14976 }, 14977 "/settings/ui": { 14978 "get": { 14979 "produces": [ 14980 "application/json" 14981 ], 14982 "tags": [ 14983 "settings" 14984 ], 14985 "summary": "Get instance's global settings for ui", 14986 "operationId": "getGeneralUISettings", 14987 "responses": { 14988 "200": { 14989 "$ref": "#/responses/GeneralUISettings" 14990 } 14991 } 14992 } 14993 }, 14994 "/signing-key.gpg": { 14995 "get": { 14996 "produces": [ 14997 "text/plain" 14998 ], 14999 "tags": [ 15000 "miscellaneous" 15001 ], 15002 "summary": "Get default signing-key.gpg", 15003 "operationId": "getSigningKey", 15004 "responses": { 15005 "200": { 15006 "description": "GPG armored public key", 15007 "schema": { 15008 "type": "string" 15009 } 15010 } 15011 } 15012 } 15013 }, 15014 "/teams/{id}": { 15015 "get": { 15016 "produces": [ 15017 "application/json" 15018 ], 15019 "tags": [ 15020 "organization" 15021 ], 15022 "summary": "Get a team", 15023 "operationId": "orgGetTeam", 15024 "parameters": [ 15025 { 15026 "type": "integer", 15027 "format": "int64", 15028 "description": "id of the team to get", 15029 "name": "id", 15030 "in": "path", 15031 "required": true 15032 } 15033 ], 15034 "responses": { 15035 "200": { 15036 "$ref": "#/responses/Team" 15037 }, 15038 "404": { 15039 "$ref": "#/responses/notFound" 15040 } 15041 } 15042 }, 15043 "delete": { 15044 "tags": [ 15045 "organization" 15046 ], 15047 "summary": "Delete a team", 15048 "operationId": "orgDeleteTeam", 15049 "parameters": [ 15050 { 15051 "type": "integer", 15052 "format": "int64", 15053 "description": "id of the team to delete", 15054 "name": "id", 15055 "in": "path", 15056 "required": true 15057 } 15058 ], 15059 "responses": { 15060 "204": { 15061 "description": "team deleted" 15062 }, 15063 "404": { 15064 "$ref": "#/responses/notFound" 15065 } 15066 } 15067 }, 15068 "patch": { 15069 "consumes": [ 15070 "application/json" 15071 ], 15072 "produces": [ 15073 "application/json" 15074 ], 15075 "tags": [ 15076 "organization" 15077 ], 15078 "summary": "Edit a team", 15079 "operationId": "orgEditTeam", 15080 "parameters": [ 15081 { 15082 "type": "integer", 15083 "description": "id of the team to edit", 15084 "name": "id", 15085 "in": "path", 15086 "required": true 15087 }, 15088 { 15089 "name": "body", 15090 "in": "body", 15091 "schema": { 15092 "$ref": "#/definitions/EditTeamOption" 15093 } 15094 } 15095 ], 15096 "responses": { 15097 "200": { 15098 "$ref": "#/responses/Team" 15099 }, 15100 "404": { 15101 "$ref": "#/responses/notFound" 15102 } 15103 } 15104 } 15105 }, 15106 "/teams/{id}/activities/feeds": { 15107 "get": { 15108 "produces": [ 15109 "application/json" 15110 ], 15111 "tags": [ 15112 "organization" 15113 ], 15114 "summary": "List a team's activity feeds", 15115 "operationId": "orgListTeamActivityFeeds", 15116 "parameters": [ 15117 { 15118 "type": "integer", 15119 "format": "int64", 15120 "description": "id of the team", 15121 "name": "id", 15122 "in": "path", 15123 "required": true 15124 }, 15125 { 15126 "type": "string", 15127 "format": "date", 15128 "description": "the date of the activities to be found", 15129 "name": "date", 15130 "in": "query" 15131 }, 15132 { 15133 "type": "integer", 15134 "description": "page number of results to return (1-based)", 15135 "name": "page", 15136 "in": "query" 15137 }, 15138 { 15139 "type": "integer", 15140 "description": "page size of results", 15141 "name": "limit", 15142 "in": "query" 15143 } 15144 ], 15145 "responses": { 15146 "200": { 15147 "$ref": "#/responses/ActivityFeedsList" 15148 }, 15149 "404": { 15150 "$ref": "#/responses/notFound" 15151 } 15152 } 15153 } 15154 }, 15155 "/teams/{id}/members": { 15156 "get": { 15157 "produces": [ 15158 "application/json" 15159 ], 15160 "tags": [ 15161 "organization" 15162 ], 15163 "summary": "List a team's members", 15164 "operationId": "orgListTeamMembers", 15165 "parameters": [ 15166 { 15167 "type": "integer", 15168 "format": "int64", 15169 "description": "id of the team", 15170 "name": "id", 15171 "in": "path", 15172 "required": true 15173 }, 15174 { 15175 "type": "integer", 15176 "description": "page number of results to return (1-based)", 15177 "name": "page", 15178 "in": "query" 15179 }, 15180 { 15181 "type": "integer", 15182 "description": "page size of results", 15183 "name": "limit", 15184 "in": "query" 15185 } 15186 ], 15187 "responses": { 15188 "200": { 15189 "$ref": "#/responses/UserList" 15190 }, 15191 "404": { 15192 "$ref": "#/responses/notFound" 15193 } 15194 } 15195 } 15196 }, 15197 "/teams/{id}/members/{username}": { 15198 "get": { 15199 "produces": [ 15200 "application/json" 15201 ], 15202 "tags": [ 15203 "organization" 15204 ], 15205 "summary": "List a particular member of team", 15206 "operationId": "orgListTeamMember", 15207 "parameters": [ 15208 { 15209 "type": "integer", 15210 "format": "int64", 15211 "description": "id of the team", 15212 "name": "id", 15213 "in": "path", 15214 "required": true 15215 }, 15216 { 15217 "type": "string", 15218 "description": "username of the member to list", 15219 "name": "username", 15220 "in": "path", 15221 "required": true 15222 } 15223 ], 15224 "responses": { 15225 "200": { 15226 "$ref": "#/responses/User" 15227 }, 15228 "404": { 15229 "$ref": "#/responses/notFound" 15230 } 15231 } 15232 }, 15233 "put": { 15234 "produces": [ 15235 "application/json" 15236 ], 15237 "tags": [ 15238 "organization" 15239 ], 15240 "summary": "Add a team member", 15241 "operationId": "orgAddTeamMember", 15242 "parameters": [ 15243 { 15244 "type": "integer", 15245 "format": "int64", 15246 "description": "id of the team", 15247 "name": "id", 15248 "in": "path", 15249 "required": true 15250 }, 15251 { 15252 "type": "string", 15253 "description": "username of the user to add", 15254 "name": "username", 15255 "in": "path", 15256 "required": true 15257 } 15258 ], 15259 "responses": { 15260 "204": { 15261 "$ref": "#/responses/empty" 15262 }, 15263 "403": { 15264 "$ref": "#/responses/forbidden" 15265 }, 15266 "404": { 15267 "$ref": "#/responses/notFound" 15268 } 15269 } 15270 }, 15271 "delete": { 15272 "produces": [ 15273 "application/json" 15274 ], 15275 "tags": [ 15276 "organization" 15277 ], 15278 "summary": "Remove a team member", 15279 "operationId": "orgRemoveTeamMember", 15280 "parameters": [ 15281 { 15282 "type": "integer", 15283 "format": "int64", 15284 "description": "id of the team", 15285 "name": "id", 15286 "in": "path", 15287 "required": true 15288 }, 15289 { 15290 "type": "string", 15291 "description": "username of the user to remove", 15292 "name": "username", 15293 "in": "path", 15294 "required": true 15295 } 15296 ], 15297 "responses": { 15298 "204": { 15299 "$ref": "#/responses/empty" 15300 }, 15301 "404": { 15302 "$ref": "#/responses/notFound" 15303 } 15304 } 15305 } 15306 }, 15307 "/teams/{id}/repos": { 15308 "get": { 15309 "produces": [ 15310 "application/json" 15311 ], 15312 "tags": [ 15313 "organization" 15314 ], 15315 "summary": "List a team's repos", 15316 "operationId": "orgListTeamRepos", 15317 "parameters": [ 15318 { 15319 "type": "integer", 15320 "format": "int64", 15321 "description": "id of the team", 15322 "name": "id", 15323 "in": "path", 15324 "required": true 15325 }, 15326 { 15327 "type": "integer", 15328 "description": "page number of results to return (1-based)", 15329 "name": "page", 15330 "in": "query" 15331 }, 15332 { 15333 "type": "integer", 15334 "description": "page size of results", 15335 "name": "limit", 15336 "in": "query" 15337 } 15338 ], 15339 "responses": { 15340 "200": { 15341 "$ref": "#/responses/RepositoryList" 15342 }, 15343 "404": { 15344 "$ref": "#/responses/notFound" 15345 } 15346 } 15347 } 15348 }, 15349 "/teams/{id}/repos/{org}/{repo}": { 15350 "get": { 15351 "produces": [ 15352 "application/json" 15353 ], 15354 "tags": [ 15355 "organization" 15356 ], 15357 "summary": "List a particular repo of team", 15358 "operationId": "orgListTeamRepo", 15359 "parameters": [ 15360 { 15361 "type": "integer", 15362 "format": "int64", 15363 "description": "id of the team", 15364 "name": "id", 15365 "in": "path", 15366 "required": true 15367 }, 15368 { 15369 "type": "string", 15370 "description": "organization that owns the repo to list", 15371 "name": "org", 15372 "in": "path", 15373 "required": true 15374 }, 15375 { 15376 "type": "string", 15377 "description": "name of the repo to list", 15378 "name": "repo", 15379 "in": "path", 15380 "required": true 15381 } 15382 ], 15383 "responses": { 15384 "200": { 15385 "$ref": "#/responses/Repository" 15386 }, 15387 "404": { 15388 "$ref": "#/responses/notFound" 15389 } 15390 } 15391 }, 15392 "put": { 15393 "produces": [ 15394 "application/json" 15395 ], 15396 "tags": [ 15397 "organization" 15398 ], 15399 "summary": "Add a repository to a team", 15400 "operationId": "orgAddTeamRepository", 15401 "parameters": [ 15402 { 15403 "type": "integer", 15404 "format": "int64", 15405 "description": "id of the team", 15406 "name": "id", 15407 "in": "path", 15408 "required": true 15409 }, 15410 { 15411 "type": "string", 15412 "description": "organization that owns the repo to add", 15413 "name": "org", 15414 "in": "path", 15415 "required": true 15416 }, 15417 { 15418 "type": "string", 15419 "description": "name of the repo to add", 15420 "name": "repo", 15421 "in": "path", 15422 "required": true 15423 } 15424 ], 15425 "responses": { 15426 "204": { 15427 "$ref": "#/responses/empty" 15428 }, 15429 "403": { 15430 "$ref": "#/responses/forbidden" 15431 }, 15432 "404": { 15433 "$ref": "#/responses/notFound" 15434 } 15435 } 15436 }, 15437 "delete": { 15438 "description": "This does not delete the repository, it only removes the repository from the team.", 15439 "produces": [ 15440 "application/json" 15441 ], 15442 "tags": [ 15443 "organization" 15444 ], 15445 "summary": "Remove a repository from a team", 15446 "operationId": "orgRemoveTeamRepository", 15447 "parameters": [ 15448 { 15449 "type": "integer", 15450 "format": "int64", 15451 "description": "id of the team", 15452 "name": "id", 15453 "in": "path", 15454 "required": true 15455 }, 15456 { 15457 "type": "string", 15458 "description": "organization that owns the repo to remove", 15459 "name": "org", 15460 "in": "path", 15461 "required": true 15462 }, 15463 { 15464 "type": "string", 15465 "description": "name of the repo to remove", 15466 "name": "repo", 15467 "in": "path", 15468 "required": true 15469 } 15470 ], 15471 "responses": { 15472 "204": { 15473 "$ref": "#/responses/empty" 15474 }, 15475 "403": { 15476 "$ref": "#/responses/forbidden" 15477 }, 15478 "404": { 15479 "$ref": "#/responses/notFound" 15480 } 15481 } 15482 } 15483 }, 15484 "/topics/search": { 15485 "get": { 15486 "produces": [ 15487 "application/json" 15488 ], 15489 "tags": [ 15490 "repository" 15491 ], 15492 "summary": "search topics via keyword", 15493 "operationId": "topicSearch", 15494 "parameters": [ 15495 { 15496 "type": "string", 15497 "description": "keywords to search", 15498 "name": "q", 15499 "in": "query", 15500 "required": true 15501 }, 15502 { 15503 "type": "integer", 15504 "description": "page number of results to return (1-based)", 15505 "name": "page", 15506 "in": "query" 15507 }, 15508 { 15509 "type": "integer", 15510 "description": "page size of results", 15511 "name": "limit", 15512 "in": "query" 15513 } 15514 ], 15515 "responses": { 15516 "200": { 15517 "$ref": "#/responses/TopicListResponse" 15518 }, 15519 "403": { 15520 "$ref": "#/responses/forbidden" 15521 }, 15522 "404": { 15523 "$ref": "#/responses/notFound" 15524 } 15525 } 15526 } 15527 }, 15528 "/user": { 15529 "get": { 15530 "produces": [ 15531 "application/json" 15532 ], 15533 "tags": [ 15534 "user" 15535 ], 15536 "summary": "Get the authenticated user", 15537 "operationId": "userGetCurrent", 15538 "responses": { 15539 "200": { 15540 "$ref": "#/responses/User" 15541 } 15542 } 15543 } 15544 }, 15545 "/user/actions/runners/registration-token": { 15546 "get": { 15547 "produces": [ 15548 "application/json" 15549 ], 15550 "tags": [ 15551 "user" 15552 ], 15553 "summary": "Get an user's actions runner registration token", 15554 "operationId": "userGetRunnerRegistrationToken", 15555 "responses": { 15556 "200": { 15557 "$ref": "#/responses/RegistrationToken" 15558 } 15559 } 15560 } 15561 }, 15562 "/user/actions/secrets/{secretname}": { 15563 "put": { 15564 "consumes": [ 15565 "application/json" 15566 ], 15567 "produces": [ 15568 "application/json" 15569 ], 15570 "tags": [ 15571 "user" 15572 ], 15573 "summary": "Create or Update a secret value in a user scope", 15574 "operationId": "updateUserSecret", 15575 "parameters": [ 15576 { 15577 "type": "string", 15578 "description": "name of the secret", 15579 "name": "secretname", 15580 "in": "path", 15581 "required": true 15582 }, 15583 { 15584 "name": "body", 15585 "in": "body", 15586 "schema": { 15587 "$ref": "#/definitions/CreateOrUpdateSecretOption" 15588 } 15589 } 15590 ], 15591 "responses": { 15592 "201": { 15593 "description": "response when creating a secret" 15594 }, 15595 "204": { 15596 "description": "response when updating a secret" 15597 }, 15598 "400": { 15599 "$ref": "#/responses/error" 15600 }, 15601 "404": { 15602 "$ref": "#/responses/notFound" 15603 } 15604 } 15605 }, 15606 "delete": { 15607 "consumes": [ 15608 "application/json" 15609 ], 15610 "produces": [ 15611 "application/json" 15612 ], 15613 "tags": [ 15614 "user" 15615 ], 15616 "summary": "Delete a secret in a user scope", 15617 "operationId": "deleteUserSecret", 15618 "parameters": [ 15619 { 15620 "type": "string", 15621 "description": "name of the secret", 15622 "name": "secretname", 15623 "in": "path", 15624 "required": true 15625 } 15626 ], 15627 "responses": { 15628 "204": { 15629 "description": "delete one secret of the user" 15630 }, 15631 "400": { 15632 "$ref": "#/responses/error" 15633 }, 15634 "404": { 15635 "$ref": "#/responses/notFound" 15636 } 15637 } 15638 } 15639 }, 15640 "/user/actions/variables": { 15641 "get": { 15642 "produces": [ 15643 "application/json" 15644 ], 15645 "tags": [ 15646 "user" 15647 ], 15648 "summary": "Get the user-level list of variables which is created by current doer", 15649 "operationId": "getUserVariablesList", 15650 "parameters": [ 15651 { 15652 "type": "integer", 15653 "description": "page number of results to return (1-based)", 15654 "name": "page", 15655 "in": "query" 15656 }, 15657 { 15658 "type": "integer", 15659 "description": "page size of results", 15660 "name": "limit", 15661 "in": "query" 15662 } 15663 ], 15664 "responses": { 15665 "200": { 15666 "$ref": "#/responses/VariableList" 15667 }, 15668 "400": { 15669 "$ref": "#/responses/error" 15670 }, 15671 "404": { 15672 "$ref": "#/responses/notFound" 15673 } 15674 } 15675 } 15676 }, 15677 "/user/actions/variables/{variablename}": { 15678 "get": { 15679 "produces": [ 15680 "application/json" 15681 ], 15682 "tags": [ 15683 "user" 15684 ], 15685 "summary": "Get a user-level variable which is created by current doer", 15686 "operationId": "getUserVariable", 15687 "parameters": [ 15688 { 15689 "type": "string", 15690 "description": "name of the variable", 15691 "name": "variablename", 15692 "in": "path", 15693 "required": true 15694 } 15695 ], 15696 "responses": { 15697 "200": { 15698 "$ref": "#/responses/ActionVariable" 15699 }, 15700 "400": { 15701 "$ref": "#/responses/error" 15702 }, 15703 "404": { 15704 "$ref": "#/responses/notFound" 15705 } 15706 } 15707 }, 15708 "put": { 15709 "consumes": [ 15710 "application/json" 15711 ], 15712 "produces": [ 15713 "application/json" 15714 ], 15715 "tags": [ 15716 "user" 15717 ], 15718 "summary": "Update a user-level variable which is created by current doer", 15719 "operationId": "updateUserVariable", 15720 "parameters": [ 15721 { 15722 "type": "string", 15723 "description": "name of the variable", 15724 "name": "variablename", 15725 "in": "path", 15726 "required": true 15727 }, 15728 { 15729 "name": "body", 15730 "in": "body", 15731 "schema": { 15732 "$ref": "#/definitions/UpdateVariableOption" 15733 } 15734 } 15735 ], 15736 "responses": { 15737 "201": { 15738 "description": "response when updating a variable" 15739 }, 15740 "204": { 15741 "description": "response when updating a variable" 15742 }, 15743 "400": { 15744 "$ref": "#/responses/error" 15745 }, 15746 "404": { 15747 "$ref": "#/responses/notFound" 15748 } 15749 } 15750 }, 15751 "post": { 15752 "consumes": [ 15753 "application/json" 15754 ], 15755 "produces": [ 15756 "application/json" 15757 ], 15758 "tags": [ 15759 "user" 15760 ], 15761 "summary": "Create a user-level variable", 15762 "operationId": "createUserVariable", 15763 "parameters": [ 15764 { 15765 "type": "string", 15766 "description": "name of the variable", 15767 "name": "variablename", 15768 "in": "path", 15769 "required": true 15770 }, 15771 { 15772 "name": "body", 15773 "in": "body", 15774 "schema": { 15775 "$ref": "#/definitions/CreateVariableOption" 15776 } 15777 } 15778 ], 15779 "responses": { 15780 "201": { 15781 "description": "response when creating a variable" 15782 }, 15783 "204": { 15784 "description": "response when creating a variable" 15785 }, 15786 "400": { 15787 "$ref": "#/responses/error" 15788 }, 15789 "404": { 15790 "$ref": "#/responses/notFound" 15791 } 15792 } 15793 }, 15794 "delete": { 15795 "produces": [ 15796 "application/json" 15797 ], 15798 "tags": [ 15799 "user" 15800 ], 15801 "summary": "Delete a user-level variable which is created by current doer", 15802 "operationId": "deleteUserVariable", 15803 "parameters": [ 15804 { 15805 "type": "string", 15806 "description": "name of the variable", 15807 "name": "variablename", 15808 "in": "path", 15809 "required": true 15810 } 15811 ], 15812 "responses": { 15813 "201": { 15814 "description": "response when deleting a variable" 15815 }, 15816 "204": { 15817 "description": "response when deleting a variable" 15818 }, 15819 "400": { 15820 "$ref": "#/responses/error" 15821 }, 15822 "404": { 15823 "$ref": "#/responses/notFound" 15824 } 15825 } 15826 } 15827 }, 15828 "/user/applications/oauth2": { 15829 "get": { 15830 "produces": [ 15831 "application/json" 15832 ], 15833 "tags": [ 15834 "user" 15835 ], 15836 "summary": "List the authenticated user's oauth2 applications", 15837 "operationId": "userGetOauth2Application", 15838 "parameters": [ 15839 { 15840 "type": "integer", 15841 "description": "page number of results to return (1-based)", 15842 "name": "page", 15843 "in": "query" 15844 }, 15845 { 15846 "type": "integer", 15847 "description": "page size of results", 15848 "name": "limit", 15849 "in": "query" 15850 } 15851 ], 15852 "responses": { 15853 "200": { 15854 "$ref": "#/responses/OAuth2ApplicationList" 15855 } 15856 } 15857 }, 15858 "post": { 15859 "produces": [ 15860 "application/json" 15861 ], 15862 "tags": [ 15863 "user" 15864 ], 15865 "summary": "creates a new OAuth2 application", 15866 "operationId": "userCreateOAuth2Application", 15867 "parameters": [ 15868 { 15869 "name": "body", 15870 "in": "body", 15871 "required": true, 15872 "schema": { 15873 "$ref": "#/definitions/CreateOAuth2ApplicationOptions" 15874 } 15875 } 15876 ], 15877 "responses": { 15878 "201": { 15879 "$ref": "#/responses/OAuth2Application" 15880 }, 15881 "400": { 15882 "$ref": "#/responses/error" 15883 } 15884 } 15885 } 15886 }, 15887 "/user/applications/oauth2/{id}": { 15888 "get": { 15889 "produces": [ 15890 "application/json" 15891 ], 15892 "tags": [ 15893 "user" 15894 ], 15895 "summary": "get an OAuth2 Application", 15896 "operationId": "userGetOAuth2Application", 15897 "parameters": [ 15898 { 15899 "type": "integer", 15900 "format": "int64", 15901 "description": "Application ID to be found", 15902 "name": "id", 15903 "in": "path", 15904 "required": true 15905 } 15906 ], 15907 "responses": { 15908 "200": { 15909 "$ref": "#/responses/OAuth2Application" 15910 }, 15911 "404": { 15912 "$ref": "#/responses/notFound" 15913 } 15914 } 15915 }, 15916 "delete": { 15917 "produces": [ 15918 "application/json" 15919 ], 15920 "tags": [ 15921 "user" 15922 ], 15923 "summary": "delete an OAuth2 Application", 15924 "operationId": "userDeleteOAuth2Application", 15925 "parameters": [ 15926 { 15927 "type": "integer", 15928 "format": "int64", 15929 "description": "token to be deleted", 15930 "name": "id", 15931 "in": "path", 15932 "required": true 15933 } 15934 ], 15935 "responses": { 15936 "204": { 15937 "$ref": "#/responses/empty" 15938 }, 15939 "404": { 15940 "$ref": "#/responses/notFound" 15941 } 15942 } 15943 }, 15944 "patch": { 15945 "produces": [ 15946 "application/json" 15947 ], 15948 "tags": [ 15949 "user" 15950 ], 15951 "summary": "update an OAuth2 Application, this includes regenerating the client secret", 15952 "operationId": "userUpdateOAuth2Application", 15953 "parameters": [ 15954 { 15955 "type": "integer", 15956 "format": "int64", 15957 "description": "application to be updated", 15958 "name": "id", 15959 "in": "path", 15960 "required": true 15961 }, 15962 { 15963 "name": "body", 15964 "in": "body", 15965 "required": true, 15966 "schema": { 15967 "$ref": "#/definitions/CreateOAuth2ApplicationOptions" 15968 } 15969 } 15970 ], 15971 "responses": { 15972 "200": { 15973 "$ref": "#/responses/OAuth2Application" 15974 }, 15975 "404": { 15976 "$ref": "#/responses/notFound" 15977 } 15978 } 15979 } 15980 }, 15981 "/user/avatar": { 15982 "post": { 15983 "produces": [ 15984 "application/json" 15985 ], 15986 "tags": [ 15987 "user" 15988 ], 15989 "summary": "Update Avatar", 15990 "operationId": "userUpdateAvatar", 15991 "parameters": [ 15992 { 15993 "name": "body", 15994 "in": "body", 15995 "schema": { 15996 "$ref": "#/definitions/UpdateUserAvatarOption" 15997 } 15998 } 15999 ], 16000 "responses": { 16001 "204": { 16002 "$ref": "#/responses/empty" 16003 } 16004 } 16005 }, 16006 "delete": { 16007 "produces": [ 16008 "application/json" 16009 ], 16010 "tags": [ 16011 "user" 16012 ], 16013 "summary": "Delete Avatar", 16014 "operationId": "userDeleteAvatar", 16015 "responses": { 16016 "204": { 16017 "$ref": "#/responses/empty" 16018 } 16019 } 16020 } 16021 }, 16022 "/user/blocks": { 16023 "get": { 16024 "produces": [ 16025 "application/json" 16026 ], 16027 "tags": [ 16028 "user" 16029 ], 16030 "summary": "List users blocked by the authenticated user", 16031 "operationId": "userListBlocks", 16032 "parameters": [ 16033 { 16034 "type": "integer", 16035 "description": "page number of results to return (1-based)", 16036 "name": "page", 16037 "in": "query" 16038 }, 16039 { 16040 "type": "integer", 16041 "description": "page size of results", 16042 "name": "limit", 16043 "in": "query" 16044 } 16045 ], 16046 "responses": { 16047 "200": { 16048 "$ref": "#/responses/UserList" 16049 } 16050 } 16051 } 16052 }, 16053 "/user/blocks/{username}": { 16054 "get": { 16055 "tags": [ 16056 "user" 16057 ], 16058 "summary": "Check if a user is blocked by the authenticated user", 16059 "operationId": "userCheckUserBlock", 16060 "parameters": [ 16061 { 16062 "type": "string", 16063 "description": "user to check", 16064 "name": "username", 16065 "in": "path", 16066 "required": true 16067 } 16068 ], 16069 "responses": { 16070 "204": { 16071 "$ref": "#/responses/empty" 16072 }, 16073 "404": { 16074 "$ref": "#/responses/notFound" 16075 } 16076 } 16077 }, 16078 "put": { 16079 "tags": [ 16080 "user" 16081 ], 16082 "summary": "Block a user", 16083 "operationId": "userBlockUser", 16084 "parameters": [ 16085 { 16086 "type": "string", 16087 "description": "user to block", 16088 "name": "username", 16089 "in": "path", 16090 "required": true 16091 }, 16092 { 16093 "type": "string", 16094 "description": "optional note for the block", 16095 "name": "note", 16096 "in": "query" 16097 } 16098 ], 16099 "responses": { 16100 "204": { 16101 "$ref": "#/responses/empty" 16102 }, 16103 "404": { 16104 "$ref": "#/responses/notFound" 16105 }, 16106 "422": { 16107 "$ref": "#/responses/validationError" 16108 } 16109 } 16110 }, 16111 "delete": { 16112 "tags": [ 16113 "user" 16114 ], 16115 "summary": "Unblock a user", 16116 "operationId": "userUnblockUser", 16117 "parameters": [ 16118 { 16119 "type": "string", 16120 "description": "user to unblock", 16121 "name": "username", 16122 "in": "path", 16123 "required": true 16124 } 16125 ], 16126 "responses": { 16127 "204": { 16128 "$ref": "#/responses/empty" 16129 }, 16130 "404": { 16131 "$ref": "#/responses/notFound" 16132 }, 16133 "422": { 16134 "$ref": "#/responses/validationError" 16135 } 16136 } 16137 } 16138 }, 16139 "/user/emails": { 16140 "get": { 16141 "produces": [ 16142 "application/json" 16143 ], 16144 "tags": [ 16145 "user" 16146 ], 16147 "summary": "List the authenticated user's email addresses", 16148 "operationId": "userListEmails", 16149 "responses": { 16150 "200": { 16151 "$ref": "#/responses/EmailList" 16152 } 16153 } 16154 }, 16155 "post": { 16156 "produces": [ 16157 "application/json" 16158 ], 16159 "tags": [ 16160 "user" 16161 ], 16162 "summary": "Add email addresses", 16163 "operationId": "userAddEmail", 16164 "parameters": [ 16165 { 16166 "name": "body", 16167 "in": "body", 16168 "schema": { 16169 "$ref": "#/definitions/CreateEmailOption" 16170 } 16171 } 16172 ], 16173 "responses": { 16174 "201": { 16175 "$ref": "#/responses/EmailList" 16176 }, 16177 "422": { 16178 "$ref": "#/responses/validationError" 16179 } 16180 } 16181 }, 16182 "delete": { 16183 "produces": [ 16184 "application/json" 16185 ], 16186 "tags": [ 16187 "user" 16188 ], 16189 "summary": "Delete email addresses", 16190 "operationId": "userDeleteEmail", 16191 "parameters": [ 16192 { 16193 "name": "body", 16194 "in": "body", 16195 "schema": { 16196 "$ref": "#/definitions/DeleteEmailOption" 16197 } 16198 } 16199 ], 16200 "responses": { 16201 "204": { 16202 "$ref": "#/responses/empty" 16203 }, 16204 "404": { 16205 "$ref": "#/responses/notFound" 16206 } 16207 } 16208 } 16209 }, 16210 "/user/followers": { 16211 "get": { 16212 "produces": [ 16213 "application/json" 16214 ], 16215 "tags": [ 16216 "user" 16217 ], 16218 "summary": "List the authenticated user's followers", 16219 "operationId": "userCurrentListFollowers", 16220 "parameters": [ 16221 { 16222 "type": "integer", 16223 "description": "page number of results to return (1-based)", 16224 "name": "page", 16225 "in": "query" 16226 }, 16227 { 16228 "type": "integer", 16229 "description": "page size of results", 16230 "name": "limit", 16231 "in": "query" 16232 } 16233 ], 16234 "responses": { 16235 "200": { 16236 "$ref": "#/responses/UserList" 16237 } 16238 } 16239 } 16240 }, 16241 "/user/following": { 16242 "get": { 16243 "produces": [ 16244 "application/json" 16245 ], 16246 "tags": [ 16247 "user" 16248 ], 16249 "summary": "List the users that the authenticated user is following", 16250 "operationId": "userCurrentListFollowing", 16251 "parameters": [ 16252 { 16253 "type": "integer", 16254 "description": "page number of results to return (1-based)", 16255 "name": "page", 16256 "in": "query" 16257 }, 16258 { 16259 "type": "integer", 16260 "description": "page size of results", 16261 "name": "limit", 16262 "in": "query" 16263 } 16264 ], 16265 "responses": { 16266 "200": { 16267 "$ref": "#/responses/UserList" 16268 } 16269 } 16270 } 16271 }, 16272 "/user/following/{username}": { 16273 "get": { 16274 "tags": [ 16275 "user" 16276 ], 16277 "summary": "Check whether a user is followed by the authenticated user", 16278 "operationId": "userCurrentCheckFollowing", 16279 "parameters": [ 16280 { 16281 "type": "string", 16282 "description": "username of followed user", 16283 "name": "username", 16284 "in": "path", 16285 "required": true 16286 } 16287 ], 16288 "responses": { 16289 "204": { 16290 "$ref": "#/responses/empty" 16291 }, 16292 "404": { 16293 "$ref": "#/responses/notFound" 16294 } 16295 } 16296 }, 16297 "put": { 16298 "tags": [ 16299 "user" 16300 ], 16301 "summary": "Follow a user", 16302 "operationId": "userCurrentPutFollow", 16303 "parameters": [ 16304 { 16305 "type": "string", 16306 "description": "username of user to follow", 16307 "name": "username", 16308 "in": "path", 16309 "required": true 16310 } 16311 ], 16312 "responses": { 16313 "204": { 16314 "$ref": "#/responses/empty" 16315 }, 16316 "403": { 16317 "$ref": "#/responses/forbidden" 16318 }, 16319 "404": { 16320 "$ref": "#/responses/notFound" 16321 } 16322 } 16323 }, 16324 "delete": { 16325 "tags": [ 16326 "user" 16327 ], 16328 "summary": "Unfollow a user", 16329 "operationId": "userCurrentDeleteFollow", 16330 "parameters": [ 16331 { 16332 "type": "string", 16333 "description": "username of user to unfollow", 16334 "name": "username", 16335 "in": "path", 16336 "required": true 16337 } 16338 ], 16339 "responses": { 16340 "204": { 16341 "$ref": "#/responses/empty" 16342 }, 16343 "404": { 16344 "$ref": "#/responses/notFound" 16345 } 16346 } 16347 } 16348 }, 16349 "/user/gpg_key_token": { 16350 "get": { 16351 "produces": [ 16352 "text/plain" 16353 ], 16354 "tags": [ 16355 "user" 16356 ], 16357 "summary": "Get a Token to verify", 16358 "operationId": "getVerificationToken", 16359 "responses": { 16360 "200": { 16361 "$ref": "#/responses/string" 16362 }, 16363 "404": { 16364 "$ref": "#/responses/notFound" 16365 } 16366 } 16367 } 16368 }, 16369 "/user/gpg_key_verify": { 16370 "post": { 16371 "consumes": [ 16372 "application/json" 16373 ], 16374 "produces": [ 16375 "application/json" 16376 ], 16377 "tags": [ 16378 "user" 16379 ], 16380 "summary": "Verify a GPG key", 16381 "operationId": "userVerifyGPGKey", 16382 "responses": { 16383 "201": { 16384 "$ref": "#/responses/GPGKey" 16385 }, 16386 "404": { 16387 "$ref": "#/responses/notFound" 16388 }, 16389 "422": { 16390 "$ref": "#/responses/validationError" 16391 } 16392 } 16393 } 16394 }, 16395 "/user/gpg_keys": { 16396 "get": { 16397 "produces": [ 16398 "application/json" 16399 ], 16400 "tags": [ 16401 "user" 16402 ], 16403 "summary": "List the authenticated user's GPG keys", 16404 "operationId": "userCurrentListGPGKeys", 16405 "parameters": [ 16406 { 16407 "type": "integer", 16408 "description": "page number of results to return (1-based)", 16409 "name": "page", 16410 "in": "query" 16411 }, 16412 { 16413 "type": "integer", 16414 "description": "page size of results", 16415 "name": "limit", 16416 "in": "query" 16417 } 16418 ], 16419 "responses": { 16420 "200": { 16421 "$ref": "#/responses/GPGKeyList" 16422 } 16423 } 16424 }, 16425 "post": { 16426 "consumes": [ 16427 "application/json" 16428 ], 16429 "produces": [ 16430 "application/json" 16431 ], 16432 "tags": [ 16433 "user" 16434 ], 16435 "summary": "Create a GPG key", 16436 "operationId": "userCurrentPostGPGKey", 16437 "parameters": [ 16438 { 16439 "name": "Form", 16440 "in": "body", 16441 "schema": { 16442 "$ref": "#/definitions/CreateGPGKeyOption" 16443 } 16444 } 16445 ], 16446 "responses": { 16447 "201": { 16448 "$ref": "#/responses/GPGKey" 16449 }, 16450 "404": { 16451 "$ref": "#/responses/notFound" 16452 }, 16453 "422": { 16454 "$ref": "#/responses/validationError" 16455 } 16456 } 16457 } 16458 }, 16459 "/user/gpg_keys/{id}": { 16460 "get": { 16461 "produces": [ 16462 "application/json" 16463 ], 16464 "tags": [ 16465 "user" 16466 ], 16467 "summary": "Get a GPG key", 16468 "operationId": "userCurrentGetGPGKey", 16469 "parameters": [ 16470 { 16471 "type": "integer", 16472 "format": "int64", 16473 "description": "id of key to get", 16474 "name": "id", 16475 "in": "path", 16476 "required": true 16477 } 16478 ], 16479 "responses": { 16480 "200": { 16481 "$ref": "#/responses/GPGKey" 16482 }, 16483 "404": { 16484 "$ref": "#/responses/notFound" 16485 } 16486 } 16487 }, 16488 "delete": { 16489 "produces": [ 16490 "application/json" 16491 ], 16492 "tags": [ 16493 "user" 16494 ], 16495 "summary": "Remove a GPG key", 16496 "operationId": "userCurrentDeleteGPGKey", 16497 "parameters": [ 16498 { 16499 "type": "integer", 16500 "format": "int64", 16501 "description": "id of key to delete", 16502 "name": "id", 16503 "in": "path", 16504 "required": true 16505 } 16506 ], 16507 "responses": { 16508 "204": { 16509 "$ref": "#/responses/empty" 16510 }, 16511 "403": { 16512 "$ref": "#/responses/forbidden" 16513 }, 16514 "404": { 16515 "$ref": "#/responses/notFound" 16516 } 16517 } 16518 } 16519 }, 16520 "/user/hooks": { 16521 "get": { 16522 "produces": [ 16523 "application/json" 16524 ], 16525 "tags": [ 16526 "user" 16527 ], 16528 "summary": "List the authenticated user's webhooks", 16529 "operationId": "userListHooks", 16530 "parameters": [ 16531 { 16532 "type": "integer", 16533 "description": "page number of results to return (1-based)", 16534 "name": "page", 16535 "in": "query" 16536 }, 16537 { 16538 "type": "integer", 16539 "description": "page size of results", 16540 "name": "limit", 16541 "in": "query" 16542 } 16543 ], 16544 "responses": { 16545 "200": { 16546 "$ref": "#/responses/HookList" 16547 } 16548 } 16549 }, 16550 "post": { 16551 "consumes": [ 16552 "application/json" 16553 ], 16554 "produces": [ 16555 "application/json" 16556 ], 16557 "tags": [ 16558 "user" 16559 ], 16560 "summary": "Create a hook", 16561 "operationId": "userCreateHook", 16562 "parameters": [ 16563 { 16564 "name": "body", 16565 "in": "body", 16566 "required": true, 16567 "schema": { 16568 "$ref": "#/definitions/CreateHookOption" 16569 } 16570 } 16571 ], 16572 "responses": { 16573 "201": { 16574 "$ref": "#/responses/Hook" 16575 } 16576 } 16577 } 16578 }, 16579 "/user/hooks/{id}": { 16580 "get": { 16581 "produces": [ 16582 "application/json" 16583 ], 16584 "tags": [ 16585 "user" 16586 ], 16587 "summary": "Get a hook", 16588 "operationId": "userGetHook", 16589 "parameters": [ 16590 { 16591 "type": "integer", 16592 "format": "int64", 16593 "description": "id of the hook to get", 16594 "name": "id", 16595 "in": "path", 16596 "required": true 16597 } 16598 ], 16599 "responses": { 16600 "200": { 16601 "$ref": "#/responses/Hook" 16602 } 16603 } 16604 }, 16605 "delete": { 16606 "produces": [ 16607 "application/json" 16608 ], 16609 "tags": [ 16610 "user" 16611 ], 16612 "summary": "Delete a hook", 16613 "operationId": "userDeleteHook", 16614 "parameters": [ 16615 { 16616 "type": "integer", 16617 "format": "int64", 16618 "description": "id of the hook to delete", 16619 "name": "id", 16620 "in": "path", 16621 "required": true 16622 } 16623 ], 16624 "responses": { 16625 "204": { 16626 "$ref": "#/responses/empty" 16627 } 16628 } 16629 }, 16630 "patch": { 16631 "consumes": [ 16632 "application/json" 16633 ], 16634 "produces": [ 16635 "application/json" 16636 ], 16637 "tags": [ 16638 "user" 16639 ], 16640 "summary": "Update a hook", 16641 "operationId": "userEditHook", 16642 "parameters": [ 16643 { 16644 "type": "integer", 16645 "format": "int64", 16646 "description": "id of the hook to update", 16647 "name": "id", 16648 "in": "path", 16649 "required": true 16650 }, 16651 { 16652 "name": "body", 16653 "in": "body", 16654 "schema": { 16655 "$ref": "#/definitions/EditHookOption" 16656 } 16657 } 16658 ], 16659 "responses": { 16660 "200": { 16661 "$ref": "#/responses/Hook" 16662 } 16663 } 16664 } 16665 }, 16666 "/user/keys": { 16667 "get": { 16668 "produces": [ 16669 "application/json" 16670 ], 16671 "tags": [ 16672 "user" 16673 ], 16674 "summary": "List the authenticated user's public keys", 16675 "operationId": "userCurrentListKeys", 16676 "parameters": [ 16677 { 16678 "type": "string", 16679 "description": "fingerprint of the key", 16680 "name": "fingerprint", 16681 "in": "query" 16682 }, 16683 { 16684 "type": "integer", 16685 "description": "page number of results to return (1-based)", 16686 "name": "page", 16687 "in": "query" 16688 }, 16689 { 16690 "type": "integer", 16691 "description": "page size of results", 16692 "name": "limit", 16693 "in": "query" 16694 } 16695 ], 16696 "responses": { 16697 "200": { 16698 "$ref": "#/responses/PublicKeyList" 16699 } 16700 } 16701 }, 16702 "post": { 16703 "consumes": [ 16704 "application/json" 16705 ], 16706 "produces": [ 16707 "application/json" 16708 ], 16709 "tags": [ 16710 "user" 16711 ], 16712 "summary": "Create a public key", 16713 "operationId": "userCurrentPostKey", 16714 "parameters": [ 16715 { 16716 "name": "body", 16717 "in": "body", 16718 "schema": { 16719 "$ref": "#/definitions/CreateKeyOption" 16720 } 16721 } 16722 ], 16723 "responses": { 16724 "201": { 16725 "$ref": "#/responses/PublicKey" 16726 }, 16727 "422": { 16728 "$ref": "#/responses/validationError" 16729 } 16730 } 16731 } 16732 }, 16733 "/user/keys/{id}": { 16734 "get": { 16735 "produces": [ 16736 "application/json" 16737 ], 16738 "tags": [ 16739 "user" 16740 ], 16741 "summary": "Get a public key", 16742 "operationId": "userCurrentGetKey", 16743 "parameters": [ 16744 { 16745 "type": "integer", 16746 "format": "int64", 16747 "description": "id of key to get", 16748 "name": "id", 16749 "in": "path", 16750 "required": true 16751 } 16752 ], 16753 "responses": { 16754 "200": { 16755 "$ref": "#/responses/PublicKey" 16756 }, 16757 "404": { 16758 "$ref": "#/responses/notFound" 16759 } 16760 } 16761 }, 16762 "delete": { 16763 "produces": [ 16764 "application/json" 16765 ], 16766 "tags": [ 16767 "user" 16768 ], 16769 "summary": "Delete a public key", 16770 "operationId": "userCurrentDeleteKey", 16771 "parameters": [ 16772 { 16773 "type": "integer", 16774 "format": "int64", 16775 "description": "id of key to delete", 16776 "name": "id", 16777 "in": "path", 16778 "required": true 16779 } 16780 ], 16781 "responses": { 16782 "204": { 16783 "$ref": "#/responses/empty" 16784 }, 16785 "403": { 16786 "$ref": "#/responses/forbidden" 16787 }, 16788 "404": { 16789 "$ref": "#/responses/notFound" 16790 } 16791 } 16792 } 16793 }, 16794 "/user/orgs": { 16795 "get": { 16796 "produces": [ 16797 "application/json" 16798 ], 16799 "tags": [ 16800 "organization" 16801 ], 16802 "summary": "List the current user's organizations", 16803 "operationId": "orgListCurrentUserOrgs", 16804 "parameters": [ 16805 { 16806 "type": "integer", 16807 "description": "page number of results to return (1-based)", 16808 "name": "page", 16809 "in": "query" 16810 }, 16811 { 16812 "type": "integer", 16813 "description": "page size of results", 16814 "name": "limit", 16815 "in": "query" 16816 } 16817 ], 16818 "responses": { 16819 "200": { 16820 "$ref": "#/responses/OrganizationList" 16821 }, 16822 "404": { 16823 "$ref": "#/responses/notFound" 16824 } 16825 } 16826 } 16827 }, 16828 "/user/repos": { 16829 "get": { 16830 "produces": [ 16831 "application/json" 16832 ], 16833 "tags": [ 16834 "user" 16835 ], 16836 "summary": "List the repos that the authenticated user owns", 16837 "operationId": "userCurrentListRepos", 16838 "parameters": [ 16839 { 16840 "type": "integer", 16841 "description": "page number of results to return (1-based)", 16842 "name": "page", 16843 "in": "query" 16844 }, 16845 { 16846 "type": "integer", 16847 "description": "page size of results", 16848 "name": "limit", 16849 "in": "query" 16850 } 16851 ], 16852 "responses": { 16853 "200": { 16854 "$ref": "#/responses/RepositoryList" 16855 } 16856 } 16857 }, 16858 "post": { 16859 "consumes": [ 16860 "application/json" 16861 ], 16862 "produces": [ 16863 "application/json" 16864 ], 16865 "tags": [ 16866 "repository", 16867 "user" 16868 ], 16869 "summary": "Create a repository", 16870 "operationId": "createCurrentUserRepo", 16871 "parameters": [ 16872 { 16873 "name": "body", 16874 "in": "body", 16875 "schema": { 16876 "$ref": "#/definitions/CreateRepoOption" 16877 } 16878 } 16879 ], 16880 "responses": { 16881 "201": { 16882 "$ref": "#/responses/Repository" 16883 }, 16884 "400": { 16885 "$ref": "#/responses/error" 16886 }, 16887 "409": { 16888 "description": "The repository with the same name already exists." 16889 }, 16890 "422": { 16891 "$ref": "#/responses/validationError" 16892 } 16893 } 16894 } 16895 }, 16896 "/user/settings": { 16897 "get": { 16898 "produces": [ 16899 "application/json" 16900 ], 16901 "tags": [ 16902 "user" 16903 ], 16904 "summary": "Get user settings", 16905 "operationId": "getUserSettings", 16906 "responses": { 16907 "200": { 16908 "$ref": "#/responses/UserSettings" 16909 } 16910 } 16911 }, 16912 "patch": { 16913 "produces": [ 16914 "application/json" 16915 ], 16916 "tags": [ 16917 "user" 16918 ], 16919 "summary": "Update user settings", 16920 "operationId": "updateUserSettings", 16921 "parameters": [ 16922 { 16923 "name": "body", 16924 "in": "body", 16925 "schema": { 16926 "$ref": "#/definitions/UserSettingsOptions" 16927 } 16928 } 16929 ], 16930 "responses": { 16931 "200": { 16932 "$ref": "#/responses/UserSettings" 16933 } 16934 } 16935 } 16936 }, 16937 "/user/starred": { 16938 "get": { 16939 "produces": [ 16940 "application/json" 16941 ], 16942 "tags": [ 16943 "user" 16944 ], 16945 "summary": "The repos that the authenticated user has starred", 16946 "operationId": "userCurrentListStarred", 16947 "parameters": [ 16948 { 16949 "type": "integer", 16950 "description": "page number of results to return (1-based)", 16951 "name": "page", 16952 "in": "query" 16953 }, 16954 { 16955 "type": "integer", 16956 "description": "page size of results", 16957 "name": "limit", 16958 "in": "query" 16959 } 16960 ], 16961 "responses": { 16962 "200": { 16963 "$ref": "#/responses/RepositoryList" 16964 } 16965 } 16966 } 16967 }, 16968 "/user/starred/{owner}/{repo}": { 16969 "get": { 16970 "tags": [ 16971 "user" 16972 ], 16973 "summary": "Whether the authenticated is starring the repo", 16974 "operationId": "userCurrentCheckStarring", 16975 "parameters": [ 16976 { 16977 "type": "string", 16978 "description": "owner of the repo", 16979 "name": "owner", 16980 "in": "path", 16981 "required": true 16982 }, 16983 { 16984 "type": "string", 16985 "description": "name of the repo", 16986 "name": "repo", 16987 "in": "path", 16988 "required": true 16989 } 16990 ], 16991 "responses": { 16992 "204": { 16993 "$ref": "#/responses/empty" 16994 }, 16995 "404": { 16996 "$ref": "#/responses/notFound" 16997 } 16998 } 16999 }, 17000 "put": { 17001 "tags": [ 17002 "user" 17003 ], 17004 "summary": "Star the given repo", 17005 "operationId": "userCurrentPutStar", 17006 "parameters": [ 17007 { 17008 "type": "string", 17009 "description": "owner of the repo to star", 17010 "name": "owner", 17011 "in": "path", 17012 "required": true 17013 }, 17014 { 17015 "type": "string", 17016 "description": "name of the repo to star", 17017 "name": "repo", 17018 "in": "path", 17019 "required": true 17020 } 17021 ], 17022 "responses": { 17023 "204": { 17024 "$ref": "#/responses/empty" 17025 }, 17026 "403": { 17027 "$ref": "#/responses/forbidden" 17028 }, 17029 "404": { 17030 "$ref": "#/responses/notFound" 17031 } 17032 } 17033 }, 17034 "delete": { 17035 "tags": [ 17036 "user" 17037 ], 17038 "summary": "Unstar the given repo", 17039 "operationId": "userCurrentDeleteStar", 17040 "parameters": [ 17041 { 17042 "type": "string", 17043 "description": "owner of the repo to unstar", 17044 "name": "owner", 17045 "in": "path", 17046 "required": true 17047 }, 17048 { 17049 "type": "string", 17050 "description": "name of the repo to unstar", 17051 "name": "repo", 17052 "in": "path", 17053 "required": true 17054 } 17055 ], 17056 "responses": { 17057 "204": { 17058 "$ref": "#/responses/empty" 17059 }, 17060 "404": { 17061 "$ref": "#/responses/notFound" 17062 } 17063 } 17064 } 17065 }, 17066 "/user/stopwatches": { 17067 "get": { 17068 "consumes": [ 17069 "application/json" 17070 ], 17071 "produces": [ 17072 "application/json" 17073 ], 17074 "tags": [ 17075 "user" 17076 ], 17077 "summary": "Get list of all existing stopwatches", 17078 "operationId": "userGetStopWatches", 17079 "parameters": [ 17080 { 17081 "type": "integer", 17082 "description": "page number of results to return (1-based)", 17083 "name": "page", 17084 "in": "query" 17085 }, 17086 { 17087 "type": "integer", 17088 "description": "page size of results", 17089 "name": "limit", 17090 "in": "query" 17091 } 17092 ], 17093 "responses": { 17094 "200": { 17095 "$ref": "#/responses/StopWatchList" 17096 } 17097 } 17098 } 17099 }, 17100 "/user/subscriptions": { 17101 "get": { 17102 "produces": [ 17103 "application/json" 17104 ], 17105 "tags": [ 17106 "user" 17107 ], 17108 "summary": "List repositories watched by the authenticated user", 17109 "operationId": "userCurrentListSubscriptions", 17110 "parameters": [ 17111 { 17112 "type": "integer", 17113 "description": "page number of results to return (1-based)", 17114 "name": "page", 17115 "in": "query" 17116 }, 17117 { 17118 "type": "integer", 17119 "description": "page size of results", 17120 "name": "limit", 17121 "in": "query" 17122 } 17123 ], 17124 "responses": { 17125 "200": { 17126 "$ref": "#/responses/RepositoryList" 17127 } 17128 } 17129 } 17130 }, 17131 "/user/teams": { 17132 "get": { 17133 "produces": [ 17134 "application/json" 17135 ], 17136 "tags": [ 17137 "user" 17138 ], 17139 "summary": "List all the teams a user belongs to", 17140 "operationId": "userListTeams", 17141 "parameters": [ 17142 { 17143 "type": "integer", 17144 "description": "page number of results to return (1-based)", 17145 "name": "page", 17146 "in": "query" 17147 }, 17148 { 17149 "type": "integer", 17150 "description": "page size of results", 17151 "name": "limit", 17152 "in": "query" 17153 } 17154 ], 17155 "responses": { 17156 "200": { 17157 "$ref": "#/responses/TeamList" 17158 } 17159 } 17160 } 17161 }, 17162 "/user/times": { 17163 "get": { 17164 "produces": [ 17165 "application/json" 17166 ], 17167 "tags": [ 17168 "user" 17169 ], 17170 "summary": "List the current user's tracked times", 17171 "operationId": "userCurrentTrackedTimes", 17172 "parameters": [ 17173 { 17174 "type": "integer", 17175 "description": "page number of results to return (1-based)", 17176 "name": "page", 17177 "in": "query" 17178 }, 17179 { 17180 "type": "integer", 17181 "description": "page size of results", 17182 "name": "limit", 17183 "in": "query" 17184 }, 17185 { 17186 "type": "string", 17187 "format": "date-time", 17188 "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format", 17189 "name": "since", 17190 "in": "query" 17191 }, 17192 { 17193 "type": "string", 17194 "format": "date-time", 17195 "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format", 17196 "name": "before", 17197 "in": "query" 17198 } 17199 ], 17200 "responses": { 17201 "200": { 17202 "$ref": "#/responses/TrackedTimeList" 17203 } 17204 } 17205 } 17206 }, 17207 "/users/search": { 17208 "get": { 17209 "produces": [ 17210 "application/json" 17211 ], 17212 "tags": [ 17213 "user" 17214 ], 17215 "summary": "Search for users", 17216 "operationId": "userSearch", 17217 "parameters": [ 17218 { 17219 "type": "string", 17220 "description": "keyword", 17221 "name": "q", 17222 "in": "query" 17223 }, 17224 { 17225 "type": "integer", 17226 "format": "int64", 17227 "description": "ID of the user to search for", 17228 "name": "uid", 17229 "in": "query" 17230 }, 17231 { 17232 "type": "integer", 17233 "description": "page number of results to return (1-based)", 17234 "name": "page", 17235 "in": "query" 17236 }, 17237 { 17238 "type": "integer", 17239 "description": "page size of results", 17240 "name": "limit", 17241 "in": "query" 17242 } 17243 ], 17244 "responses": { 17245 "200": { 17246 "description": "SearchResults of a successful search", 17247 "schema": { 17248 "type": "object", 17249 "properties": { 17250 "data": { 17251 "type": "array", 17252 "items": { 17253 "$ref": "#/definitions/User" 17254 } 17255 }, 17256 "ok": { 17257 "type": "boolean" 17258 } 17259 } 17260 } 17261 } 17262 } 17263 } 17264 }, 17265 "/users/{username}": { 17266 "get": { 17267 "produces": [ 17268 "application/json" 17269 ], 17270 "tags": [ 17271 "user" 17272 ], 17273 "summary": "Get a user", 17274 "operationId": "userGet", 17275 "parameters": [ 17276 { 17277 "type": "string", 17278 "description": "username of user to get", 17279 "name": "username", 17280 "in": "path", 17281 "required": true 17282 } 17283 ], 17284 "responses": { 17285 "200": { 17286 "$ref": "#/responses/User" 17287 }, 17288 "404": { 17289 "$ref": "#/responses/notFound" 17290 } 17291 } 17292 } 17293 }, 17294 "/users/{username}/activities/feeds": { 17295 "get": { 17296 "produces": [ 17297 "application/json" 17298 ], 17299 "tags": [ 17300 "user" 17301 ], 17302 "summary": "List a user's activity feeds", 17303 "operationId": "userListActivityFeeds", 17304 "parameters": [ 17305 { 17306 "type": "string", 17307 "description": "username of user", 17308 "name": "username", 17309 "in": "path", 17310 "required": true 17311 }, 17312 { 17313 "type": "boolean", 17314 "description": "if true, only show actions performed by the requested user", 17315 "name": "only-performed-by", 17316 "in": "query" 17317 }, 17318 { 17319 "type": "string", 17320 "format": "date", 17321 "description": "the date of the activities to be found", 17322 "name": "date", 17323 "in": "query" 17324 }, 17325 { 17326 "type": "integer", 17327 "description": "page number of results to return (1-based)", 17328 "name": "page", 17329 "in": "query" 17330 }, 17331 { 17332 "type": "integer", 17333 "description": "page size of results", 17334 "name": "limit", 17335 "in": "query" 17336 } 17337 ], 17338 "responses": { 17339 "200": { 17340 "$ref": "#/responses/ActivityFeedsList" 17341 }, 17342 "404": { 17343 "$ref": "#/responses/notFound" 17344 } 17345 } 17346 } 17347 }, 17348 "/users/{username}/followers": { 17349 "get": { 17350 "produces": [ 17351 "application/json" 17352 ], 17353 "tags": [ 17354 "user" 17355 ], 17356 "summary": "List the given user's followers", 17357 "operationId": "userListFollowers", 17358 "parameters": [ 17359 { 17360 "type": "string", 17361 "description": "username of user", 17362 "name": "username", 17363 "in": "path", 17364 "required": true 17365 }, 17366 { 17367 "type": "integer", 17368 "description": "page number of results to return (1-based)", 17369 "name": "page", 17370 "in": "query" 17371 }, 17372 { 17373 "type": "integer", 17374 "description": "page size of results", 17375 "name": "limit", 17376 "in": "query" 17377 } 17378 ], 17379 "responses": { 17380 "200": { 17381 "$ref": "#/responses/UserList" 17382 }, 17383 "404": { 17384 "$ref": "#/responses/notFound" 17385 } 17386 } 17387 } 17388 }, 17389 "/users/{username}/following": { 17390 "get": { 17391 "produces": [ 17392 "application/json" 17393 ], 17394 "tags": [ 17395 "user" 17396 ], 17397 "summary": "List the users that the given user is following", 17398 "operationId": "userListFollowing", 17399 "parameters": [ 17400 { 17401 "type": "string", 17402 "description": "username of user", 17403 "name": "username", 17404 "in": "path", 17405 "required": true 17406 }, 17407 { 17408 "type": "integer", 17409 "description": "page number of results to return (1-based)", 17410 "name": "page", 17411 "in": "query" 17412 }, 17413 { 17414 "type": "integer", 17415 "description": "page size of results", 17416 "name": "limit", 17417 "in": "query" 17418 } 17419 ], 17420 "responses": { 17421 "200": { 17422 "$ref": "#/responses/UserList" 17423 }, 17424 "404": { 17425 "$ref": "#/responses/notFound" 17426 } 17427 } 17428 } 17429 }, 17430 "/users/{username}/following/{target}": { 17431 "get": { 17432 "tags": [ 17433 "user" 17434 ], 17435 "summary": "Check if one user is following another user", 17436 "operationId": "userCheckFollowing", 17437 "parameters": [ 17438 { 17439 "type": "string", 17440 "description": "username of following user", 17441 "name": "username", 17442 "in": "path", 17443 "required": true 17444 }, 17445 { 17446 "type": "string", 17447 "description": "username of followed user", 17448 "name": "target", 17449 "in": "path", 17450 "required": true 17451 } 17452 ], 17453 "responses": { 17454 "204": { 17455 "$ref": "#/responses/empty" 17456 }, 17457 "404": { 17458 "$ref": "#/responses/notFound" 17459 } 17460 } 17461 } 17462 }, 17463 "/users/{username}/gpg_keys": { 17464 "get": { 17465 "produces": [ 17466 "application/json" 17467 ], 17468 "tags": [ 17469 "user" 17470 ], 17471 "summary": "List the given user's GPG keys", 17472 "operationId": "userListGPGKeys", 17473 "parameters": [ 17474 { 17475 "type": "string", 17476 "description": "username of user", 17477 "name": "username", 17478 "in": "path", 17479 "required": true 17480 }, 17481 { 17482 "type": "integer", 17483 "description": "page number of results to return (1-based)", 17484 "name": "page", 17485 "in": "query" 17486 }, 17487 { 17488 "type": "integer", 17489 "description": "page size of results", 17490 "name": "limit", 17491 "in": "query" 17492 } 17493 ], 17494 "responses": { 17495 "200": { 17496 "$ref": "#/responses/GPGKeyList" 17497 }, 17498 "404": { 17499 "$ref": "#/responses/notFound" 17500 } 17501 } 17502 } 17503 }, 17504 "/users/{username}/heatmap": { 17505 "get": { 17506 "produces": [ 17507 "application/json" 17508 ], 17509 "tags": [ 17510 "user" 17511 ], 17512 "summary": "Get a user's heatmap", 17513 "operationId": "userGetHeatmapData", 17514 "parameters": [ 17515 { 17516 "type": "string", 17517 "description": "username of user to get", 17518 "name": "username", 17519 "in": "path", 17520 "required": true 17521 } 17522 ], 17523 "responses": { 17524 "200": { 17525 "$ref": "#/responses/UserHeatmapData" 17526 }, 17527 "404": { 17528 "$ref": "#/responses/notFound" 17529 } 17530 } 17531 } 17532 }, 17533 "/users/{username}/keys": { 17534 "get": { 17535 "produces": [ 17536 "application/json" 17537 ], 17538 "tags": [ 17539 "user" 17540 ], 17541 "summary": "List the given user's public keys", 17542 "operationId": "userListKeys", 17543 "parameters": [ 17544 { 17545 "type": "string", 17546 "description": "username of user", 17547 "name": "username", 17548 "in": "path", 17549 "required": true 17550 }, 17551 { 17552 "type": "string", 17553 "description": "fingerprint of the key", 17554 "name": "fingerprint", 17555 "in": "query" 17556 }, 17557 { 17558 "type": "integer", 17559 "description": "page number of results to return (1-based)", 17560 "name": "page", 17561 "in": "query" 17562 }, 17563 { 17564 "type": "integer", 17565 "description": "page size of results", 17566 "name": "limit", 17567 "in": "query" 17568 } 17569 ], 17570 "responses": { 17571 "200": { 17572 "$ref": "#/responses/PublicKeyList" 17573 }, 17574 "404": { 17575 "$ref": "#/responses/notFound" 17576 } 17577 } 17578 } 17579 }, 17580 "/users/{username}/orgs": { 17581 "get": { 17582 "produces": [ 17583 "application/json" 17584 ], 17585 "tags": [ 17586 "organization" 17587 ], 17588 "summary": "List a user's organizations", 17589 "operationId": "orgListUserOrgs", 17590 "parameters": [ 17591 { 17592 "type": "string", 17593 "description": "username of user", 17594 "name": "username", 17595 "in": "path", 17596 "required": true 17597 }, 17598 { 17599 "type": "integer", 17600 "description": "page number of results to return (1-based)", 17601 "name": "page", 17602 "in": "query" 17603 }, 17604 { 17605 "type": "integer", 17606 "description": "page size of results", 17607 "name": "limit", 17608 "in": "query" 17609 } 17610 ], 17611 "responses": { 17612 "200": { 17613 "$ref": "#/responses/OrganizationList" 17614 }, 17615 "404": { 17616 "$ref": "#/responses/notFound" 17617 } 17618 } 17619 } 17620 }, 17621 "/users/{username}/orgs/{org}/permissions": { 17622 "get": { 17623 "produces": [ 17624 "application/json" 17625 ], 17626 "tags": [ 17627 "organization" 17628 ], 17629 "summary": "Get user permissions in organization", 17630 "operationId": "orgGetUserPermissions", 17631 "parameters": [ 17632 { 17633 "type": "string", 17634 "description": "username of user", 17635 "name": "username", 17636 "in": "path", 17637 "required": true 17638 }, 17639 { 17640 "type": "string", 17641 "description": "name of the organization", 17642 "name": "org", 17643 "in": "path", 17644 "required": true 17645 } 17646 ], 17647 "responses": { 17648 "200": { 17649 "$ref": "#/responses/OrganizationPermissions" 17650 }, 17651 "403": { 17652 "$ref": "#/responses/forbidden" 17653 }, 17654 "404": { 17655 "$ref": "#/responses/notFound" 17656 } 17657 } 17658 } 17659 }, 17660 "/users/{username}/repos": { 17661 "get": { 17662 "produces": [ 17663 "application/json" 17664 ], 17665 "tags": [ 17666 "user" 17667 ], 17668 "summary": "List the repos owned by the given user", 17669 "operationId": "userListRepos", 17670 "parameters": [ 17671 { 17672 "type": "string", 17673 "description": "username of user", 17674 "name": "username", 17675 "in": "path", 17676 "required": true 17677 }, 17678 { 17679 "type": "integer", 17680 "description": "page number of results to return (1-based)", 17681 "name": "page", 17682 "in": "query" 17683 }, 17684 { 17685 "type": "integer", 17686 "description": "page size of results", 17687 "name": "limit", 17688 "in": "query" 17689 } 17690 ], 17691 "responses": { 17692 "200": { 17693 "$ref": "#/responses/RepositoryList" 17694 }, 17695 "404": { 17696 "$ref": "#/responses/notFound" 17697 } 17698 } 17699 } 17700 }, 17701 "/users/{username}/starred": { 17702 "get": { 17703 "produces": [ 17704 "application/json" 17705 ], 17706 "tags": [ 17707 "user" 17708 ], 17709 "summary": "The repos that the given user has starred", 17710 "operationId": "userListStarred", 17711 "parameters": [ 17712 { 17713 "type": "string", 17714 "description": "username of user", 17715 "name": "username", 17716 "in": "path", 17717 "required": true 17718 }, 17719 { 17720 "type": "integer", 17721 "description": "page number of results to return (1-based)", 17722 "name": "page", 17723 "in": "query" 17724 }, 17725 { 17726 "type": "integer", 17727 "description": "page size of results", 17728 "name": "limit", 17729 "in": "query" 17730 } 17731 ], 17732 "responses": { 17733 "200": { 17734 "$ref": "#/responses/RepositoryList" 17735 }, 17736 "404": { 17737 "$ref": "#/responses/notFound" 17738 } 17739 } 17740 } 17741 }, 17742 "/users/{username}/subscriptions": { 17743 "get": { 17744 "produces": [ 17745 "application/json" 17746 ], 17747 "tags": [ 17748 "user" 17749 ], 17750 "summary": "List the repositories watched by a user", 17751 "operationId": "userListSubscriptions", 17752 "parameters": [ 17753 { 17754 "type": "string", 17755 "description": "username of the user", 17756 "name": "username", 17757 "in": "path", 17758 "required": true 17759 }, 17760 { 17761 "type": "integer", 17762 "description": "page number of results to return (1-based)", 17763 "name": "page", 17764 "in": "query" 17765 }, 17766 { 17767 "type": "integer", 17768 "description": "page size of results", 17769 "name": "limit", 17770 "in": "query" 17771 } 17772 ], 17773 "responses": { 17774 "200": { 17775 "$ref": "#/responses/RepositoryList" 17776 }, 17777 "404": { 17778 "$ref": "#/responses/notFound" 17779 } 17780 } 17781 } 17782 }, 17783 "/users/{username}/tokens": { 17784 "get": { 17785 "produces": [ 17786 "application/json" 17787 ], 17788 "tags": [ 17789 "user" 17790 ], 17791 "summary": "List the authenticated user's access tokens", 17792 "operationId": "userGetTokens", 17793 "parameters": [ 17794 { 17795 "type": "string", 17796 "description": "username of user", 17797 "name": "username", 17798 "in": "path", 17799 "required": true 17800 }, 17801 { 17802 "type": "integer", 17803 "description": "page number of results to return (1-based)", 17804 "name": "page", 17805 "in": "query" 17806 }, 17807 { 17808 "type": "integer", 17809 "description": "page size of results", 17810 "name": "limit", 17811 "in": "query" 17812 } 17813 ], 17814 "responses": { 17815 "200": { 17816 "$ref": "#/responses/AccessTokenList" 17817 }, 17818 "403": { 17819 "$ref": "#/responses/forbidden" 17820 } 17821 } 17822 }, 17823 "post": { 17824 "consumes": [ 17825 "application/json" 17826 ], 17827 "produces": [ 17828 "application/json" 17829 ], 17830 "tags": [ 17831 "user" 17832 ], 17833 "summary": "Create an access token", 17834 "operationId": "userCreateToken", 17835 "parameters": [ 17836 { 17837 "type": "string", 17838 "description": "username of user", 17839 "name": "username", 17840 "in": "path", 17841 "required": true 17842 }, 17843 { 17844 "name": "body", 17845 "in": "body", 17846 "schema": { 17847 "$ref": "#/definitions/CreateAccessTokenOption" 17848 } 17849 } 17850 ], 17851 "responses": { 17852 "201": { 17853 "$ref": "#/responses/AccessToken" 17854 }, 17855 "400": { 17856 "$ref": "#/responses/error" 17857 }, 17858 "403": { 17859 "$ref": "#/responses/forbidden" 17860 } 17861 } 17862 } 17863 }, 17864 "/users/{username}/tokens/{token}": { 17865 "delete": { 17866 "produces": [ 17867 "application/json" 17868 ], 17869 "tags": [ 17870 "user" 17871 ], 17872 "summary": "delete an access token", 17873 "operationId": "userDeleteAccessToken", 17874 "parameters": [ 17875 { 17876 "type": "string", 17877 "description": "username of user", 17878 "name": "username", 17879 "in": "path", 17880 "required": true 17881 }, 17882 { 17883 "type": "string", 17884 "description": "token to be deleted, identified by ID and if not available by name", 17885 "name": "token", 17886 "in": "path", 17887 "required": true 17888 } 17889 ], 17890 "responses": { 17891 "204": { 17892 "$ref": "#/responses/empty" 17893 }, 17894 "403": { 17895 "$ref": "#/responses/forbidden" 17896 }, 17897 "404": { 17898 "$ref": "#/responses/notFound" 17899 }, 17900 "422": { 17901 "$ref": "#/responses/error" 17902 } 17903 } 17904 } 17905 }, 17906 "/version": { 17907 "get": { 17908 "produces": [ 17909 "application/json" 17910 ], 17911 "tags": [ 17912 "miscellaneous" 17913 ], 17914 "summary": "Returns the version of the Gitea application", 17915 "operationId": "getVersion", 17916 "responses": { 17917 "200": { 17918 "$ref": "#/responses/ServerVersion" 17919 } 17920 } 17921 } 17922 } 17923 }, 17924 "definitions": { 17925 "APIError": { 17926 "description": "APIError is an api error with a message", 17927 "type": "object", 17928 "properties": { 17929 "message": { 17930 "type": "string", 17931 "x-go-name": "Message" 17932 }, 17933 "url": { 17934 "type": "string", 17935 "x-go-name": "URL" 17936 } 17937 }, 17938 "x-go-package": "code.gitea.io/gitea/modules/structs" 17939 }, 17940 "AccessToken": { 17941 "type": "object", 17942 "title": "AccessToken represents an API access token.", 17943 "properties": { 17944 "id": { 17945 "type": "integer", 17946 "format": "int64", 17947 "x-go-name": "ID" 17948 }, 17949 "name": { 17950 "type": "string", 17951 "x-go-name": "Name" 17952 }, 17953 "scopes": { 17954 "type": "array", 17955 "items": { 17956 "type": "string" 17957 }, 17958 "x-go-name": "Scopes" 17959 }, 17960 "sha1": { 17961 "type": "string", 17962 "x-go-name": "Token" 17963 }, 17964 "token_last_eight": { 17965 "type": "string", 17966 "x-go-name": "TokenLastEight" 17967 } 17968 }, 17969 "x-go-package": "code.gitea.io/gitea/modules/structs" 17970 }, 17971 "ActionVariable": { 17972 "description": "ActionVariable return value of the query API", 17973 "type": "object", 17974 "properties": { 17975 "data": { 17976 "description": "the value of the variable", 17977 "type": "string", 17978 "x-go-name": "Data" 17979 }, 17980 "name": { 17981 "description": "the name of the variable", 17982 "type": "string", 17983 "x-go-name": "Name" 17984 }, 17985 "owner_id": { 17986 "description": "the owner to which the variable belongs", 17987 "type": "integer", 17988 "format": "int64", 17989 "x-go-name": "OwnerID" 17990 }, 17991 "repo_id": { 17992 "description": "the repository to which the variable belongs", 17993 "type": "integer", 17994 "format": "int64", 17995 "x-go-name": "RepoID" 17996 } 17997 }, 17998 "x-go-package": "code.gitea.io/gitea/modules/structs" 17999 }, 18000 "Activity": { 18001 "type": "object", 18002 "properties": { 18003 "act_user": { 18004 "$ref": "#/definitions/User" 18005 }, 18006 "act_user_id": { 18007 "type": "integer", 18008 "format": "int64", 18009 "x-go-name": "ActUserID" 18010 }, 18011 "comment": { 18012 "$ref": "#/definitions/Comment" 18013 }, 18014 "comment_id": { 18015 "type": "integer", 18016 "format": "int64", 18017 "x-go-name": "CommentID" 18018 }, 18019 "content": { 18020 "type": "string", 18021 "x-go-name": "Content" 18022 }, 18023 "created": { 18024 "type": "string", 18025 "format": "date-time", 18026 "x-go-name": "Created" 18027 }, 18028 "id": { 18029 "type": "integer", 18030 "format": "int64", 18031 "x-go-name": "ID" 18032 }, 18033 "is_private": { 18034 "type": "boolean", 18035 "x-go-name": "IsPrivate" 18036 }, 18037 "op_type": { 18038 "type": "string", 18039 "x-go-name": "OpType" 18040 }, 18041 "ref_name": { 18042 "type": "string", 18043 "x-go-name": "RefName" 18044 }, 18045 "repo": { 18046 "$ref": "#/definitions/Repository" 18047 }, 18048 "repo_id": { 18049 "type": "integer", 18050 "format": "int64", 18051 "x-go-name": "RepoID" 18052 }, 18053 "user_id": { 18054 "type": "integer", 18055 "format": "int64", 18056 "x-go-name": "UserID" 18057 } 18058 }, 18059 "x-go-package": "code.gitea.io/gitea/modules/structs" 18060 }, 18061 "ActivityPub": { 18062 "description": "ActivityPub type", 18063 "type": "object", 18064 "properties": { 18065 "@context": { 18066 "type": "string", 18067 "x-go-name": "Context" 18068 } 18069 }, 18070 "x-go-package": "code.gitea.io/gitea/modules/structs" 18071 }, 18072 "AddCollaboratorOption": { 18073 "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository", 18074 "type": "object", 18075 "properties": { 18076 "permission": { 18077 "type": "string", 18078 "x-go-name": "Permission" 18079 } 18080 }, 18081 "x-go-package": "code.gitea.io/gitea/modules/structs" 18082 }, 18083 "AddTimeOption": { 18084 "description": "AddTimeOption options for adding time to an issue", 18085 "type": "object", 18086 "required": [ 18087 "time" 18088 ], 18089 "properties": { 18090 "created": { 18091 "type": "string", 18092 "format": "date-time", 18093 "x-go-name": "Created" 18094 }, 18095 "time": { 18096 "description": "time in seconds", 18097 "type": "integer", 18098 "format": "int64", 18099 "x-go-name": "Time" 18100 }, 18101 "user_name": { 18102 "description": "User who spent the time (optional)", 18103 "type": "string", 18104 "x-go-name": "User" 18105 } 18106 }, 18107 "x-go-package": "code.gitea.io/gitea/modules/structs" 18108 }, 18109 "AnnotatedTag": { 18110 "description": "AnnotatedTag represents an annotated tag", 18111 "type": "object", 18112 "properties": { 18113 "message": { 18114 "type": "string", 18115 "x-go-name": "Message" 18116 }, 18117 "object": { 18118 "$ref": "#/definitions/AnnotatedTagObject" 18119 }, 18120 "sha": { 18121 "type": "string", 18122 "x-go-name": "SHA" 18123 }, 18124 "tag": { 18125 "type": "string", 18126 "x-go-name": "Tag" 18127 }, 18128 "tagger": { 18129 "$ref": "#/definitions/CommitUser" 18130 }, 18131 "url": { 18132 "type": "string", 18133 "x-go-name": "URL" 18134 }, 18135 "verification": { 18136 "$ref": "#/definitions/PayloadCommitVerification" 18137 } 18138 }, 18139 "x-go-package": "code.gitea.io/gitea/modules/structs" 18140 }, 18141 "AnnotatedTagObject": { 18142 "description": "AnnotatedTagObject contains meta information of the tag object", 18143 "type": "object", 18144 "properties": { 18145 "sha": { 18146 "type": "string", 18147 "x-go-name": "SHA" 18148 }, 18149 "type": { 18150 "type": "string", 18151 "x-go-name": "Type" 18152 }, 18153 "url": { 18154 "type": "string", 18155 "x-go-name": "URL" 18156 } 18157 }, 18158 "x-go-package": "code.gitea.io/gitea/modules/structs" 18159 }, 18160 "Attachment": { 18161 "description": "Attachment a generic attachment", 18162 "type": "object", 18163 "properties": { 18164 "browser_download_url": { 18165 "type": "string", 18166 "x-go-name": "DownloadURL" 18167 }, 18168 "created_at": { 18169 "type": "string", 18170 "format": "date-time", 18171 "x-go-name": "Created" 18172 }, 18173 "download_count": { 18174 "type": "integer", 18175 "format": "int64", 18176 "x-go-name": "DownloadCount" 18177 }, 18178 "id": { 18179 "type": "integer", 18180 "format": "int64", 18181 "x-go-name": "ID" 18182 }, 18183 "name": { 18184 "type": "string", 18185 "x-go-name": "Name" 18186 }, 18187 "size": { 18188 "type": "integer", 18189 "format": "int64", 18190 "x-go-name": "Size" 18191 }, 18192 "uuid": { 18193 "type": "string", 18194 "x-go-name": "UUID" 18195 } 18196 }, 18197 "x-go-package": "code.gitea.io/gitea/modules/structs" 18198 }, 18199 "Badge": { 18200 "description": "Badge represents a user badge", 18201 "type": "object", 18202 "properties": { 18203 "description": { 18204 "type": "string", 18205 "x-go-name": "Description" 18206 }, 18207 "id": { 18208 "type": "integer", 18209 "format": "int64", 18210 "x-go-name": "ID" 18211 }, 18212 "image_url": { 18213 "type": "string", 18214 "x-go-name": "ImageURL" 18215 }, 18216 "slug": { 18217 "type": "string", 18218 "x-go-name": "Slug" 18219 } 18220 }, 18221 "x-go-package": "code.gitea.io/gitea/modules/structs" 18222 }, 18223 "Branch": { 18224 "description": "Branch represents a repository branch", 18225 "type": "object", 18226 "properties": { 18227 "commit": { 18228 "$ref": "#/definitions/PayloadCommit" 18229 }, 18230 "effective_branch_protection_name": { 18231 "type": "string", 18232 "x-go-name": "EffectiveBranchProtectionName" 18233 }, 18234 "enable_status_check": { 18235 "type": "boolean", 18236 "x-go-name": "EnableStatusCheck" 18237 }, 18238 "name": { 18239 "type": "string", 18240 "x-go-name": "Name" 18241 }, 18242 "protected": { 18243 "type": "boolean", 18244 "x-go-name": "Protected" 18245 }, 18246 "required_approvals": { 18247 "type": "integer", 18248 "format": "int64", 18249 "x-go-name": "RequiredApprovals" 18250 }, 18251 "status_check_contexts": { 18252 "type": "array", 18253 "items": { 18254 "type": "string" 18255 }, 18256 "x-go-name": "StatusCheckContexts" 18257 }, 18258 "user_can_merge": { 18259 "type": "boolean", 18260 "x-go-name": "UserCanMerge" 18261 }, 18262 "user_can_push": { 18263 "type": "boolean", 18264 "x-go-name": "UserCanPush" 18265 } 18266 }, 18267 "x-go-package": "code.gitea.io/gitea/modules/structs" 18268 }, 18269 "BranchProtection": { 18270 "description": "BranchProtection represents a branch protection for a repository", 18271 "type": "object", 18272 "properties": { 18273 "approvals_whitelist_teams": { 18274 "type": "array", 18275 "items": { 18276 "type": "string" 18277 }, 18278 "x-go-name": "ApprovalsWhitelistTeams" 18279 }, 18280 "approvals_whitelist_username": { 18281 "type": "array", 18282 "items": { 18283 "type": "string" 18284 }, 18285 "x-go-name": "ApprovalsWhitelistUsernames" 18286 }, 18287 "block_on_official_review_requests": { 18288 "type": "boolean", 18289 "x-go-name": "BlockOnOfficialReviewRequests" 18290 }, 18291 "block_on_outdated_branch": { 18292 "type": "boolean", 18293 "x-go-name": "BlockOnOutdatedBranch" 18294 }, 18295 "block_on_rejected_reviews": { 18296 "type": "boolean", 18297 "x-go-name": "BlockOnRejectedReviews" 18298 }, 18299 "branch_name": { 18300 "description": "Deprecated: true", 18301 "type": "string", 18302 "x-go-name": "BranchName" 18303 }, 18304 "created_at": { 18305 "type": "string", 18306 "format": "date-time", 18307 "x-go-name": "Created" 18308 }, 18309 "dismiss_stale_approvals": { 18310 "type": "boolean", 18311 "x-go-name": "DismissStaleApprovals" 18312 }, 18313 "enable_approvals_whitelist": { 18314 "type": "boolean", 18315 "x-go-name": "EnableApprovalsWhitelist" 18316 }, 18317 "enable_merge_whitelist": { 18318 "type": "boolean", 18319 "x-go-name": "EnableMergeWhitelist" 18320 }, 18321 "enable_push": { 18322 "type": "boolean", 18323 "x-go-name": "EnablePush" 18324 }, 18325 "enable_push_whitelist": { 18326 "type": "boolean", 18327 "x-go-name": "EnablePushWhitelist" 18328 }, 18329 "enable_status_check": { 18330 "type": "boolean", 18331 "x-go-name": "EnableStatusCheck" 18332 }, 18333 "ignore_stale_approvals": { 18334 "type": "boolean", 18335 "x-go-name": "IgnoreStaleApprovals" 18336 }, 18337 "merge_whitelist_teams": { 18338 "type": "array", 18339 "items": { 18340 "type": "string" 18341 }, 18342 "x-go-name": "MergeWhitelistTeams" 18343 }, 18344 "merge_whitelist_usernames": { 18345 "type": "array", 18346 "items": { 18347 "type": "string" 18348 }, 18349 "x-go-name": "MergeWhitelistUsernames" 18350 }, 18351 "protected_file_patterns": { 18352 "type": "string", 18353 "x-go-name": "ProtectedFilePatterns" 18354 }, 18355 "push_whitelist_deploy_keys": { 18356 "type": "boolean", 18357 "x-go-name": "PushWhitelistDeployKeys" 18358 }, 18359 "push_whitelist_teams": { 18360 "type": "array", 18361 "items": { 18362 "type": "string" 18363 }, 18364 "x-go-name": "PushWhitelistTeams" 18365 }, 18366 "push_whitelist_usernames": { 18367 "type": "array", 18368 "items": { 18369 "type": "string" 18370 }, 18371 "x-go-name": "PushWhitelistUsernames" 18372 }, 18373 "require_signed_commits": { 18374 "type": "boolean", 18375 "x-go-name": "RequireSignedCommits" 18376 }, 18377 "required_approvals": { 18378 "type": "integer", 18379 "format": "int64", 18380 "x-go-name": "RequiredApprovals" 18381 }, 18382 "rule_name": { 18383 "type": "string", 18384 "x-go-name": "RuleName" 18385 }, 18386 "status_check_contexts": { 18387 "type": "array", 18388 "items": { 18389 "type": "string" 18390 }, 18391 "x-go-name": "StatusCheckContexts" 18392 }, 18393 "unprotected_file_patterns": { 18394 "type": "string", 18395 "x-go-name": "UnprotectedFilePatterns" 18396 }, 18397 "updated_at": { 18398 "type": "string", 18399 "format": "date-time", 18400 "x-go-name": "Updated" 18401 } 18402 }, 18403 "x-go-package": "code.gitea.io/gitea/modules/structs" 18404 }, 18405 "ChangeFileOperation": { 18406 "description": "ChangeFileOperation for creating, updating or deleting a file", 18407 "type": "object", 18408 "required": [ 18409 "operation", 18410 "path" 18411 ], 18412 "properties": { 18413 "content": { 18414 "description": "new or updated file content, must be base64 encoded", 18415 "type": "string", 18416 "x-go-name": "ContentBase64" 18417 }, 18418 "from_path": { 18419 "description": "old path of the file to move", 18420 "type": "string", 18421 "x-go-name": "FromPath" 18422 }, 18423 "operation": { 18424 "description": "indicates what to do with the file", 18425 "type": "string", 18426 "enum": [ 18427 "create", 18428 "update", 18429 "delete" 18430 ], 18431 "x-go-name": "Operation" 18432 }, 18433 "path": { 18434 "description": "path to the existing or new file", 18435 "type": "string", 18436 "x-go-name": "Path" 18437 }, 18438 "sha": { 18439 "description": "sha is the SHA for the file that already exists, required for update or delete", 18440 "type": "string", 18441 "x-go-name": "SHA" 18442 } 18443 }, 18444 "x-go-package": "code.gitea.io/gitea/modules/structs" 18445 }, 18446 "ChangeFilesOptions": { 18447 "description": "ChangeFilesOptions options for creating, updating or deleting multiple files\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)", 18448 "type": "object", 18449 "required": [ 18450 "files" 18451 ], 18452 "properties": { 18453 "author": { 18454 "$ref": "#/definitions/Identity" 18455 }, 18456 "branch": { 18457 "description": "branch (optional) to base this file from. if not given, the default branch is used", 18458 "type": "string", 18459 "x-go-name": "BranchName" 18460 }, 18461 "committer": { 18462 "$ref": "#/definitions/Identity" 18463 }, 18464 "dates": { 18465 "$ref": "#/definitions/CommitDateOptions" 18466 }, 18467 "files": { 18468 "description": "list of file operations", 18469 "type": "array", 18470 "items": { 18471 "$ref": "#/definitions/ChangeFileOperation" 18472 }, 18473 "x-go-name": "Files" 18474 }, 18475 "message": { 18476 "description": "message (optional) for the commit of this file. if not supplied, a default message will be used", 18477 "type": "string", 18478 "x-go-name": "Message" 18479 }, 18480 "new_branch": { 18481 "description": "new_branch (optional) will make a new branch from `branch` before creating the file", 18482 "type": "string", 18483 "x-go-name": "NewBranchName" 18484 }, 18485 "signoff": { 18486 "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.", 18487 "type": "boolean", 18488 "x-go-name": "Signoff" 18489 } 18490 }, 18491 "x-go-package": "code.gitea.io/gitea/modules/structs" 18492 }, 18493 "ChangedFile": { 18494 "description": "ChangedFile store information about files affected by the pull request", 18495 "type": "object", 18496 "properties": { 18497 "additions": { 18498 "type": "integer", 18499 "format": "int64", 18500 "x-go-name": "Additions" 18501 }, 18502 "changes": { 18503 "type": "integer", 18504 "format": "int64", 18505 "x-go-name": "Changes" 18506 }, 18507 "contents_url": { 18508 "type": "string", 18509 "x-go-name": "ContentsURL" 18510 }, 18511 "deletions": { 18512 "type": "integer", 18513 "format": "int64", 18514 "x-go-name": "Deletions" 18515 }, 18516 "filename": { 18517 "type": "string", 18518 "x-go-name": "Filename" 18519 }, 18520 "html_url": { 18521 "type": "string", 18522 "x-go-name": "HTMLURL" 18523 }, 18524 "previous_filename": { 18525 "type": "string", 18526 "x-go-name": "PreviousFilename" 18527 }, 18528 "raw_url": { 18529 "type": "string", 18530 "x-go-name": "RawURL" 18531 }, 18532 "status": { 18533 "type": "string", 18534 "x-go-name": "Status" 18535 } 18536 }, 18537 "x-go-package": "code.gitea.io/gitea/modules/structs" 18538 }, 18539 "CombinedStatus": { 18540 "description": "CombinedStatus holds the combined state of several statuses for a single commit", 18541 "type": "object", 18542 "properties": { 18543 "commit_url": { 18544 "type": "string", 18545 "x-go-name": "CommitURL" 18546 }, 18547 "repository": { 18548 "$ref": "#/definitions/Repository" 18549 }, 18550 "sha": { 18551 "type": "string", 18552 "x-go-name": "SHA" 18553 }, 18554 "state": { 18555 "$ref": "#/definitions/CommitStatusState" 18556 }, 18557 "statuses": { 18558 "type": "array", 18559 "items": { 18560 "$ref": "#/definitions/CommitStatus" 18561 }, 18562 "x-go-name": "Statuses" 18563 }, 18564 "total_count": { 18565 "type": "integer", 18566 "format": "int64", 18567 "x-go-name": "TotalCount" 18568 }, 18569 "url": { 18570 "type": "string", 18571 "x-go-name": "URL" 18572 } 18573 }, 18574 "x-go-package": "code.gitea.io/gitea/modules/structs" 18575 }, 18576 "Comment": { 18577 "description": "Comment represents a comment on a commit or issue", 18578 "type": "object", 18579 "properties": { 18580 "assets": { 18581 "type": "array", 18582 "items": { 18583 "$ref": "#/definitions/Attachment" 18584 }, 18585 "x-go-name": "Attachments" 18586 }, 18587 "body": { 18588 "type": "string", 18589 "x-go-name": "Body" 18590 }, 18591 "created_at": { 18592 "type": "string", 18593 "format": "date-time", 18594 "x-go-name": "Created" 18595 }, 18596 "html_url": { 18597 "type": "string", 18598 "x-go-name": "HTMLURL" 18599 }, 18600 "id": { 18601 "type": "integer", 18602 "format": "int64", 18603 "x-go-name": "ID" 18604 }, 18605 "issue_url": { 18606 "type": "string", 18607 "x-go-name": "IssueURL" 18608 }, 18609 "original_author": { 18610 "type": "string", 18611 "x-go-name": "OriginalAuthor" 18612 }, 18613 "original_author_id": { 18614 "type": "integer", 18615 "format": "int64", 18616 "x-go-name": "OriginalAuthorID" 18617 }, 18618 "pull_request_url": { 18619 "type": "string", 18620 "x-go-name": "PRURL" 18621 }, 18622 "updated_at": { 18623 "type": "string", 18624 "format": "date-time", 18625 "x-go-name": "Updated" 18626 }, 18627 "user": { 18628 "$ref": "#/definitions/User" 18629 } 18630 }, 18631 "x-go-package": "code.gitea.io/gitea/modules/structs" 18632 }, 18633 "Commit": { 18634 "type": "object", 18635 "title": "Commit contains information generated from a Git commit.", 18636 "properties": { 18637 "author": { 18638 "$ref": "#/definitions/User" 18639 }, 18640 "commit": { 18641 "$ref": "#/definitions/RepoCommit" 18642 }, 18643 "committer": { 18644 "$ref": "#/definitions/User" 18645 }, 18646 "created": { 18647 "type": "string", 18648 "format": "date-time", 18649 "x-go-name": "Created" 18650 }, 18651 "files": { 18652 "type": "array", 18653 "items": { 18654 "$ref": "#/definitions/CommitAffectedFiles" 18655 }, 18656 "x-go-name": "Files" 18657 }, 18658 "html_url": { 18659 "type": "string", 18660 "x-go-name": "HTMLURL" 18661 }, 18662 "parents": { 18663 "type": "array", 18664 "items": { 18665 "$ref": "#/definitions/CommitMeta" 18666 }, 18667 "x-go-name": "Parents" 18668 }, 18669 "sha": { 18670 "type": "string", 18671 "x-go-name": "SHA" 18672 }, 18673 "stats": { 18674 "$ref": "#/definitions/CommitStats" 18675 }, 18676 "url": { 18677 "type": "string", 18678 "x-go-name": "URL" 18679 } 18680 }, 18681 "x-go-package": "code.gitea.io/gitea/modules/structs" 18682 }, 18683 "CommitAffectedFiles": { 18684 "description": "CommitAffectedFiles store information about files affected by the commit", 18685 "type": "object", 18686 "properties": { 18687 "filename": { 18688 "type": "string", 18689 "x-go-name": "Filename" 18690 }, 18691 "status": { 18692 "type": "string", 18693 "x-go-name": "Status" 18694 } 18695 }, 18696 "x-go-package": "code.gitea.io/gitea/modules/structs" 18697 }, 18698 "CommitDateOptions": { 18699 "description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE", 18700 "type": "object", 18701 "properties": { 18702 "author": { 18703 "type": "string", 18704 "format": "date-time", 18705 "x-go-name": "Author" 18706 }, 18707 "committer": { 18708 "type": "string", 18709 "format": "date-time", 18710 "x-go-name": "Committer" 18711 } 18712 }, 18713 "x-go-package": "code.gitea.io/gitea/modules/structs" 18714 }, 18715 "CommitMeta": { 18716 "type": "object", 18717 "title": "CommitMeta contains meta information of a commit in terms of API.", 18718 "properties": { 18719 "created": { 18720 "type": "string", 18721 "format": "date-time", 18722 "x-go-name": "Created" 18723 }, 18724 "sha": { 18725 "type": "string", 18726 "x-go-name": "SHA" 18727 }, 18728 "url": { 18729 "type": "string", 18730 "x-go-name": "URL" 18731 } 18732 }, 18733 "x-go-package": "code.gitea.io/gitea/modules/structs" 18734 }, 18735 "CommitStats": { 18736 "description": "CommitStats is statistics for a RepoCommit", 18737 "type": "object", 18738 "properties": { 18739 "additions": { 18740 "type": "integer", 18741 "format": "int64", 18742 "x-go-name": "Additions" 18743 }, 18744 "deletions": { 18745 "type": "integer", 18746 "format": "int64", 18747 "x-go-name": "Deletions" 18748 }, 18749 "total": { 18750 "type": "integer", 18751 "format": "int64", 18752 "x-go-name": "Total" 18753 } 18754 }, 18755 "x-go-package": "code.gitea.io/gitea/modules/structs" 18756 }, 18757 "CommitStatus": { 18758 "description": "CommitStatus holds a single status of a single Commit", 18759 "type": "object", 18760 "properties": { 18761 "context": { 18762 "type": "string", 18763 "x-go-name": "Context" 18764 }, 18765 "created_at": { 18766 "type": "string", 18767 "format": "date-time", 18768 "x-go-name": "Created" 18769 }, 18770 "creator": { 18771 "$ref": "#/definitions/User" 18772 }, 18773 "description": { 18774 "type": "string", 18775 "x-go-name": "Description" 18776 }, 18777 "id": { 18778 "type": "integer", 18779 "format": "int64", 18780 "x-go-name": "ID" 18781 }, 18782 "status": { 18783 "$ref": "#/definitions/CommitStatusState" 18784 }, 18785 "target_url": { 18786 "type": "string", 18787 "x-go-name": "TargetURL" 18788 }, 18789 "updated_at": { 18790 "type": "string", 18791 "format": "date-time", 18792 "x-go-name": "Updated" 18793 }, 18794 "url": { 18795 "type": "string", 18796 "x-go-name": "URL" 18797 } 18798 }, 18799 "x-go-package": "code.gitea.io/gitea/modules/structs" 18800 }, 18801 "CommitStatusState": { 18802 "description": "CommitStatusState holds the state of a CommitStatus\nIt can be \"pending\", \"success\", \"error\" and \"failure\"", 18803 "type": "string", 18804 "x-go-package": "code.gitea.io/gitea/modules/structs" 18805 }, 18806 "CommitUser": { 18807 "type": "object", 18808 "title": "CommitUser contains information of a user in the context of a commit.", 18809 "properties": { 18810 "date": { 18811 "type": "string", 18812 "x-go-name": "Date" 18813 }, 18814 "email": { 18815 "type": "string", 18816 "format": "email", 18817 "x-go-name": "Email" 18818 }, 18819 "name": { 18820 "type": "string", 18821 "x-go-name": "Name" 18822 } 18823 }, 18824 "x-go-package": "code.gitea.io/gitea/modules/structs" 18825 }, 18826 "Compare": { 18827 "type": "object", 18828 "title": "Compare represents a comparison between two commits.", 18829 "properties": { 18830 "commits": { 18831 "type": "array", 18832 "items": { 18833 "$ref": "#/definitions/Commit" 18834 }, 18835 "x-go-name": "Commits" 18836 }, 18837 "total_commits": { 18838 "type": "integer", 18839 "format": "int64", 18840 "x-go-name": "TotalCommits" 18841 } 18842 }, 18843 "x-go-package": "code.gitea.io/gitea/modules/structs" 18844 }, 18845 "ContentsResponse": { 18846 "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content", 18847 "type": "object", 18848 "properties": { 18849 "_links": { 18850 "$ref": "#/definitions/FileLinksResponse" 18851 }, 18852 "content": { 18853 "description": "`content` is populated when `type` is `file`, otherwise null", 18854 "type": "string", 18855 "x-go-name": "Content" 18856 }, 18857 "download_url": { 18858 "type": "string", 18859 "x-go-name": "DownloadURL" 18860 }, 18861 "encoding": { 18862 "description": "`encoding` is populated when `type` is `file`, otherwise null", 18863 "type": "string", 18864 "x-go-name": "Encoding" 18865 }, 18866 "git_url": { 18867 "type": "string", 18868 "x-go-name": "GitURL" 18869 }, 18870 "html_url": { 18871 "type": "string", 18872 "x-go-name": "HTMLURL" 18873 }, 18874 "last_commit_sha": { 18875 "type": "string", 18876 "x-go-name": "LastCommitSHA" 18877 }, 18878 "name": { 18879 "type": "string", 18880 "x-go-name": "Name" 18881 }, 18882 "path": { 18883 "type": "string", 18884 "x-go-name": "Path" 18885 }, 18886 "sha": { 18887 "type": "string", 18888 "x-go-name": "SHA" 18889 }, 18890 "size": { 18891 "type": "integer", 18892 "format": "int64", 18893 "x-go-name": "Size" 18894 }, 18895 "submodule_git_url": { 18896 "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null", 18897 "type": "string", 18898 "x-go-name": "SubmoduleGitURL" 18899 }, 18900 "target": { 18901 "description": "`target` is populated when `type` is `symlink`, otherwise null", 18902 "type": "string", 18903 "x-go-name": "Target" 18904 }, 18905 "type": { 18906 "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`", 18907 "type": "string", 18908 "x-go-name": "Type" 18909 }, 18910 "url": { 18911 "type": "string", 18912 "x-go-name": "URL" 18913 } 18914 }, 18915 "x-go-package": "code.gitea.io/gitea/modules/structs" 18916 }, 18917 "CreateAccessTokenOption": { 18918 "description": "CreateAccessTokenOption options when create access token", 18919 "type": "object", 18920 "required": [ 18921 "name" 18922 ], 18923 "properties": { 18924 "name": { 18925 "type": "string", 18926 "x-go-name": "Name" 18927 }, 18928 "scopes": { 18929 "type": "array", 18930 "items": { 18931 "type": "string" 18932 }, 18933 "x-go-name": "Scopes" 18934 } 18935 }, 18936 "x-go-package": "code.gitea.io/gitea/modules/structs" 18937 }, 18938 "CreateBranchProtectionOption": { 18939 "description": "CreateBranchProtectionOption options for creating a branch protection", 18940 "type": "object", 18941 "properties": { 18942 "approvals_whitelist_teams": { 18943 "type": "array", 18944 "items": { 18945 "type": "string" 18946 }, 18947 "x-go-name": "ApprovalsWhitelistTeams" 18948 }, 18949 "approvals_whitelist_username": { 18950 "type": "array", 18951 "items": { 18952 "type": "string" 18953 }, 18954 "x-go-name": "ApprovalsWhitelistUsernames" 18955 }, 18956 "block_on_official_review_requests": { 18957 "type": "boolean", 18958 "x-go-name": "BlockOnOfficialReviewRequests" 18959 }, 18960 "block_on_outdated_branch": { 18961 "type": "boolean", 18962 "x-go-name": "BlockOnOutdatedBranch" 18963 }, 18964 "block_on_rejected_reviews": { 18965 "type": "boolean", 18966 "x-go-name": "BlockOnRejectedReviews" 18967 }, 18968 "branch_name": { 18969 "description": "Deprecated: true", 18970 "type": "string", 18971 "x-go-name": "BranchName" 18972 }, 18973 "dismiss_stale_approvals": { 18974 "type": "boolean", 18975 "x-go-name": "DismissStaleApprovals" 18976 }, 18977 "enable_approvals_whitelist": { 18978 "type": "boolean", 18979 "x-go-name": "EnableApprovalsWhitelist" 18980 }, 18981 "enable_merge_whitelist": { 18982 "type": "boolean", 18983 "x-go-name": "EnableMergeWhitelist" 18984 }, 18985 "enable_push": { 18986 "type": "boolean", 18987 "x-go-name": "EnablePush" 18988 }, 18989 "enable_push_whitelist": { 18990 "type": "boolean", 18991 "x-go-name": "EnablePushWhitelist" 18992 }, 18993 "enable_status_check": { 18994 "type": "boolean", 18995 "x-go-name": "EnableStatusCheck" 18996 }, 18997 "ignore_stale_approvals": { 18998 "type": "boolean", 18999 "x-go-name": "IgnoreStaleApprovals" 19000 }, 19001 "merge_whitelist_teams": { 19002 "type": "array", 19003 "items": { 19004 "type": "string" 19005 }, 19006 "x-go-name": "MergeWhitelistTeams" 19007 }, 19008 "merge_whitelist_usernames": { 19009 "type": "array", 19010 "items": { 19011 "type": "string" 19012 }, 19013 "x-go-name": "MergeWhitelistUsernames" 19014 }, 19015 "protected_file_patterns": { 19016 "type": "string", 19017 "x-go-name": "ProtectedFilePatterns" 19018 }, 19019 "push_whitelist_deploy_keys": { 19020 "type": "boolean", 19021 "x-go-name": "PushWhitelistDeployKeys" 19022 }, 19023 "push_whitelist_teams": { 19024 "type": "array", 19025 "items": { 19026 "type": "string" 19027 }, 19028 "x-go-name": "PushWhitelistTeams" 19029 }, 19030 "push_whitelist_usernames": { 19031 "type": "array", 19032 "items": { 19033 "type": "string" 19034 }, 19035 "x-go-name": "PushWhitelistUsernames" 19036 }, 19037 "require_signed_commits": { 19038 "type": "boolean", 19039 "x-go-name": "RequireSignedCommits" 19040 }, 19041 "required_approvals": { 19042 "type": "integer", 19043 "format": "int64", 19044 "x-go-name": "RequiredApprovals" 19045 }, 19046 "rule_name": { 19047 "type": "string", 19048 "x-go-name": "RuleName" 19049 }, 19050 "status_check_contexts": { 19051 "type": "array", 19052 "items": { 19053 "type": "string" 19054 }, 19055 "x-go-name": "StatusCheckContexts" 19056 }, 19057 "unprotected_file_patterns": { 19058 "type": "string", 19059 "x-go-name": "UnprotectedFilePatterns" 19060 } 19061 }, 19062 "x-go-package": "code.gitea.io/gitea/modules/structs" 19063 }, 19064 "CreateBranchRepoOption": { 19065 "description": "CreateBranchRepoOption options when creating a branch in a repository", 19066 "type": "object", 19067 "required": [ 19068 "new_branch_name" 19069 ], 19070 "properties": { 19071 "new_branch_name": { 19072 "description": "Name of the branch to create", 19073 "type": "string", 19074 "uniqueItems": true, 19075 "x-go-name": "BranchName" 19076 }, 19077 "old_branch_name": { 19078 "description": "Deprecated: true\nName of the old branch to create from", 19079 "type": "string", 19080 "uniqueItems": true, 19081 "x-go-name": "OldBranchName" 19082 }, 19083 "old_ref_name": { 19084 "description": "Name of the old branch/tag/commit to create from", 19085 "type": "string", 19086 "uniqueItems": true, 19087 "x-go-name": "OldRefName" 19088 } 19089 }, 19090 "x-go-package": "code.gitea.io/gitea/modules/structs" 19091 }, 19092 "CreateEmailOption": { 19093 "description": "CreateEmailOption options when creating email addresses", 19094 "type": "object", 19095 "properties": { 19096 "emails": { 19097 "description": "email addresses to add", 19098 "type": "array", 19099 "items": { 19100 "type": "string" 19101 }, 19102 "x-go-name": "Emails" 19103 } 19104 }, 19105 "x-go-package": "code.gitea.io/gitea/modules/structs" 19106 }, 19107 "CreateFileOptions": { 19108 "description": "CreateFileOptions options for creating files\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)", 19109 "type": "object", 19110 "required": [ 19111 "content" 19112 ], 19113 "properties": { 19114 "author": { 19115 "$ref": "#/definitions/Identity" 19116 }, 19117 "branch": { 19118 "description": "branch (optional) to base this file from. if not given, the default branch is used", 19119 "type": "string", 19120 "x-go-name": "BranchName" 19121 }, 19122 "committer": { 19123 "$ref": "#/definitions/Identity" 19124 }, 19125 "content": { 19126 "description": "content must be base64 encoded", 19127 "type": "string", 19128 "x-go-name": "ContentBase64" 19129 }, 19130 "dates": { 19131 "$ref": "#/definitions/CommitDateOptions" 19132 }, 19133 "message": { 19134 "description": "message (optional) for the commit of this file. if not supplied, a default message will be used", 19135 "type": "string", 19136 "x-go-name": "Message" 19137 }, 19138 "new_branch": { 19139 "description": "new_branch (optional) will make a new branch from `branch` before creating the file", 19140 "type": "string", 19141 "x-go-name": "NewBranchName" 19142 }, 19143 "signoff": { 19144 "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.", 19145 "type": "boolean", 19146 "x-go-name": "Signoff" 19147 } 19148 }, 19149 "x-go-package": "code.gitea.io/gitea/modules/structs" 19150 }, 19151 "CreateForkOption": { 19152 "description": "CreateForkOption options for creating a fork", 19153 "type": "object", 19154 "properties": { 19155 "name": { 19156 "description": "name of the forked repository", 19157 "type": "string", 19158 "x-go-name": "Name" 19159 }, 19160 "organization": { 19161 "description": "organization name, if forking into an organization", 19162 "type": "string", 19163 "x-go-name": "Organization" 19164 } 19165 }, 19166 "x-go-package": "code.gitea.io/gitea/modules/structs" 19167 }, 19168 "CreateGPGKeyOption": { 19169 "description": "CreateGPGKeyOption options create user GPG key", 19170 "type": "object", 19171 "required": [ 19172 "armored_public_key" 19173 ], 19174 "properties": { 19175 "armored_public_key": { 19176 "description": "An armored GPG key to add", 19177 "type": "string", 19178 "uniqueItems": true, 19179 "x-go-name": "ArmoredKey" 19180 }, 19181 "armored_signature": { 19182 "type": "string", 19183 "x-go-name": "Signature" 19184 } 19185 }, 19186 "x-go-package": "code.gitea.io/gitea/modules/structs" 19187 }, 19188 "CreateHookOption": { 19189 "description": "CreateHookOption options when create a hook", 19190 "type": "object", 19191 "required": [ 19192 "type", 19193 "config" 19194 ], 19195 "properties": { 19196 "active": { 19197 "type": "boolean", 19198 "default": false, 19199 "x-go-name": "Active" 19200 }, 19201 "authorization_header": { 19202 "type": "string", 19203 "x-go-name": "AuthorizationHeader" 19204 }, 19205 "branch_filter": { 19206 "type": "string", 19207 "x-go-name": "BranchFilter" 19208 }, 19209 "config": { 19210 "$ref": "#/definitions/CreateHookOptionConfig" 19211 }, 19212 "events": { 19213 "type": "array", 19214 "items": { 19215 "type": "string" 19216 }, 19217 "x-go-name": "Events" 19218 }, 19219 "type": { 19220 "type": "string", 19221 "enum": [ 19222 "dingtalk", 19223 "discord", 19224 "gitea", 19225 "gogs", 19226 "msteams", 19227 "slack", 19228 "telegram", 19229 "feishu", 19230 "wechatwork", 19231 "packagist" 19232 ], 19233 "x-go-name": "Type" 19234 } 19235 }, 19236 "x-go-package": "code.gitea.io/gitea/modules/structs" 19237 }, 19238 "CreateHookOptionConfig": { 19239 "description": "CreateHookOptionConfig has all config options in it\nrequired are \"content_type\" and \"url\" Required", 19240 "type": "object", 19241 "additionalProperties": { 19242 "type": "string" 19243 }, 19244 "x-go-package": "code.gitea.io/gitea/modules/structs" 19245 }, 19246 "CreateIssueCommentOption": { 19247 "description": "CreateIssueCommentOption options for creating a comment on an issue", 19248 "type": "object", 19249 "required": [ 19250 "body" 19251 ], 19252 "properties": { 19253 "body": { 19254 "type": "string", 19255 "x-go-name": "Body" 19256 } 19257 }, 19258 "x-go-package": "code.gitea.io/gitea/modules/structs" 19259 }, 19260 "CreateIssueOption": { 19261 "description": "CreateIssueOption options to create one issue", 19262 "type": "object", 19263 "required": [ 19264 "title" 19265 ], 19266 "properties": { 19267 "assignee": { 19268 "description": "deprecated", 19269 "type": "string", 19270 "x-go-name": "Assignee" 19271 }, 19272 "assignees": { 19273 "type": "array", 19274 "items": { 19275 "type": "string" 19276 }, 19277 "x-go-name": "Assignees" 19278 }, 19279 "body": { 19280 "type": "string", 19281 "x-go-name": "Body" 19282 }, 19283 "closed": { 19284 "type": "boolean", 19285 "x-go-name": "Closed" 19286 }, 19287 "due_date": { 19288 "type": "string", 19289 "format": "date-time", 19290 "x-go-name": "Deadline" 19291 }, 19292 "labels": { 19293 "description": "list of label ids", 19294 "type": "array", 19295 "items": { 19296 "type": "integer", 19297 "format": "int64" 19298 }, 19299 "x-go-name": "Labels" 19300 }, 19301 "milestone": { 19302 "description": "milestone id", 19303 "type": "integer", 19304 "format": "int64", 19305 "x-go-name": "Milestone" 19306 }, 19307 "ref": { 19308 "type": "string", 19309 "x-go-name": "Ref" 19310 }, 19311 "title": { 19312 "type": "string", 19313 "x-go-name": "Title" 19314 } 19315 }, 19316 "x-go-package": "code.gitea.io/gitea/modules/structs" 19317 }, 19318 "CreateKeyOption": { 19319 "description": "CreateKeyOption options when creating a key", 19320 "type": "object", 19321 "required": [ 19322 "title", 19323 "key" 19324 ], 19325 "properties": { 19326 "key": { 19327 "description": "An armored SSH key to add", 19328 "type": "string", 19329 "uniqueItems": true, 19330 "x-go-name": "Key" 19331 }, 19332 "read_only": { 19333 "description": "Describe if the key has only read access or read/write", 19334 "type": "boolean", 19335 "x-go-name": "ReadOnly" 19336 }, 19337 "title": { 19338 "description": "Title of the key to add", 19339 "type": "string", 19340 "uniqueItems": true, 19341 "x-go-name": "Title" 19342 } 19343 }, 19344 "x-go-package": "code.gitea.io/gitea/modules/structs" 19345 }, 19346 "CreateLabelOption": { 19347 "description": "CreateLabelOption options for creating a label", 19348 "type": "object", 19349 "required": [ 19350 "name", 19351 "color" 19352 ], 19353 "properties": { 19354 "color": { 19355 "type": "string", 19356 "x-go-name": "Color", 19357 "example": "#00aabb" 19358 }, 19359 "description": { 19360 "type": "string", 19361 "x-go-name": "Description" 19362 }, 19363 "exclusive": { 19364 "type": "boolean", 19365 "x-go-name": "Exclusive", 19366 "example": false 19367 }, 19368 "is_archived": { 19369 "type": "boolean", 19370 "x-go-name": "IsArchived", 19371 "example": false 19372 }, 19373 "name": { 19374 "type": "string", 19375 "x-go-name": "Name" 19376 } 19377 }, 19378 "x-go-package": "code.gitea.io/gitea/modules/structs" 19379 }, 19380 "CreateMilestoneOption": { 19381 "description": "CreateMilestoneOption options for creating a milestone", 19382 "type": "object", 19383 "properties": { 19384 "description": { 19385 "type": "string", 19386 "x-go-name": "Description" 19387 }, 19388 "due_on": { 19389 "type": "string", 19390 "format": "date-time", 19391 "x-go-name": "Deadline" 19392 }, 19393 "state": { 19394 "type": "string", 19395 "enum": [ 19396 "open", 19397 "closed" 19398 ], 19399 "x-go-name": "State" 19400 }, 19401 "title": { 19402 "type": "string", 19403 "x-go-name": "Title" 19404 } 19405 }, 19406 "x-go-package": "code.gitea.io/gitea/modules/structs" 19407 }, 19408 "CreateOAuth2ApplicationOptions": { 19409 "description": "CreateOAuth2ApplicationOptions holds options to create an oauth2 application", 19410 "type": "object", 19411 "properties": { 19412 "confidential_client": { 19413 "type": "boolean", 19414 "x-go-name": "ConfidentialClient" 19415 }, 19416 "name": { 19417 "type": "string", 19418 "x-go-name": "Name" 19419 }, 19420 "redirect_uris": { 19421 "type": "array", 19422 "items": { 19423 "type": "string" 19424 }, 19425 "x-go-name": "RedirectURIs" 19426 } 19427 }, 19428 "x-go-package": "code.gitea.io/gitea/modules/structs" 19429 }, 19430 "CreateOrUpdateSecretOption": { 19431 "description": "CreateOrUpdateSecretOption options when creating or updating secret", 19432 "type": "object", 19433 "required": [ 19434 "data" 19435 ], 19436 "properties": { 19437 "data": { 19438 "description": "Data of the secret to update", 19439 "type": "string", 19440 "x-go-name": "Data" 19441 } 19442 }, 19443 "x-go-package": "code.gitea.io/gitea/modules/structs" 19444 }, 19445 "CreateOrgOption": { 19446 "description": "CreateOrgOption options for creating an organization", 19447 "type": "object", 19448 "required": [ 19449 "username" 19450 ], 19451 "properties": { 19452 "description": { 19453 "type": "string", 19454 "x-go-name": "Description" 19455 }, 19456 "email": { 19457 "type": "string", 19458 "x-go-name": "Email" 19459 }, 19460 "full_name": { 19461 "type": "string", 19462 "x-go-name": "FullName" 19463 }, 19464 "location": { 19465 "type": "string", 19466 "x-go-name": "Location" 19467 }, 19468 "repo_admin_change_team_access": { 19469 "type": "boolean", 19470 "x-go-name": "RepoAdminChangeTeamAccess" 19471 }, 19472 "username": { 19473 "type": "string", 19474 "x-go-name": "UserName" 19475 }, 19476 "visibility": { 19477 "description": "possible values are `public` (default), `limited` or `private`", 19478 "type": "string", 19479 "enum": [ 19480 "public", 19481 "limited", 19482 "private" 19483 ], 19484 "x-go-name": "Visibility" 19485 }, 19486 "website": { 19487 "type": "string", 19488 "x-go-name": "Website" 19489 } 19490 }, 19491 "x-go-package": "code.gitea.io/gitea/modules/structs" 19492 }, 19493 "CreatePullRequestOption": { 19494 "description": "CreatePullRequestOption options when creating a pull request", 19495 "type": "object", 19496 "properties": { 19497 "assignee": { 19498 "type": "string", 19499 "x-go-name": "Assignee" 19500 }, 19501 "assignees": { 19502 "type": "array", 19503 "items": { 19504 "type": "string" 19505 }, 19506 "x-go-name": "Assignees" 19507 }, 19508 "base": { 19509 "type": "string", 19510 "x-go-name": "Base" 19511 }, 19512 "body": { 19513 "type": "string", 19514 "x-go-name": "Body" 19515 }, 19516 "due_date": { 19517 "type": "string", 19518 "format": "date-time", 19519 "x-go-name": "Deadline" 19520 }, 19521 "head": { 19522 "type": "string", 19523 "x-go-name": "Head" 19524 }, 19525 "labels": { 19526 "type": "array", 19527 "items": { 19528 "type": "integer", 19529 "format": "int64" 19530 }, 19531 "x-go-name": "Labels" 19532 }, 19533 "milestone": { 19534 "type": "integer", 19535 "format": "int64", 19536 "x-go-name": "Milestone" 19537 }, 19538 "title": { 19539 "type": "string", 19540 "x-go-name": "Title" 19541 } 19542 }, 19543 "x-go-package": "code.gitea.io/gitea/modules/structs" 19544 }, 19545 "CreatePullReviewComment": { 19546 "description": "CreatePullReviewComment represent a review comment for creation api", 19547 "type": "object", 19548 "properties": { 19549 "body": { 19550 "type": "string", 19551 "x-go-name": "Body" 19552 }, 19553 "new_position": { 19554 "description": "if comment to new file line or 0", 19555 "type": "integer", 19556 "format": "int64", 19557 "x-go-name": "NewLineNum" 19558 }, 19559 "old_position": { 19560 "description": "if comment to old file line or 0", 19561 "type": "integer", 19562 "format": "int64", 19563 "x-go-name": "OldLineNum" 19564 }, 19565 "path": { 19566 "description": "the tree path", 19567 "type": "string", 19568 "x-go-name": "Path" 19569 } 19570 }, 19571 "x-go-package": "code.gitea.io/gitea/modules/structs" 19572 }, 19573 "CreatePullReviewOptions": { 19574 "description": "CreatePullReviewOptions are options to create a pull review", 19575 "type": "object", 19576 "properties": { 19577 "body": { 19578 "type": "string", 19579 "x-go-name": "Body" 19580 }, 19581 "comments": { 19582 "type": "array", 19583 "items": { 19584 "$ref": "#/definitions/CreatePullReviewComment" 19585 }, 19586 "x-go-name": "Comments" 19587 }, 19588 "commit_id": { 19589 "type": "string", 19590 "x-go-name": "CommitID" 19591 }, 19592 "event": { 19593 "$ref": "#/definitions/ReviewStateType" 19594 } 19595 }, 19596 "x-go-package": "code.gitea.io/gitea/modules/structs" 19597 }, 19598 "CreatePushMirrorOption": { 19599 "type": "object", 19600 "title": "CreatePushMirrorOption represents need information to create a push mirror of a repository.", 19601 "properties": { 19602 "interval": { 19603 "type": "string", 19604 "x-go-name": "Interval" 19605 }, 19606 "remote_address": { 19607 "type": "string", 19608 "x-go-name": "RemoteAddress" 19609 }, 19610 "remote_password": { 19611 "type": "string", 19612 "x-go-name": "RemotePassword" 19613 }, 19614 "remote_username": { 19615 "type": "string", 19616 "x-go-name": "RemoteUsername" 19617 }, 19618 "sync_on_commit": { 19619 "type": "boolean", 19620 "x-go-name": "SyncOnCommit" 19621 } 19622 }, 19623 "x-go-package": "code.gitea.io/gitea/modules/structs" 19624 }, 19625 "CreateReleaseOption": { 19626 "description": "CreateReleaseOption options when creating a release", 19627 "type": "object", 19628 "required": [ 19629 "tag_name" 19630 ], 19631 "properties": { 19632 "body": { 19633 "type": "string", 19634 "x-go-name": "Note" 19635 }, 19636 "draft": { 19637 "type": "boolean", 19638 "x-go-name": "IsDraft" 19639 }, 19640 "name": { 19641 "type": "string", 19642 "x-go-name": "Title" 19643 }, 19644 "prerelease": { 19645 "type": "boolean", 19646 "x-go-name": "IsPrerelease" 19647 }, 19648 "tag_name": { 19649 "type": "string", 19650 "x-go-name": "TagName" 19651 }, 19652 "target_commitish": { 19653 "type": "string", 19654 "x-go-name": "Target" 19655 } 19656 }, 19657 "x-go-package": "code.gitea.io/gitea/modules/structs" 19658 }, 19659 "CreateRepoOption": { 19660 "description": "CreateRepoOption options when creating repository", 19661 "type": "object", 19662 "required": [ 19663 "name" 19664 ], 19665 "properties": { 19666 "auto_init": { 19667 "description": "Whether the repository should be auto-initialized?", 19668 "type": "boolean", 19669 "x-go-name": "AutoInit" 19670 }, 19671 "default_branch": { 19672 "description": "DefaultBranch of the repository (used when initializes and in template)", 19673 "type": "string", 19674 "x-go-name": "DefaultBranch" 19675 }, 19676 "description": { 19677 "description": "Description of the repository to create", 19678 "type": "string", 19679 "x-go-name": "Description" 19680 }, 19681 "gitignores": { 19682 "description": "Gitignores to use", 19683 "type": "string", 19684 "x-go-name": "Gitignores" 19685 }, 19686 "issue_labels": { 19687 "description": "Label-Set to use", 19688 "type": "string", 19689 "x-go-name": "IssueLabels" 19690 }, 19691 "license": { 19692 "description": "License to use", 19693 "type": "string", 19694 "x-go-name": "License" 19695 }, 19696 "name": { 19697 "description": "Name of the repository to create", 19698 "type": "string", 19699 "uniqueItems": true, 19700 "x-go-name": "Name" 19701 }, 19702 "object_format_name": { 19703 "description": "ObjectFormatName of the underlying git repository", 19704 "type": "string", 19705 "enum": [ 19706 "sha1", 19707 "sha256" 19708 ], 19709 "x-go-name": "ObjectFormatName" 19710 }, 19711 "private": { 19712 "description": "Whether the repository is private", 19713 "type": "boolean", 19714 "x-go-name": "Private" 19715 }, 19716 "readme": { 19717 "description": "Readme of the repository to create", 19718 "type": "string", 19719 "x-go-name": "Readme" 19720 }, 19721 "template": { 19722 "description": "Whether the repository is template", 19723 "type": "boolean", 19724 "x-go-name": "Template" 19725 }, 19726 "trust_model": { 19727 "description": "TrustModel of the repository", 19728 "type": "string", 19729 "enum": [ 19730 "default", 19731 "collaborator", 19732 "committer", 19733 "collaboratorcommitter" 19734 ], 19735 "x-go-name": "TrustModel" 19736 } 19737 }, 19738 "x-go-package": "code.gitea.io/gitea/modules/structs" 19739 }, 19740 "CreateStatusOption": { 19741 "description": "CreateStatusOption holds the information needed to create a new CommitStatus for a Commit", 19742 "type": "object", 19743 "properties": { 19744 "context": { 19745 "type": "string", 19746 "x-go-name": "Context" 19747 }, 19748 "description": { 19749 "type": "string", 19750 "x-go-name": "Description" 19751 }, 19752 "state": { 19753 "$ref": "#/definitions/CommitStatusState" 19754 }, 19755 "target_url": { 19756 "type": "string", 19757 "x-go-name": "TargetURL" 19758 } 19759 }, 19760 "x-go-package": "code.gitea.io/gitea/modules/structs" 19761 }, 19762 "CreateTagOption": { 19763 "description": "CreateTagOption options when creating a tag", 19764 "type": "object", 19765 "required": [ 19766 "tag_name" 19767 ], 19768 "properties": { 19769 "message": { 19770 "type": "string", 19771 "x-go-name": "Message" 19772 }, 19773 "tag_name": { 19774 "type": "string", 19775 "x-go-name": "TagName" 19776 }, 19777 "target": { 19778 "type": "string", 19779 "x-go-name": "Target" 19780 } 19781 }, 19782 "x-go-package": "code.gitea.io/gitea/modules/structs" 19783 }, 19784 "CreateTeamOption": { 19785 "description": "CreateTeamOption options for creating a team", 19786 "type": "object", 19787 "required": [ 19788 "name" 19789 ], 19790 "properties": { 19791 "can_create_org_repo": { 19792 "type": "boolean", 19793 "x-go-name": "CanCreateOrgRepo" 19794 }, 19795 "description": { 19796 "type": "string", 19797 "x-go-name": "Description" 19798 }, 19799 "includes_all_repositories": { 19800 "type": "boolean", 19801 "x-go-name": "IncludesAllRepositories" 19802 }, 19803 "name": { 19804 "type": "string", 19805 "x-go-name": "Name" 19806 }, 19807 "permission": { 19808 "type": "string", 19809 "enum": [ 19810 "read", 19811 "write", 19812 "admin" 19813 ], 19814 "x-go-name": "Permission" 19815 }, 19816 "units": { 19817 "type": "array", 19818 "items": { 19819 "type": "string" 19820 }, 19821 "x-go-name": "Units", 19822 "example": [ 19823 "repo.actions", 19824 "repo.code", 19825 "repo.issues", 19826 "repo.ext_issues", 19827 "repo.wiki", 19828 "repo.ext_wiki", 19829 "repo.pulls", 19830 "repo.releases", 19831 "repo.projects", 19832 "repo.ext_wiki" 19833 ] 19834 }, 19835 "units_map": { 19836 "type": "object", 19837 "additionalProperties": { 19838 "type": "string" 19839 }, 19840 "x-go-name": "UnitsMap", 19841 "example": "{\"repo.actions\",\"repo.packages\",\"repo.code\":\"read\",\"repo.issues\":\"write\",\"repo.ext_issues\":\"none\",\"repo.wiki\":\"admin\",\"repo.pulls\":\"owner\",\"repo.releases\":\"none\",\"repo.projects\":\"none\",\"repo.ext_wiki\":\"none\"}" 19842 } 19843 }, 19844 "x-go-package": "code.gitea.io/gitea/modules/structs" 19845 }, 19846 "CreateUserOption": { 19847 "description": "CreateUserOption create user options", 19848 "type": "object", 19849 "required": [ 19850 "username", 19851 "email" 19852 ], 19853 "properties": { 19854 "created_at": { 19855 "description": "For explicitly setting the user creation timestamp. Useful when users are\nmigrated from other systems. When omitted, the user's creation timestamp\nwill be set to \"now\".", 19856 "type": "string", 19857 "format": "date-time", 19858 "x-go-name": "Created" 19859 }, 19860 "email": { 19861 "type": "string", 19862 "format": "email", 19863 "x-go-name": "Email" 19864 }, 19865 "full_name": { 19866 "type": "string", 19867 "x-go-name": "FullName" 19868 }, 19869 "login_name": { 19870 "type": "string", 19871 "x-go-name": "LoginName" 19872 }, 19873 "must_change_password": { 19874 "type": "boolean", 19875 "x-go-name": "MustChangePassword" 19876 }, 19877 "password": { 19878 "type": "string", 19879 "x-go-name": "Password" 19880 }, 19881 "restricted": { 19882 "type": "boolean", 19883 "x-go-name": "Restricted" 19884 }, 19885 "send_notify": { 19886 "type": "boolean", 19887 "x-go-name": "SendNotify" 19888 }, 19889 "source_id": { 19890 "type": "integer", 19891 "format": "int64", 19892 "x-go-name": "SourceID" 19893 }, 19894 "username": { 19895 "type": "string", 19896 "x-go-name": "Username" 19897 }, 19898 "visibility": { 19899 "type": "string", 19900 "x-go-name": "Visibility" 19901 } 19902 }, 19903 "x-go-package": "code.gitea.io/gitea/modules/structs" 19904 }, 19905 "CreateVariableOption": { 19906 "description": "CreateVariableOption the option when creating variable", 19907 "type": "object", 19908 "required": [ 19909 "value" 19910 ], 19911 "properties": { 19912 "value": { 19913 "description": "Value of the variable to create", 19914 "type": "string", 19915 "x-go-name": "Value" 19916 } 19917 }, 19918 "x-go-package": "code.gitea.io/gitea/modules/structs" 19919 }, 19920 "CreateWikiPageOptions": { 19921 "description": "CreateWikiPageOptions form for creating wiki", 19922 "type": "object", 19923 "properties": { 19924 "content_base64": { 19925 "description": "content must be base64 encoded", 19926 "type": "string", 19927 "x-go-name": "ContentBase64" 19928 }, 19929 "message": { 19930 "description": "optional commit message summarizing the change", 19931 "type": "string", 19932 "x-go-name": "Message" 19933 }, 19934 "title": { 19935 "description": "page title. leave empty to keep unchanged", 19936 "type": "string", 19937 "x-go-name": "Title" 19938 } 19939 }, 19940 "x-go-package": "code.gitea.io/gitea/modules/structs" 19941 }, 19942 "Cron": { 19943 "description": "Cron represents a Cron task", 19944 "type": "object", 19945 "properties": { 19946 "exec_times": { 19947 "type": "integer", 19948 "format": "int64", 19949 "x-go-name": "ExecTimes" 19950 }, 19951 "name": { 19952 "type": "string", 19953 "x-go-name": "Name" 19954 }, 19955 "next": { 19956 "type": "string", 19957 "format": "date-time", 19958 "x-go-name": "Next" 19959 }, 19960 "prev": { 19961 "type": "string", 19962 "format": "date-time", 19963 "x-go-name": "Prev" 19964 }, 19965 "schedule": { 19966 "type": "string", 19967 "x-go-name": "Schedule" 19968 } 19969 }, 19970 "x-go-package": "code.gitea.io/gitea/modules/structs" 19971 }, 19972 "DeleteEmailOption": { 19973 "description": "DeleteEmailOption options when deleting email addresses", 19974 "type": "object", 19975 "properties": { 19976 "emails": { 19977 "description": "email addresses to delete", 19978 "type": "array", 19979 "items": { 19980 "type": "string" 19981 }, 19982 "x-go-name": "Emails" 19983 } 19984 }, 19985 "x-go-package": "code.gitea.io/gitea/modules/structs" 19986 }, 19987 "DeleteFileOptions": { 19988 "description": "DeleteFileOptions options for deleting files (used for other File structs below)\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)", 19989 "type": "object", 19990 "required": [ 19991 "sha" 19992 ], 19993 "properties": { 19994 "author": { 19995 "$ref": "#/definitions/Identity" 19996 }, 19997 "branch": { 19998 "description": "branch (optional) to base this file from. if not given, the default branch is used", 19999 "type": "string", 20000 "x-go-name": "BranchName" 20001 }, 20002 "committer": { 20003 "$ref": "#/definitions/Identity" 20004 }, 20005 "dates": { 20006 "$ref": "#/definitions/CommitDateOptions" 20007 }, 20008 "message": { 20009 "description": "message (optional) for the commit of this file. if not supplied, a default message will be used", 20010 "type": "string", 20011 "x-go-name": "Message" 20012 }, 20013 "new_branch": { 20014 "description": "new_branch (optional) will make a new branch from `branch` before creating the file", 20015 "type": "string", 20016 "x-go-name": "NewBranchName" 20017 }, 20018 "sha": { 20019 "description": "sha is the SHA for the file that already exists", 20020 "type": "string", 20021 "x-go-name": "SHA" 20022 }, 20023 "signoff": { 20024 "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.", 20025 "type": "boolean", 20026 "x-go-name": "Signoff" 20027 } 20028 }, 20029 "x-go-package": "code.gitea.io/gitea/modules/structs" 20030 }, 20031 "DeployKey": { 20032 "description": "DeployKey a deploy key", 20033 "type": "object", 20034 "properties": { 20035 "created_at": { 20036 "type": "string", 20037 "format": "date-time", 20038 "x-go-name": "Created" 20039 }, 20040 "fingerprint": { 20041 "type": "string", 20042 "x-go-name": "Fingerprint" 20043 }, 20044 "id": { 20045 "type": "integer", 20046 "format": "int64", 20047 "x-go-name": "ID" 20048 }, 20049 "key": { 20050 "type": "string", 20051 "x-go-name": "Key" 20052 }, 20053 "key_id": { 20054 "type": "integer", 20055 "format": "int64", 20056 "x-go-name": "KeyID" 20057 }, 20058 "read_only": { 20059 "type": "boolean", 20060 "x-go-name": "ReadOnly" 20061 }, 20062 "repository": { 20063 "$ref": "#/definitions/Repository" 20064 }, 20065 "title": { 20066 "type": "string", 20067 "x-go-name": "Title" 20068 }, 20069 "url": { 20070 "type": "string", 20071 "x-go-name": "URL" 20072 } 20073 }, 20074 "x-go-package": "code.gitea.io/gitea/modules/structs" 20075 }, 20076 "DismissPullReviewOptions": { 20077 "description": "DismissPullReviewOptions are options to dismiss a pull review", 20078 "type": "object", 20079 "properties": { 20080 "message": { 20081 "type": "string", 20082 "x-go-name": "Message" 20083 }, 20084 "priors": { 20085 "type": "boolean", 20086 "x-go-name": "Priors" 20087 } 20088 }, 20089 "x-go-package": "code.gitea.io/gitea/modules/structs" 20090 }, 20091 "EditAttachmentOptions": { 20092 "description": "EditAttachmentOptions options for editing attachments", 20093 "type": "object", 20094 "properties": { 20095 "name": { 20096 "type": "string", 20097 "x-go-name": "Name" 20098 } 20099 }, 20100 "x-go-package": "code.gitea.io/gitea/modules/structs" 20101 }, 20102 "EditBranchProtectionOption": { 20103 "description": "EditBranchProtectionOption options for editing a branch protection", 20104 "type": "object", 20105 "properties": { 20106 "approvals_whitelist_teams": { 20107 "type": "array", 20108 "items": { 20109 "type": "string" 20110 }, 20111 "x-go-name": "ApprovalsWhitelistTeams" 20112 }, 20113 "approvals_whitelist_username": { 20114 "type": "array", 20115 "items": { 20116 "type": "string" 20117 }, 20118 "x-go-name": "ApprovalsWhitelistUsernames" 20119 }, 20120 "block_on_official_review_requests": { 20121 "type": "boolean", 20122 "x-go-name": "BlockOnOfficialReviewRequests" 20123 }, 20124 "block_on_outdated_branch": { 20125 "type": "boolean", 20126 "x-go-name": "BlockOnOutdatedBranch" 20127 }, 20128 "block_on_rejected_reviews": { 20129 "type": "boolean", 20130 "x-go-name": "BlockOnRejectedReviews" 20131 }, 20132 "dismiss_stale_approvals": { 20133 "type": "boolean", 20134 "x-go-name": "DismissStaleApprovals" 20135 }, 20136 "enable_approvals_whitelist": { 20137 "type": "boolean", 20138 "x-go-name": "EnableApprovalsWhitelist" 20139 }, 20140 "enable_merge_whitelist": { 20141 "type": "boolean", 20142 "x-go-name": "EnableMergeWhitelist" 20143 }, 20144 "enable_push": { 20145 "type": "boolean", 20146 "x-go-name": "EnablePush" 20147 }, 20148 "enable_push_whitelist": { 20149 "type": "boolean", 20150 "x-go-name": "EnablePushWhitelist" 20151 }, 20152 "enable_status_check": { 20153 "type": "boolean", 20154 "x-go-name": "EnableStatusCheck" 20155 }, 20156 "ignore_stale_approvals": { 20157 "type": "boolean", 20158 "x-go-name": "IgnoreStaleApprovals" 20159 }, 20160 "merge_whitelist_teams": { 20161 "type": "array", 20162 "items": { 20163 "type": "string" 20164 }, 20165 "x-go-name": "MergeWhitelistTeams" 20166 }, 20167 "merge_whitelist_usernames": { 20168 "type": "array", 20169 "items": { 20170 "type": "string" 20171 }, 20172 "x-go-name": "MergeWhitelistUsernames" 20173 }, 20174 "protected_file_patterns": { 20175 "type": "string", 20176 "x-go-name": "ProtectedFilePatterns" 20177 }, 20178 "push_whitelist_deploy_keys": { 20179 "type": "boolean", 20180 "x-go-name": "PushWhitelistDeployKeys" 20181 }, 20182 "push_whitelist_teams": { 20183 "type": "array", 20184 "items": { 20185 "type": "string" 20186 }, 20187 "x-go-name": "PushWhitelistTeams" 20188 }, 20189 "push_whitelist_usernames": { 20190 "type": "array", 20191 "items": { 20192 "type": "string" 20193 }, 20194 "x-go-name": "PushWhitelistUsernames" 20195 }, 20196 "require_signed_commits": { 20197 "type": "boolean", 20198 "x-go-name": "RequireSignedCommits" 20199 }, 20200 "required_approvals": { 20201 "type": "integer", 20202 "format": "int64", 20203 "x-go-name": "RequiredApprovals" 20204 }, 20205 "status_check_contexts": { 20206 "type": "array", 20207 "items": { 20208 "type": "string" 20209 }, 20210 "x-go-name": "StatusCheckContexts" 20211 }, 20212 "unprotected_file_patterns": { 20213 "type": "string", 20214 "x-go-name": "UnprotectedFilePatterns" 20215 } 20216 }, 20217 "x-go-package": "code.gitea.io/gitea/modules/structs" 20218 }, 20219 "EditDeadlineOption": { 20220 "description": "EditDeadlineOption options for creating a deadline", 20221 "type": "object", 20222 "required": [ 20223 "due_date" 20224 ], 20225 "properties": { 20226 "due_date": { 20227 "type": "string", 20228 "format": "date-time", 20229 "x-go-name": "Deadline" 20230 } 20231 }, 20232 "x-go-package": "code.gitea.io/gitea/modules/structs" 20233 }, 20234 "EditGitHookOption": { 20235 "description": "EditGitHookOption options when modifying one Git hook", 20236 "type": "object", 20237 "properties": { 20238 "content": { 20239 "type": "string", 20240 "x-go-name": "Content" 20241 } 20242 }, 20243 "x-go-package": "code.gitea.io/gitea/modules/structs" 20244 }, 20245 "EditHookOption": { 20246 "description": "EditHookOption options when modify one hook", 20247 "type": "object", 20248 "properties": { 20249 "active": { 20250 "type": "boolean", 20251 "x-go-name": "Active" 20252 }, 20253 "authorization_header": { 20254 "type": "string", 20255 "x-go-name": "AuthorizationHeader" 20256 }, 20257 "branch_filter": { 20258 "type": "string", 20259 "x-go-name": "BranchFilter" 20260 }, 20261 "config": { 20262 "type": "object", 20263 "additionalProperties": { 20264 "type": "string" 20265 }, 20266 "x-go-name": "Config" 20267 }, 20268 "events": { 20269 "type": "array", 20270 "items": { 20271 "type": "string" 20272 }, 20273 "x-go-name": "Events" 20274 } 20275 }, 20276 "x-go-package": "code.gitea.io/gitea/modules/structs" 20277 }, 20278 "EditIssueCommentOption": { 20279 "description": "EditIssueCommentOption options for editing a comment", 20280 "type": "object", 20281 "required": [ 20282 "body" 20283 ], 20284 "properties": { 20285 "body": { 20286 "type": "string", 20287 "x-go-name": "Body" 20288 } 20289 }, 20290 "x-go-package": "code.gitea.io/gitea/modules/structs" 20291 }, 20292 "EditIssueOption": { 20293 "description": "EditIssueOption options for editing an issue", 20294 "type": "object", 20295 "properties": { 20296 "assignee": { 20297 "description": "deprecated", 20298 "type": "string", 20299 "x-go-name": "Assignee" 20300 }, 20301 "assignees": { 20302 "type": "array", 20303 "items": { 20304 "type": "string" 20305 }, 20306 "x-go-name": "Assignees" 20307 }, 20308 "body": { 20309 "type": "string", 20310 "x-go-name": "Body" 20311 }, 20312 "due_date": { 20313 "type": "string", 20314 "format": "date-time", 20315 "x-go-name": "Deadline" 20316 }, 20317 "milestone": { 20318 "type": "integer", 20319 "format": "int64", 20320 "x-go-name": "Milestone" 20321 }, 20322 "ref": { 20323 "type": "string", 20324 "x-go-name": "Ref" 20325 }, 20326 "state": { 20327 "type": "string", 20328 "x-go-name": "State" 20329 }, 20330 "title": { 20331 "type": "string", 20332 "x-go-name": "Title" 20333 }, 20334 "unset_due_date": { 20335 "type": "boolean", 20336 "x-go-name": "RemoveDeadline" 20337 } 20338 }, 20339 "x-go-package": "code.gitea.io/gitea/modules/structs" 20340 }, 20341 "EditLabelOption": { 20342 "description": "EditLabelOption options for editing a label", 20343 "type": "object", 20344 "properties": { 20345 "color": { 20346 "type": "string", 20347 "x-go-name": "Color", 20348 "example": "#00aabb" 20349 }, 20350 "description": { 20351 "type": "string", 20352 "x-go-name": "Description" 20353 }, 20354 "exclusive": { 20355 "type": "boolean", 20356 "x-go-name": "Exclusive", 20357 "example": false 20358 }, 20359 "is_archived": { 20360 "type": "boolean", 20361 "x-go-name": "IsArchived", 20362 "example": false 20363 }, 20364 "name": { 20365 "type": "string", 20366 "x-go-name": "Name" 20367 } 20368 }, 20369 "x-go-package": "code.gitea.io/gitea/modules/structs" 20370 }, 20371 "EditMilestoneOption": { 20372 "description": "EditMilestoneOption options for editing a milestone", 20373 "type": "object", 20374 "properties": { 20375 "description": { 20376 "type": "string", 20377 "x-go-name": "Description" 20378 }, 20379 "due_on": { 20380 "type": "string", 20381 "format": "date-time", 20382 "x-go-name": "Deadline" 20383 }, 20384 "state": { 20385 "type": "string", 20386 "x-go-name": "State" 20387 }, 20388 "title": { 20389 "type": "string", 20390 "x-go-name": "Title" 20391 } 20392 }, 20393 "x-go-package": "code.gitea.io/gitea/modules/structs" 20394 }, 20395 "EditOrgOption": { 20396 "description": "EditOrgOption options for editing an organization", 20397 "type": "object", 20398 "properties": { 20399 "description": { 20400 "type": "string", 20401 "x-go-name": "Description" 20402 }, 20403 "email": { 20404 "type": "string", 20405 "x-go-name": "Email" 20406 }, 20407 "full_name": { 20408 "type": "string", 20409 "x-go-name": "FullName" 20410 }, 20411 "location": { 20412 "type": "string", 20413 "x-go-name": "Location" 20414 }, 20415 "repo_admin_change_team_access": { 20416 "type": "boolean", 20417 "x-go-name": "RepoAdminChangeTeamAccess" 20418 }, 20419 "visibility": { 20420 "description": "possible values are `public`, `limited` or `private`", 20421 "type": "string", 20422 "enum": [ 20423 "public", 20424 "limited", 20425 "private" 20426 ], 20427 "x-go-name": "Visibility" 20428 }, 20429 "website": { 20430 "type": "string", 20431 "x-go-name": "Website" 20432 } 20433 }, 20434 "x-go-package": "code.gitea.io/gitea/modules/structs" 20435 }, 20436 "EditPullRequestOption": { 20437 "description": "EditPullRequestOption options when modify pull request", 20438 "type": "object", 20439 "properties": { 20440 "allow_maintainer_edit": { 20441 "type": "boolean", 20442 "x-go-name": "AllowMaintainerEdit" 20443 }, 20444 "assignee": { 20445 "type": "string", 20446 "x-go-name": "Assignee" 20447 }, 20448 "assignees": { 20449 "type": "array", 20450 "items": { 20451 "type": "string" 20452 }, 20453 "x-go-name": "Assignees" 20454 }, 20455 "base": { 20456 "type": "string", 20457 "x-go-name": "Base" 20458 }, 20459 "body": { 20460 "type": "string", 20461 "x-go-name": "Body" 20462 }, 20463 "due_date": { 20464 "type": "string", 20465 "format": "date-time", 20466 "x-go-name": "Deadline" 20467 }, 20468 "labels": { 20469 "type": "array", 20470 "items": { 20471 "type": "integer", 20472 "format": "int64" 20473 }, 20474 "x-go-name": "Labels" 20475 }, 20476 "milestone": { 20477 "type": "integer", 20478 "format": "int64", 20479 "x-go-name": "Milestone" 20480 }, 20481 "state": { 20482 "type": "string", 20483 "x-go-name": "State" 20484 }, 20485 "title": { 20486 "type": "string", 20487 "x-go-name": "Title" 20488 }, 20489 "unset_due_date": { 20490 "type": "boolean", 20491 "x-go-name": "RemoveDeadline" 20492 } 20493 }, 20494 "x-go-package": "code.gitea.io/gitea/modules/structs" 20495 }, 20496 "EditReactionOption": { 20497 "description": "EditReactionOption contain the reaction type", 20498 "type": "object", 20499 "properties": { 20500 "content": { 20501 "type": "string", 20502 "x-go-name": "Reaction" 20503 } 20504 }, 20505 "x-go-package": "code.gitea.io/gitea/modules/structs" 20506 }, 20507 "EditReleaseOption": { 20508 "description": "EditReleaseOption options when editing a release", 20509 "type": "object", 20510 "properties": { 20511 "body": { 20512 "type": "string", 20513 "x-go-name": "Note" 20514 }, 20515 "draft": { 20516 "type": "boolean", 20517 "x-go-name": "IsDraft" 20518 }, 20519 "name": { 20520 "type": "string", 20521 "x-go-name": "Title" 20522 }, 20523 "prerelease": { 20524 "type": "boolean", 20525 "x-go-name": "IsPrerelease" 20526 }, 20527 "tag_name": { 20528 "type": "string", 20529 "x-go-name": "TagName" 20530 }, 20531 "target_commitish": { 20532 "type": "string", 20533 "x-go-name": "Target" 20534 } 20535 }, 20536 "x-go-package": "code.gitea.io/gitea/modules/structs" 20537 }, 20538 "EditRepoOption": { 20539 "description": "EditRepoOption options when editing a repository's properties", 20540 "type": "object", 20541 "properties": { 20542 "allow_fast_forward_only_merge": { 20543 "description": "either `true` to allow fast-forward-only merging pull requests, or `false` to prevent fast-forward-only merging.", 20544 "type": "boolean", 20545 "x-go-name": "AllowFastForwardOnly" 20546 }, 20547 "allow_manual_merge": { 20548 "description": "either `true` to allow mark pr as merged manually, or `false` to prevent it.", 20549 "type": "boolean", 20550 "x-go-name": "AllowManualMerge" 20551 }, 20552 "allow_merge_commits": { 20553 "description": "either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", 20554 "type": "boolean", 20555 "x-go-name": "AllowMerge" 20556 }, 20557 "allow_rebase": { 20558 "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", 20559 "type": "boolean", 20560 "x-go-name": "AllowRebase" 20561 }, 20562 "allow_rebase_explicit": { 20563 "description": "either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits.", 20564 "type": "boolean", 20565 "x-go-name": "AllowRebaseMerge" 20566 }, 20567 "allow_rebase_update": { 20568 "description": "either `true` to allow updating pull request branch by rebase, or `false` to prevent it.", 20569 "type": "boolean", 20570 "x-go-name": "AllowRebaseUpdate" 20571 }, 20572 "allow_squash_merge": { 20573 "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", 20574 "type": "boolean", 20575 "x-go-name": "AllowSquash" 20576 }, 20577 "archived": { 20578 "description": "set to `true` to archive this repository.", 20579 "type": "boolean", 20580 "x-go-name": "Archived" 20581 }, 20582 "autodetect_manual_merge": { 20583 "description": "either `true` to enable AutodetectManualMerge, or `false` to prevent it. Note: In some special cases, misjudgments can occur.", 20584 "type": "boolean", 20585 "x-go-name": "AutodetectManualMerge" 20586 }, 20587 "default_allow_maintainer_edit": { 20588 "description": "set to `true` to allow edits from maintainers by default", 20589 "type": "boolean", 20590 "x-go-name": "DefaultAllowMaintainerEdit" 20591 }, 20592 "default_branch": { 20593 "description": "sets the default branch for this repository.", 20594 "type": "string", 20595 "x-go-name": "DefaultBranch" 20596 }, 20597 "default_delete_branch_after_merge": { 20598 "description": "set to `true` to delete pr branch after merge by default", 20599 "type": "boolean", 20600 "x-go-name": "DefaultDeleteBranchAfterMerge" 20601 }, 20602 "default_merge_style": { 20603 "description": "set to a merge style to be used by this repository: \"merge\", \"rebase\", \"rebase-merge\", \"squash\", or \"fast-forward-only\".", 20604 "type": "string", 20605 "x-go-name": "DefaultMergeStyle" 20606 }, 20607 "description": { 20608 "description": "a short description of the repository.", 20609 "type": "string", 20610 "x-go-name": "Description" 20611 }, 20612 "enable_prune": { 20613 "description": "enable prune - remove obsolete remote-tracking references when mirroring", 20614 "type": "boolean", 20615 "x-go-name": "EnablePrune" 20616 }, 20617 "external_tracker": { 20618 "$ref": "#/definitions/ExternalTracker" 20619 }, 20620 "external_wiki": { 20621 "$ref": "#/definitions/ExternalWiki" 20622 }, 20623 "has_actions": { 20624 "description": "either `true` to enable actions unit, or `false` to disable them.", 20625 "type": "boolean", 20626 "x-go-name": "HasActions" 20627 }, 20628 "has_issues": { 20629 "description": "either `true` to enable issues for this repository or `false` to disable them.", 20630 "type": "boolean", 20631 "x-go-name": "HasIssues" 20632 }, 20633 "has_packages": { 20634 "description": "either `true` to enable packages unit, or `false` to disable them.", 20635 "type": "boolean", 20636 "x-go-name": "HasPackages" 20637 }, 20638 "has_projects": { 20639 "description": "either `true` to enable project unit, or `false` to disable them.", 20640 "type": "boolean", 20641 "x-go-name": "HasProjects" 20642 }, 20643 "has_pull_requests": { 20644 "description": "either `true` to allow pull requests, or `false` to prevent pull request.", 20645 "type": "boolean", 20646 "x-go-name": "HasPullRequests" 20647 }, 20648 "has_releases": { 20649 "description": "either `true` to enable releases unit, or `false` to disable them.", 20650 "type": "boolean", 20651 "x-go-name": "HasReleases" 20652 }, 20653 "has_wiki": { 20654 "description": "either `true` to enable the wiki for this repository or `false` to disable it.", 20655 "type": "boolean", 20656 "x-go-name": "HasWiki" 20657 }, 20658 "ignore_whitespace_conflicts": { 20659 "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace.", 20660 "type": "boolean", 20661 "x-go-name": "IgnoreWhitespaceConflicts" 20662 }, 20663 "internal_tracker": { 20664 "$ref": "#/definitions/InternalTracker" 20665 }, 20666 "mirror_interval": { 20667 "description": "set to a string like `8h30m0s` to set the mirror interval time", 20668 "type": "string", 20669 "x-go-name": "MirrorInterval" 20670 }, 20671 "name": { 20672 "description": "name of the repository", 20673 "type": "string", 20674 "uniqueItems": true, 20675 "x-go-name": "Name" 20676 }, 20677 "private": { 20678 "description": "either `true` to make the repository private or `false` to make it public.\nNote: you will get a 422 error if the organization restricts changing repository visibility to organization\nowners and a non-owner tries to change the value of private.", 20679 "type": "boolean", 20680 "x-go-name": "Private" 20681 }, 20682 "projects_mode": { 20683 "description": "`repo` to only allow repo-level projects, `owner` to only allow owner projects, `all` to allow both.", 20684 "type": "string", 20685 "x-go-name": "ProjectsMode" 20686 }, 20687 "template": { 20688 "description": "either `true` to make this repository a template or `false` to make it a normal repository", 20689 "type": "boolean", 20690 "x-go-name": "Template" 20691 }, 20692 "website": { 20693 "description": "a URL with more information about the repository.", 20694 "type": "string", 20695 "x-go-name": "Website" 20696 } 20697 }, 20698 "x-go-package": "code.gitea.io/gitea/modules/structs" 20699 }, 20700 "EditTeamOption": { 20701 "description": "EditTeamOption options for editing a team", 20702 "type": "object", 20703 "required": [ 20704 "name" 20705 ], 20706 "properties": { 20707 "can_create_org_repo": { 20708 "type": "boolean", 20709 "x-go-name": "CanCreateOrgRepo" 20710 }, 20711 "description": { 20712 "type": "string", 20713 "x-go-name": "Description" 20714 }, 20715 "includes_all_repositories": { 20716 "type": "boolean", 20717 "x-go-name": "IncludesAllRepositories" 20718 }, 20719 "name": { 20720 "type": "string", 20721 "x-go-name": "Name" 20722 }, 20723 "permission": { 20724 "type": "string", 20725 "enum": [ 20726 "read", 20727 "write", 20728 "admin" 20729 ], 20730 "x-go-name": "Permission" 20731 }, 20732 "units": { 20733 "type": "array", 20734 "items": { 20735 "type": "string" 20736 }, 20737 "x-go-name": "Units", 20738 "example": [ 20739 "repo.code", 20740 "repo.issues", 20741 "repo.ext_issues", 20742 "repo.wiki", 20743 "repo.pulls", 20744 "repo.releases", 20745 "repo.projects", 20746 "repo.ext_wiki" 20747 ] 20748 }, 20749 "units_map": { 20750 "type": "object", 20751 "additionalProperties": { 20752 "type": "string" 20753 }, 20754 "x-go-name": "UnitsMap", 20755 "example": { 20756 "repo.code": "read", 20757 "repo.ext_issues": "none", 20758 "repo.ext_wiki": "none", 20759 "repo.issues": "write", 20760 "repo.projects": "none", 20761 "repo.pulls": "owner", 20762 "repo.releases": "none", 20763 "repo.wiki": "admin" 20764 } 20765 } 20766 }, 20767 "x-go-package": "code.gitea.io/gitea/modules/structs" 20768 }, 20769 "EditUserOption": { 20770 "description": "EditUserOption edit user options", 20771 "type": "object", 20772 "required": [ 20773 "source_id", 20774 "login_name" 20775 ], 20776 "properties": { 20777 "active": { 20778 "type": "boolean", 20779 "x-go-name": "Active" 20780 }, 20781 "admin": { 20782 "type": "boolean", 20783 "x-go-name": "Admin" 20784 }, 20785 "allow_create_organization": { 20786 "type": "boolean", 20787 "x-go-name": "AllowCreateOrganization" 20788 }, 20789 "allow_git_hook": { 20790 "type": "boolean", 20791 "x-go-name": "AllowGitHook" 20792 }, 20793 "allow_import_local": { 20794 "type": "boolean", 20795 "x-go-name": "AllowImportLocal" 20796 }, 20797 "description": { 20798 "type": "string", 20799 "x-go-name": "Description" 20800 }, 20801 "email": { 20802 "type": "string", 20803 "format": "email", 20804 "x-go-name": "Email" 20805 }, 20806 "full_name": { 20807 "type": "string", 20808 "x-go-name": "FullName" 20809 }, 20810 "location": { 20811 "type": "string", 20812 "x-go-name": "Location" 20813 }, 20814 "login_name": { 20815 "type": "string", 20816 "x-go-name": "LoginName" 20817 }, 20818 "max_repo_creation": { 20819 "type": "integer", 20820 "format": "int64", 20821 "x-go-name": "MaxRepoCreation" 20822 }, 20823 "must_change_password": { 20824 "type": "boolean", 20825 "x-go-name": "MustChangePassword" 20826 }, 20827 "password": { 20828 "type": "string", 20829 "x-go-name": "Password" 20830 }, 20831 "prohibit_login": { 20832 "type": "boolean", 20833 "x-go-name": "ProhibitLogin" 20834 }, 20835 "restricted": { 20836 "type": "boolean", 20837 "x-go-name": "Restricted" 20838 }, 20839 "source_id": { 20840 "type": "integer", 20841 "format": "int64", 20842 "x-go-name": "SourceID" 20843 }, 20844 "visibility": { 20845 "type": "string", 20846 "x-go-name": "Visibility" 20847 }, 20848 "website": { 20849 "type": "string", 20850 "x-go-name": "Website" 20851 } 20852 }, 20853 "x-go-package": "code.gitea.io/gitea/modules/structs" 20854 }, 20855 "Email": { 20856 "description": "Email an email address belonging to a user", 20857 "type": "object", 20858 "properties": { 20859 "email": { 20860 "type": "string", 20861 "format": "email", 20862 "x-go-name": "Email" 20863 }, 20864 "primary": { 20865 "type": "boolean", 20866 "x-go-name": "Primary" 20867 }, 20868 "user_id": { 20869 "type": "integer", 20870 "format": "int64", 20871 "x-go-name": "UserID" 20872 }, 20873 "username": { 20874 "type": "string", 20875 "x-go-name": "UserName" 20876 }, 20877 "verified": { 20878 "type": "boolean", 20879 "x-go-name": "Verified" 20880 } 20881 }, 20882 "x-go-package": "code.gitea.io/gitea/modules/structs" 20883 }, 20884 "ExternalTracker": { 20885 "description": "ExternalTracker represents settings for external tracker", 20886 "type": "object", 20887 "properties": { 20888 "external_tracker_format": { 20889 "description": "External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.", 20890 "type": "string", 20891 "x-go-name": "ExternalTrackerFormat" 20892 }, 20893 "external_tracker_regexp_pattern": { 20894 "description": "External Issue Tracker issue regular expression", 20895 "type": "string", 20896 "x-go-name": "ExternalTrackerRegexpPattern" 20897 }, 20898 "external_tracker_style": { 20899 "description": "External Issue Tracker Number Format, either `numeric`, `alphanumeric`, or `regexp`", 20900 "type": "string", 20901 "x-go-name": "ExternalTrackerStyle" 20902 }, 20903 "external_tracker_url": { 20904 "description": "URL of external issue tracker.", 20905 "type": "string", 20906 "x-go-name": "ExternalTrackerURL" 20907 } 20908 }, 20909 "x-go-package": "code.gitea.io/gitea/modules/structs" 20910 }, 20911 "ExternalWiki": { 20912 "description": "ExternalWiki represents setting for external wiki", 20913 "type": "object", 20914 "properties": { 20915 "external_wiki_url": { 20916 "description": "URL of external wiki.", 20917 "type": "string", 20918 "x-go-name": "ExternalWikiURL" 20919 } 20920 }, 20921 "x-go-package": "code.gitea.io/gitea/modules/structs" 20922 }, 20923 "FileCommitResponse": { 20924 "type": "object", 20925 "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.", 20926 "properties": { 20927 "author": { 20928 "$ref": "#/definitions/CommitUser" 20929 }, 20930 "committer": { 20931 "$ref": "#/definitions/CommitUser" 20932 }, 20933 "created": { 20934 "type": "string", 20935 "format": "date-time", 20936 "x-go-name": "Created" 20937 }, 20938 "html_url": { 20939 "type": "string", 20940 "x-go-name": "HTMLURL" 20941 }, 20942 "message": { 20943 "type": "string", 20944 "x-go-name": "Message" 20945 }, 20946 "parents": { 20947 "type": "array", 20948 "items": { 20949 "$ref": "#/definitions/CommitMeta" 20950 }, 20951 "x-go-name": "Parents" 20952 }, 20953 "sha": { 20954 "type": "string", 20955 "x-go-name": "SHA" 20956 }, 20957 "tree": { 20958 "$ref": "#/definitions/CommitMeta" 20959 }, 20960 "url": { 20961 "type": "string", 20962 "x-go-name": "URL" 20963 } 20964 }, 20965 "x-go-package": "code.gitea.io/gitea/modules/structs" 20966 }, 20967 "FileDeleteResponse": { 20968 "description": "FileDeleteResponse contains information about a repo's file that was deleted", 20969 "type": "object", 20970 "properties": { 20971 "commit": { 20972 "$ref": "#/definitions/FileCommitResponse" 20973 }, 20974 "content": { 20975 "x-go-name": "Content" 20976 }, 20977 "verification": { 20978 "$ref": "#/definitions/PayloadCommitVerification" 20979 } 20980 }, 20981 "x-go-package": "code.gitea.io/gitea/modules/structs" 20982 }, 20983 "FileLinksResponse": { 20984 "description": "FileLinksResponse contains the links for a repo's file", 20985 "type": "object", 20986 "properties": { 20987 "git": { 20988 "type": "string", 20989 "x-go-name": "GitURL" 20990 }, 20991 "html": { 20992 "type": "string", 20993 "x-go-name": "HTMLURL" 20994 }, 20995 "self": { 20996 "type": "string", 20997 "x-go-name": "Self" 20998 } 20999 }, 21000 "x-go-package": "code.gitea.io/gitea/modules/structs" 21001 }, 21002 "FileResponse": { 21003 "description": "FileResponse contains information about a repo's file", 21004 "type": "object", 21005 "properties": { 21006 "commit": { 21007 "$ref": "#/definitions/FileCommitResponse" 21008 }, 21009 "content": { 21010 "$ref": "#/definitions/ContentsResponse" 21011 }, 21012 "verification": { 21013 "$ref": "#/definitions/PayloadCommitVerification" 21014 } 21015 }, 21016 "x-go-package": "code.gitea.io/gitea/modules/structs" 21017 }, 21018 "FilesResponse": { 21019 "description": "FilesResponse contains information about multiple files from a repo", 21020 "type": "object", 21021 "properties": { 21022 "commit": { 21023 "$ref": "#/definitions/FileCommitResponse" 21024 }, 21025 "files": { 21026 "type": "array", 21027 "items": { 21028 "$ref": "#/definitions/ContentsResponse" 21029 }, 21030 "x-go-name": "Files" 21031 }, 21032 "verification": { 21033 "$ref": "#/definitions/PayloadCommitVerification" 21034 } 21035 }, 21036 "x-go-package": "code.gitea.io/gitea/modules/structs" 21037 }, 21038 "GPGKey": { 21039 "description": "GPGKey a user GPG key to sign commit and tag in repository", 21040 "type": "object", 21041 "properties": { 21042 "can_certify": { 21043 "type": "boolean", 21044 "x-go-name": "CanCertify" 21045 }, 21046 "can_encrypt_comms": { 21047 "type": "boolean", 21048 "x-go-name": "CanEncryptComms" 21049 }, 21050 "can_encrypt_storage": { 21051 "type": "boolean", 21052 "x-go-name": "CanEncryptStorage" 21053 }, 21054 "can_sign": { 21055 "type": "boolean", 21056 "x-go-name": "CanSign" 21057 }, 21058 "created_at": { 21059 "type": "string", 21060 "format": "date-time", 21061 "x-go-name": "Created" 21062 }, 21063 "emails": { 21064 "type": "array", 21065 "items": { 21066 "$ref": "#/definitions/GPGKeyEmail" 21067 }, 21068 "x-go-name": "Emails" 21069 }, 21070 "expires_at": { 21071 "type": "string", 21072 "format": "date-time", 21073 "x-go-name": "Expires" 21074 }, 21075 "id": { 21076 "type": "integer", 21077 "format": "int64", 21078 "x-go-name": "ID" 21079 }, 21080 "key_id": { 21081 "type": "string", 21082 "x-go-name": "KeyID" 21083 }, 21084 "primary_key_id": { 21085 "type": "string", 21086 "x-go-name": "PrimaryKeyID" 21087 }, 21088 "public_key": { 21089 "type": "string", 21090 "x-go-name": "PublicKey" 21091 }, 21092 "subkeys": { 21093 "type": "array", 21094 "items": { 21095 "$ref": "#/definitions/GPGKey" 21096 }, 21097 "x-go-name": "SubsKey" 21098 }, 21099 "verified": { 21100 "type": "boolean", 21101 "x-go-name": "Verified" 21102 } 21103 }, 21104 "x-go-package": "code.gitea.io/gitea/modules/structs" 21105 }, 21106 "GPGKeyEmail": { 21107 "description": "GPGKeyEmail an email attached to a GPGKey", 21108 "type": "object", 21109 "properties": { 21110 "email": { 21111 "type": "string", 21112 "x-go-name": "Email" 21113 }, 21114 "verified": { 21115 "type": "boolean", 21116 "x-go-name": "Verified" 21117 } 21118 }, 21119 "x-go-package": "code.gitea.io/gitea/modules/structs" 21120 }, 21121 "GeneralAPISettings": { 21122 "description": "GeneralAPISettings contains global api settings exposed by it", 21123 "type": "object", 21124 "properties": { 21125 "default_git_trees_per_page": { 21126 "type": "integer", 21127 "format": "int64", 21128 "x-go-name": "DefaultGitTreesPerPage" 21129 }, 21130 "default_max_blob_size": { 21131 "type": "integer", 21132 "format": "int64", 21133 "x-go-name": "DefaultMaxBlobSize" 21134 }, 21135 "default_paging_num": { 21136 "type": "integer", 21137 "format": "int64", 21138 "x-go-name": "DefaultPagingNum" 21139 }, 21140 "max_response_items": { 21141 "type": "integer", 21142 "format": "int64", 21143 "x-go-name": "MaxResponseItems" 21144 } 21145 }, 21146 "x-go-package": "code.gitea.io/gitea/modules/structs" 21147 }, 21148 "GeneralAttachmentSettings": { 21149 "description": "GeneralAttachmentSettings contains global Attachment settings exposed by API", 21150 "type": "object", 21151 "properties": { 21152 "allowed_types": { 21153 "type": "string", 21154 "x-go-name": "AllowedTypes" 21155 }, 21156 "enabled": { 21157 "type": "boolean", 21158 "x-go-name": "Enabled" 21159 }, 21160 "max_files": { 21161 "type": "integer", 21162 "format": "int64", 21163 "x-go-name": "MaxFiles" 21164 }, 21165 "max_size": { 21166 "type": "integer", 21167 "format": "int64", 21168 "x-go-name": "MaxSize" 21169 } 21170 }, 21171 "x-go-package": "code.gitea.io/gitea/modules/structs" 21172 }, 21173 "GeneralRepoSettings": { 21174 "description": "GeneralRepoSettings contains global repository settings exposed by API", 21175 "type": "object", 21176 "properties": { 21177 "http_git_disabled": { 21178 "type": "boolean", 21179 "x-go-name": "HTTPGitDisabled" 21180 }, 21181 "lfs_disabled": { 21182 "type": "boolean", 21183 "x-go-name": "LFSDisabled" 21184 }, 21185 "migrations_disabled": { 21186 "type": "boolean", 21187 "x-go-name": "MigrationsDisabled" 21188 }, 21189 "mirrors_disabled": { 21190 "type": "boolean", 21191 "x-go-name": "MirrorsDisabled" 21192 }, 21193 "stars_disabled": { 21194 "type": "boolean", 21195 "x-go-name": "StarsDisabled" 21196 }, 21197 "time_tracking_disabled": { 21198 "type": "boolean", 21199 "x-go-name": "TimeTrackingDisabled" 21200 } 21201 }, 21202 "x-go-package": "code.gitea.io/gitea/modules/structs" 21203 }, 21204 "GeneralUISettings": { 21205 "description": "GeneralUISettings contains global ui settings exposed by API", 21206 "type": "object", 21207 "properties": { 21208 "allowed_reactions": { 21209 "type": "array", 21210 "items": { 21211 "type": "string" 21212 }, 21213 "x-go-name": "AllowedReactions" 21214 }, 21215 "custom_emojis": { 21216 "type": "array", 21217 "items": { 21218 "type": "string" 21219 }, 21220 "x-go-name": "CustomEmojis" 21221 }, 21222 "default_theme": { 21223 "type": "string", 21224 "x-go-name": "DefaultTheme" 21225 } 21226 }, 21227 "x-go-package": "code.gitea.io/gitea/modules/structs" 21228 }, 21229 "GenerateRepoOption": { 21230 "description": "GenerateRepoOption options when creating repository using a template", 21231 "type": "object", 21232 "required": [ 21233 "owner", 21234 "name" 21235 ], 21236 "properties": { 21237 "avatar": { 21238 "description": "include avatar of the template repo", 21239 "type": "boolean", 21240 "x-go-name": "Avatar" 21241 }, 21242 "default_branch": { 21243 "description": "Default branch of the new repository", 21244 "type": "string", 21245 "x-go-name": "DefaultBranch" 21246 }, 21247 "description": { 21248 "description": "Description of the repository to create", 21249 "type": "string", 21250 "x-go-name": "Description" 21251 }, 21252 "git_content": { 21253 "description": "include git content of default branch in template repo", 21254 "type": "boolean", 21255 "x-go-name": "GitContent" 21256 }, 21257 "git_hooks": { 21258 "description": "include git hooks in template repo", 21259 "type": "boolean", 21260 "x-go-name": "GitHooks" 21261 }, 21262 "labels": { 21263 "description": "include labels in template repo", 21264 "type": "boolean", 21265 "x-go-name": "Labels" 21266 }, 21267 "name": { 21268 "description": "Name of the repository to create", 21269 "type": "string", 21270 "uniqueItems": true, 21271 "x-go-name": "Name" 21272 }, 21273 "owner": { 21274 "description": "The organization or person who will own the new repository", 21275 "type": "string", 21276 "x-go-name": "Owner" 21277 }, 21278 "private": { 21279 "description": "Whether the repository is private", 21280 "type": "boolean", 21281 "x-go-name": "Private" 21282 }, 21283 "protected_branch": { 21284 "description": "include protected branches in template repo", 21285 "type": "boolean", 21286 "x-go-name": "ProtectedBranch" 21287 }, 21288 "topics": { 21289 "description": "include topics in template repo", 21290 "type": "boolean", 21291 "x-go-name": "Topics" 21292 }, 21293 "webhooks": { 21294 "description": "include webhooks in template repo", 21295 "type": "boolean", 21296 "x-go-name": "Webhooks" 21297 } 21298 }, 21299 "x-go-package": "code.gitea.io/gitea/modules/structs" 21300 }, 21301 "GitBlobResponse": { 21302 "description": "GitBlobResponse represents a git blob", 21303 "type": "object", 21304 "properties": { 21305 "content": { 21306 "type": "string", 21307 "x-go-name": "Content" 21308 }, 21309 "encoding": { 21310 "type": "string", 21311 "x-go-name": "Encoding" 21312 }, 21313 "sha": { 21314 "type": "string", 21315 "x-go-name": "SHA" 21316 }, 21317 "size": { 21318 "type": "integer", 21319 "format": "int64", 21320 "x-go-name": "Size" 21321 }, 21322 "url": { 21323 "type": "string", 21324 "x-go-name": "URL" 21325 } 21326 }, 21327 "x-go-package": "code.gitea.io/gitea/modules/structs" 21328 }, 21329 "GitEntry": { 21330 "description": "GitEntry represents a git tree", 21331 "type": "object", 21332 "properties": { 21333 "mode": { 21334 "type": "string", 21335 "x-go-name": "Mode" 21336 }, 21337 "path": { 21338 "type": "string", 21339 "x-go-name": "Path" 21340 }, 21341 "sha": { 21342 "type": "string", 21343 "x-go-name": "SHA" 21344 }, 21345 "size": { 21346 "type": "integer", 21347 "format": "int64", 21348 "x-go-name": "Size" 21349 }, 21350 "type": { 21351 "type": "string", 21352 "x-go-name": "Type" 21353 }, 21354 "url": { 21355 "type": "string", 21356 "x-go-name": "URL" 21357 } 21358 }, 21359 "x-go-package": "code.gitea.io/gitea/modules/structs" 21360 }, 21361 "GitHook": { 21362 "description": "GitHook represents a Git repository hook", 21363 "type": "object", 21364 "properties": { 21365 "content": { 21366 "type": "string", 21367 "x-go-name": "Content" 21368 }, 21369 "is_active": { 21370 "type": "boolean", 21371 "x-go-name": "IsActive" 21372 }, 21373 "name": { 21374 "type": "string", 21375 "x-go-name": "Name" 21376 } 21377 }, 21378 "x-go-package": "code.gitea.io/gitea/modules/structs" 21379 }, 21380 "GitObject": { 21381 "type": "object", 21382 "title": "GitObject represents a Git object.", 21383 "properties": { 21384 "sha": { 21385 "type": "string", 21386 "x-go-name": "SHA" 21387 }, 21388 "type": { 21389 "type": "string", 21390 "x-go-name": "Type" 21391 }, 21392 "url": { 21393 "type": "string", 21394 "x-go-name": "URL" 21395 } 21396 }, 21397 "x-go-package": "code.gitea.io/gitea/modules/structs" 21398 }, 21399 "GitTreeResponse": { 21400 "description": "GitTreeResponse returns a git tree", 21401 "type": "object", 21402 "properties": { 21403 "page": { 21404 "type": "integer", 21405 "format": "int64", 21406 "x-go-name": "Page" 21407 }, 21408 "sha": { 21409 "type": "string", 21410 "x-go-name": "SHA" 21411 }, 21412 "total_count": { 21413 "type": "integer", 21414 "format": "int64", 21415 "x-go-name": "TotalCount" 21416 }, 21417 "tree": { 21418 "type": "array", 21419 "items": { 21420 "$ref": "#/definitions/GitEntry" 21421 }, 21422 "x-go-name": "Entries" 21423 }, 21424 "truncated": { 21425 "type": "boolean", 21426 "x-go-name": "Truncated" 21427 }, 21428 "url": { 21429 "type": "string", 21430 "x-go-name": "URL" 21431 } 21432 }, 21433 "x-go-package": "code.gitea.io/gitea/modules/structs" 21434 }, 21435 "GitignoreTemplateInfo": { 21436 "description": "GitignoreTemplateInfo name and text of a gitignore template", 21437 "type": "object", 21438 "properties": { 21439 "name": { 21440 "type": "string", 21441 "x-go-name": "Name" 21442 }, 21443 "source": { 21444 "type": "string", 21445 "x-go-name": "Source" 21446 } 21447 }, 21448 "x-go-package": "code.gitea.io/gitea/modules/structs" 21449 }, 21450 "Hook": { 21451 "description": "Hook a hook is a web hook when one repository changed", 21452 "type": "object", 21453 "properties": { 21454 "active": { 21455 "type": "boolean", 21456 "x-go-name": "Active" 21457 }, 21458 "authorization_header": { 21459 "type": "string", 21460 "x-go-name": "AuthorizationHeader" 21461 }, 21462 "branch_filter": { 21463 "type": "string", 21464 "x-go-name": "BranchFilter" 21465 }, 21466 "config": { 21467 "type": "object", 21468 "additionalProperties": { 21469 "type": "string" 21470 }, 21471 "x-go-name": "Config" 21472 }, 21473 "created_at": { 21474 "type": "string", 21475 "format": "date-time", 21476 "x-go-name": "Created" 21477 }, 21478 "events": { 21479 "type": "array", 21480 "items": { 21481 "type": "string" 21482 }, 21483 "x-go-name": "Events" 21484 }, 21485 "id": { 21486 "type": "integer", 21487 "format": "int64", 21488 "x-go-name": "ID" 21489 }, 21490 "type": { 21491 "type": "string", 21492 "x-go-name": "Type" 21493 }, 21494 "updated_at": { 21495 "type": "string", 21496 "format": "date-time", 21497 "x-go-name": "Updated" 21498 } 21499 }, 21500 "x-go-package": "code.gitea.io/gitea/modules/structs" 21501 }, 21502 "Identity": { 21503 "description": "Identity for a person's identity like an author or committer", 21504 "type": "object", 21505 "properties": { 21506 "email": { 21507 "type": "string", 21508 "format": "email", 21509 "x-go-name": "Email" 21510 }, 21511 "name": { 21512 "type": "string", 21513 "x-go-name": "Name" 21514 } 21515 }, 21516 "x-go-package": "code.gitea.io/gitea/modules/structs" 21517 }, 21518 "InternalTracker": { 21519 "description": "InternalTracker represents settings for internal tracker", 21520 "type": "object", 21521 "properties": { 21522 "allow_only_contributors_to_track_time": { 21523 "description": "Let only contributors track time (Built-in issue tracker)", 21524 "type": "boolean", 21525 "x-go-name": "AllowOnlyContributorsToTrackTime" 21526 }, 21527 "enable_issue_dependencies": { 21528 "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)", 21529 "type": "boolean", 21530 "x-go-name": "EnableIssueDependencies" 21531 }, 21532 "enable_time_tracker": { 21533 "description": "Enable time tracking (Built-in issue tracker)", 21534 "type": "boolean", 21535 "x-go-name": "EnableTimeTracker" 21536 } 21537 }, 21538 "x-go-package": "code.gitea.io/gitea/modules/structs" 21539 }, 21540 "Issue": { 21541 "description": "Issue represents an issue in a repository", 21542 "type": "object", 21543 "properties": { 21544 "assets": { 21545 "type": "array", 21546 "items": { 21547 "$ref": "#/definitions/Attachment" 21548 }, 21549 "x-go-name": "Attachments" 21550 }, 21551 "assignee": { 21552 "$ref": "#/definitions/User" 21553 }, 21554 "assignees": { 21555 "type": "array", 21556 "items": { 21557 "$ref": "#/definitions/User" 21558 }, 21559 "x-go-name": "Assignees" 21560 }, 21561 "body": { 21562 "type": "string", 21563 "x-go-name": "Body" 21564 }, 21565 "closed_at": { 21566 "type": "string", 21567 "format": "date-time", 21568 "x-go-name": "Closed" 21569 }, 21570 "comments": { 21571 "type": "integer", 21572 "format": "int64", 21573 "x-go-name": "Comments" 21574 }, 21575 "created_at": { 21576 "type": "string", 21577 "format": "date-time", 21578 "x-go-name": "Created" 21579 }, 21580 "due_date": { 21581 "type": "string", 21582 "format": "date-time", 21583 "x-go-name": "Deadline" 21584 }, 21585 "html_url": { 21586 "type": "string", 21587 "x-go-name": "HTMLURL" 21588 }, 21589 "id": { 21590 "type": "integer", 21591 "format": "int64", 21592 "x-go-name": "ID" 21593 }, 21594 "is_locked": { 21595 "type": "boolean", 21596 "x-go-name": "IsLocked" 21597 }, 21598 "labels": { 21599 "type": "array", 21600 "items": { 21601 "$ref": "#/definitions/Label" 21602 }, 21603 "x-go-name": "Labels" 21604 }, 21605 "milestone": { 21606 "$ref": "#/definitions/Milestone" 21607 }, 21608 "number": { 21609 "type": "integer", 21610 "format": "int64", 21611 "x-go-name": "Index" 21612 }, 21613 "original_author": { 21614 "type": "string", 21615 "x-go-name": "OriginalAuthor" 21616 }, 21617 "original_author_id": { 21618 "type": "integer", 21619 "format": "int64", 21620 "x-go-name": "OriginalAuthorID" 21621 }, 21622 "pin_order": { 21623 "type": "integer", 21624 "format": "int64", 21625 "x-go-name": "PinOrder" 21626 }, 21627 "pull_request": { 21628 "$ref": "#/definitions/PullRequestMeta" 21629 }, 21630 "ref": { 21631 "type": "string", 21632 "x-go-name": "Ref" 21633 }, 21634 "repository": { 21635 "$ref": "#/definitions/RepositoryMeta" 21636 }, 21637 "state": { 21638 "$ref": "#/definitions/StateType" 21639 }, 21640 "title": { 21641 "type": "string", 21642 "x-go-name": "Title" 21643 }, 21644 "updated_at": { 21645 "type": "string", 21646 "format": "date-time", 21647 "x-go-name": "Updated" 21648 }, 21649 "url": { 21650 "type": "string", 21651 "x-go-name": "URL" 21652 }, 21653 "user": { 21654 "$ref": "#/definitions/User" 21655 } 21656 }, 21657 "x-go-package": "code.gitea.io/gitea/modules/structs" 21658 }, 21659 "IssueConfig": { 21660 "type": "object", 21661 "properties": { 21662 "blank_issues_enabled": { 21663 "type": "boolean", 21664 "x-go-name": "BlankIssuesEnabled" 21665 }, 21666 "contact_links": { 21667 "type": "array", 21668 "items": { 21669 "$ref": "#/definitions/IssueConfigContactLink" 21670 }, 21671 "x-go-name": "ContactLinks" 21672 } 21673 }, 21674 "x-go-package": "code.gitea.io/gitea/modules/structs" 21675 }, 21676 "IssueConfigContactLink": { 21677 "type": "object", 21678 "properties": { 21679 "about": { 21680 "type": "string", 21681 "x-go-name": "About" 21682 }, 21683 "name": { 21684 "type": "string", 21685 "x-go-name": "Name" 21686 }, 21687 "url": { 21688 "type": "string", 21689 "x-go-name": "URL" 21690 } 21691 }, 21692 "x-go-package": "code.gitea.io/gitea/modules/structs" 21693 }, 21694 "IssueConfigValidation": { 21695 "type": "object", 21696 "properties": { 21697 "message": { 21698 "type": "string", 21699 "x-go-name": "Message" 21700 }, 21701 "valid": { 21702 "type": "boolean", 21703 "x-go-name": "Valid" 21704 } 21705 }, 21706 "x-go-package": "code.gitea.io/gitea/modules/structs" 21707 }, 21708 "IssueDeadline": { 21709 "description": "IssueDeadline represents an issue deadline", 21710 "type": "object", 21711 "properties": { 21712 "due_date": { 21713 "type": "string", 21714 "format": "date-time", 21715 "x-go-name": "Deadline" 21716 } 21717 }, 21718 "x-go-package": "code.gitea.io/gitea/modules/structs" 21719 }, 21720 "IssueFormField": { 21721 "description": "IssueFormField represents a form field", 21722 "type": "object", 21723 "properties": { 21724 "attributes": { 21725 "type": "object", 21726 "additionalProperties": {}, 21727 "x-go-name": "Attributes" 21728 }, 21729 "id": { 21730 "type": "string", 21731 "x-go-name": "ID" 21732 }, 21733 "type": { 21734 "$ref": "#/definitions/IssueFormFieldType" 21735 }, 21736 "validations": { 21737 "type": "object", 21738 "additionalProperties": {}, 21739 "x-go-name": "Validations" 21740 }, 21741 "visible": { 21742 "type": "array", 21743 "items": { 21744 "$ref": "#/definitions/IssueFormFieldVisible" 21745 }, 21746 "x-go-name": "Visible" 21747 } 21748 }, 21749 "x-go-package": "code.gitea.io/gitea/modules/structs" 21750 }, 21751 "IssueFormFieldType": { 21752 "type": "string", 21753 "title": "IssueFormFieldType defines issue form field type, can be \"markdown\", \"textarea\", \"input\", \"dropdown\" or \"checkboxes\"", 21754 "x-go-package": "code.gitea.io/gitea/modules/structs" 21755 }, 21756 "IssueFormFieldVisible": { 21757 "description": "IssueFormFieldVisible defines issue form field visible", 21758 "type": "string", 21759 "x-go-package": "code.gitea.io/gitea/modules/structs" 21760 }, 21761 "IssueLabelsOption": { 21762 "description": "IssueLabelsOption a collection of labels", 21763 "type": "object", 21764 "properties": { 21765 "labels": { 21766 "description": "Labels can be a list of integers representing label IDs\nor a list of strings representing label names", 21767 "type": "array", 21768 "items": {}, 21769 "x-go-name": "Labels" 21770 } 21771 }, 21772 "x-go-package": "code.gitea.io/gitea/modules/structs" 21773 }, 21774 "IssueMeta": { 21775 "description": "IssueMeta basic issue information", 21776 "type": "object", 21777 "properties": { 21778 "index": { 21779 "type": "integer", 21780 "format": "int64", 21781 "x-go-name": "Index" 21782 }, 21783 "owner": { 21784 "type": "string", 21785 "x-go-name": "Owner" 21786 }, 21787 "repo": { 21788 "type": "string", 21789 "x-go-name": "Name" 21790 } 21791 }, 21792 "x-go-package": "code.gitea.io/gitea/modules/structs" 21793 }, 21794 "IssueTemplate": { 21795 "description": "IssueTemplate represents an issue template for a repository", 21796 "type": "object", 21797 "properties": { 21798 "about": { 21799 "type": "string", 21800 "x-go-name": "About" 21801 }, 21802 "body": { 21803 "type": "array", 21804 "items": { 21805 "$ref": "#/definitions/IssueFormField" 21806 }, 21807 "x-go-name": "Fields" 21808 }, 21809 "content": { 21810 "type": "string", 21811 "x-go-name": "Content" 21812 }, 21813 "file_name": { 21814 "type": "string", 21815 "x-go-name": "FileName" 21816 }, 21817 "labels": { 21818 "$ref": "#/definitions/IssueTemplateLabels" 21819 }, 21820 "name": { 21821 "type": "string", 21822 "x-go-name": "Name" 21823 }, 21824 "ref": { 21825 "type": "string", 21826 "x-go-name": "Ref" 21827 }, 21828 "title": { 21829 "type": "string", 21830 "x-go-name": "Title" 21831 } 21832 }, 21833 "x-go-package": "code.gitea.io/gitea/modules/structs" 21834 }, 21835 "IssueTemplateLabels": { 21836 "type": "array", 21837 "items": { 21838 "type": "string" 21839 }, 21840 "x-go-package": "code.gitea.io/gitea/modules/structs" 21841 }, 21842 "Label": { 21843 "description": "Label a label to an issue or a pr", 21844 "type": "object", 21845 "properties": { 21846 "color": { 21847 "type": "string", 21848 "x-go-name": "Color", 21849 "example": "00aabb" 21850 }, 21851 "description": { 21852 "type": "string", 21853 "x-go-name": "Description" 21854 }, 21855 "exclusive": { 21856 "type": "boolean", 21857 "x-go-name": "Exclusive", 21858 "example": false 21859 }, 21860 "id": { 21861 "type": "integer", 21862 "format": "int64", 21863 "x-go-name": "ID" 21864 }, 21865 "is_archived": { 21866 "type": "boolean", 21867 "x-go-name": "IsArchived", 21868 "example": false 21869 }, 21870 "name": { 21871 "type": "string", 21872 "x-go-name": "Name" 21873 }, 21874 "url": { 21875 "type": "string", 21876 "x-go-name": "URL" 21877 } 21878 }, 21879 "x-go-package": "code.gitea.io/gitea/modules/structs" 21880 }, 21881 "LabelTemplate": { 21882 "description": "LabelTemplate info of a Label template", 21883 "type": "object", 21884 "properties": { 21885 "color": { 21886 "type": "string", 21887 "x-go-name": "Color", 21888 "example": "00aabb" 21889 }, 21890 "description": { 21891 "type": "string", 21892 "x-go-name": "Description" 21893 }, 21894 "exclusive": { 21895 "type": "boolean", 21896 "x-go-name": "Exclusive", 21897 "example": false 21898 }, 21899 "name": { 21900 "type": "string", 21901 "x-go-name": "Name" 21902 } 21903 }, 21904 "x-go-package": "code.gitea.io/gitea/modules/structs" 21905 }, 21906 "LicenseTemplateInfo": { 21907 "description": "LicensesInfo contains information about a License", 21908 "type": "object", 21909 "properties": { 21910 "body": { 21911 "type": "string", 21912 "x-go-name": "Body" 21913 }, 21914 "implementation": { 21915 "type": "string", 21916 "x-go-name": "Implementation" 21917 }, 21918 "key": { 21919 "type": "string", 21920 "x-go-name": "Key" 21921 }, 21922 "name": { 21923 "type": "string", 21924 "x-go-name": "Name" 21925 }, 21926 "url": { 21927 "type": "string", 21928 "x-go-name": "URL" 21929 } 21930 }, 21931 "x-go-package": "code.gitea.io/gitea/modules/structs" 21932 }, 21933 "LicensesTemplateListEntry": { 21934 "description": "LicensesListEntry is used for the API", 21935 "type": "object", 21936 "properties": { 21937 "key": { 21938 "type": "string", 21939 "x-go-name": "Key" 21940 }, 21941 "name": { 21942 "type": "string", 21943 "x-go-name": "Name" 21944 }, 21945 "url": { 21946 "type": "string", 21947 "x-go-name": "URL" 21948 } 21949 }, 21950 "x-go-package": "code.gitea.io/gitea/modules/structs" 21951 }, 21952 "MarkdownOption": { 21953 "description": "MarkdownOption markdown options", 21954 "type": "object", 21955 "properties": { 21956 "Context": { 21957 "description": "URL path for rendering issue, media and file links\nExpected format: /subpath/{user}/{repo}/src/{branch, commit, tag}/{identifier/path}/{file/dir}\n\nin: body", 21958 "type": "string" 21959 }, 21960 "Mode": { 21961 "description": "Mode to render (comment, gfm, markdown)\n\nin: body", 21962 "type": "string" 21963 }, 21964 "Text": { 21965 "description": "Text markdown to render\n\nin: body", 21966 "type": "string" 21967 }, 21968 "Wiki": { 21969 "description": "Is it a wiki page ?\n\nin: body", 21970 "type": "boolean" 21971 } 21972 }, 21973 "x-go-package": "code.gitea.io/gitea/modules/structs" 21974 }, 21975 "MarkupOption": { 21976 "description": "MarkupOption markup options", 21977 "type": "object", 21978 "properties": { 21979 "Context": { 21980 "description": "URL path for rendering issue, media and file links\nExpected format: /subpath/{user}/{repo}/src/{branch, commit, tag}/{identifier/path}/{file/dir}\n\nin: body", 21981 "type": "string" 21982 }, 21983 "FilePath": { 21984 "description": "File path for detecting extension in file mode\n\nin: body", 21985 "type": "string" 21986 }, 21987 "Mode": { 21988 "description": "Mode to render (comment, gfm, markdown, file)\n\nin: body", 21989 "type": "string" 21990 }, 21991 "Text": { 21992 "description": "Text markup to render\n\nin: body", 21993 "type": "string" 21994 }, 21995 "Wiki": { 21996 "description": "Is it a wiki page ?\n\nin: body", 21997 "type": "boolean" 21998 } 21999 }, 22000 "x-go-package": "code.gitea.io/gitea/modules/structs" 22001 }, 22002 "MergePullRequestOption": { 22003 "description": "MergePullRequestForm form for merging Pull Request", 22004 "type": "object", 22005 "required": [ 22006 "Do" 22007 ], 22008 "properties": { 22009 "Do": { 22010 "type": "string", 22011 "enum": [ 22012 "merge", 22013 "rebase", 22014 "rebase-merge", 22015 "squash", 22016 "fast-forward-only", 22017 "manually-merged" 22018 ] 22019 }, 22020 "MergeCommitID": { 22021 "type": "string" 22022 }, 22023 "MergeMessageField": { 22024 "type": "string" 22025 }, 22026 "MergeTitleField": { 22027 "type": "string" 22028 }, 22029 "delete_branch_after_merge": { 22030 "type": "boolean", 22031 "x-go-name": "DeleteBranchAfterMerge" 22032 }, 22033 "force_merge": { 22034 "type": "boolean", 22035 "x-go-name": "ForceMerge" 22036 }, 22037 "head_commit_id": { 22038 "type": "string", 22039 "x-go-name": "HeadCommitID" 22040 }, 22041 "merge_when_checks_succeed": { 22042 "type": "boolean", 22043 "x-go-name": "MergeWhenChecksSucceed" 22044 } 22045 }, 22046 "x-go-name": "MergePullRequestForm", 22047 "x-go-package": "code.gitea.io/gitea/services/forms" 22048 }, 22049 "MigrateRepoOptions": { 22050 "description": "MigrateRepoOptions options for migrating repository's\nthis is used to interact with api v1", 22051 "type": "object", 22052 "required": [ 22053 "clone_addr", 22054 "repo_name" 22055 ], 22056 "properties": { 22057 "auth_password": { 22058 "type": "string", 22059 "x-go-name": "AuthPassword" 22060 }, 22061 "auth_token": { 22062 "type": "string", 22063 "x-go-name": "AuthToken" 22064 }, 22065 "auth_username": { 22066 "type": "string", 22067 "x-go-name": "AuthUsername" 22068 }, 22069 "clone_addr": { 22070 "type": "string", 22071 "x-go-name": "CloneAddr" 22072 }, 22073 "description": { 22074 "type": "string", 22075 "x-go-name": "Description" 22076 }, 22077 "issues": { 22078 "type": "boolean", 22079 "x-go-name": "Issues" 22080 }, 22081 "labels": { 22082 "type": "boolean", 22083 "x-go-name": "Labels" 22084 }, 22085 "lfs": { 22086 "type": "boolean", 22087 "x-go-name": "LFS" 22088 }, 22089 "lfs_endpoint": { 22090 "type": "string", 22091 "x-go-name": "LFSEndpoint" 22092 }, 22093 "milestones": { 22094 "type": "boolean", 22095 "x-go-name": "Milestones" 22096 }, 22097 "mirror": { 22098 "type": "boolean", 22099 "x-go-name": "Mirror" 22100 }, 22101 "mirror_interval": { 22102 "type": "string", 22103 "x-go-name": "MirrorInterval" 22104 }, 22105 "private": { 22106 "type": "boolean", 22107 "x-go-name": "Private" 22108 }, 22109 "pull_requests": { 22110 "type": "boolean", 22111 "x-go-name": "PullRequests" 22112 }, 22113 "releases": { 22114 "type": "boolean", 22115 "x-go-name": "Releases" 22116 }, 22117 "repo_name": { 22118 "type": "string", 22119 "x-go-name": "RepoName" 22120 }, 22121 "repo_owner": { 22122 "description": "Name of User or Organisation who will own Repo after migration", 22123 "type": "string", 22124 "x-go-name": "RepoOwner" 22125 }, 22126 "service": { 22127 "type": "string", 22128 "enum": [ 22129 "git", 22130 "github", 22131 "gitea", 22132 "gitlab", 22133 "gogs", 22134 "onedev", 22135 "gitbucket", 22136 "codebase" 22137 ], 22138 "x-go-name": "Service" 22139 }, 22140 "uid": { 22141 "description": "deprecated (only for backwards compatibility)", 22142 "type": "integer", 22143 "format": "int64", 22144 "x-go-name": "RepoOwnerID" 22145 }, 22146 "wiki": { 22147 "type": "boolean", 22148 "x-go-name": "Wiki" 22149 } 22150 }, 22151 "x-go-package": "code.gitea.io/gitea/modules/structs" 22152 }, 22153 "Milestone": { 22154 "description": "Milestone milestone is a collection of issues on one repository", 22155 "type": "object", 22156 "properties": { 22157 "closed_at": { 22158 "type": "string", 22159 "format": "date-time", 22160 "x-go-name": "Closed" 22161 }, 22162 "closed_issues": { 22163 "type": "integer", 22164 "format": "int64", 22165 "x-go-name": "ClosedIssues" 22166 }, 22167 "created_at": { 22168 "type": "string", 22169 "format": "date-time", 22170 "x-go-name": "Created" 22171 }, 22172 "description": { 22173 "type": "string", 22174 "x-go-name": "Description" 22175 }, 22176 "due_on": { 22177 "type": "string", 22178 "format": "date-time", 22179 "x-go-name": "Deadline" 22180 }, 22181 "id": { 22182 "type": "integer", 22183 "format": "int64", 22184 "x-go-name": "ID" 22185 }, 22186 "open_issues": { 22187 "type": "integer", 22188 "format": "int64", 22189 "x-go-name": "OpenIssues" 22190 }, 22191 "state": { 22192 "$ref": "#/definitions/StateType" 22193 }, 22194 "title": { 22195 "type": "string", 22196 "x-go-name": "Title" 22197 }, 22198 "updated_at": { 22199 "type": "string", 22200 "format": "date-time", 22201 "x-go-name": "Updated" 22202 } 22203 }, 22204 "x-go-package": "code.gitea.io/gitea/modules/structs" 22205 }, 22206 "NewIssuePinsAllowed": { 22207 "description": "NewIssuePinsAllowed represents an API response that says if new Issue Pins are allowed", 22208 "type": "object", 22209 "properties": { 22210 "issues": { 22211 "type": "boolean", 22212 "x-go-name": "Issues" 22213 }, 22214 "pull_requests": { 22215 "type": "boolean", 22216 "x-go-name": "PullRequests" 22217 } 22218 }, 22219 "x-go-package": "code.gitea.io/gitea/modules/structs" 22220 }, 22221 "NodeInfo": { 22222 "description": "NodeInfo contains standardized way of exposing metadata about a server running one of the distributed social networks", 22223 "type": "object", 22224 "properties": { 22225 "metadata": { 22226 "type": "object", 22227 "x-go-name": "Metadata" 22228 }, 22229 "openRegistrations": { 22230 "type": "boolean", 22231 "x-go-name": "OpenRegistrations" 22232 }, 22233 "protocols": { 22234 "type": "array", 22235 "items": { 22236 "type": "string" 22237 }, 22238 "x-go-name": "Protocols" 22239 }, 22240 "services": { 22241 "$ref": "#/definitions/NodeInfoServices" 22242 }, 22243 "software": { 22244 "$ref": "#/definitions/NodeInfoSoftware" 22245 }, 22246 "usage": { 22247 "$ref": "#/definitions/NodeInfoUsage" 22248 }, 22249 "version": { 22250 "type": "string", 22251 "x-go-name": "Version" 22252 } 22253 }, 22254 "x-go-package": "code.gitea.io/gitea/modules/structs" 22255 }, 22256 "NodeInfoServices": { 22257 "description": "NodeInfoServices contains the third party sites this server can connect to via their application API", 22258 "type": "object", 22259 "properties": { 22260 "inbound": { 22261 "type": "array", 22262 "items": { 22263 "type": "string" 22264 }, 22265 "x-go-name": "Inbound" 22266 }, 22267 "outbound": { 22268 "type": "array", 22269 "items": { 22270 "type": "string" 22271 }, 22272 "x-go-name": "Outbound" 22273 } 22274 }, 22275 "x-go-package": "code.gitea.io/gitea/modules/structs" 22276 }, 22277 "NodeInfoSoftware": { 22278 "description": "NodeInfoSoftware contains Metadata about server software in use", 22279 "type": "object", 22280 "properties": { 22281 "homepage": { 22282 "type": "string", 22283 "x-go-name": "Homepage" 22284 }, 22285 "name": { 22286 "type": "string", 22287 "x-go-name": "Name" 22288 }, 22289 "repository": { 22290 "type": "string", 22291 "x-go-name": "Repository" 22292 }, 22293 "version": { 22294 "type": "string", 22295 "x-go-name": "Version" 22296 } 22297 }, 22298 "x-go-package": "code.gitea.io/gitea/modules/structs" 22299 }, 22300 "NodeInfoUsage": { 22301 "description": "NodeInfoUsage contains usage statistics for this server", 22302 "type": "object", 22303 "properties": { 22304 "localComments": { 22305 "type": "integer", 22306 "format": "int64", 22307 "x-go-name": "LocalComments" 22308 }, 22309 "localPosts": { 22310 "type": "integer", 22311 "format": "int64", 22312 "x-go-name": "LocalPosts" 22313 }, 22314 "users": { 22315 "$ref": "#/definitions/NodeInfoUsageUsers" 22316 } 22317 }, 22318 "x-go-package": "code.gitea.io/gitea/modules/structs" 22319 }, 22320 "NodeInfoUsageUsers": { 22321 "description": "NodeInfoUsageUsers contains statistics about the users of this server", 22322 "type": "object", 22323 "properties": { 22324 "activeHalfyear": { 22325 "type": "integer", 22326 "format": "int64", 22327 "x-go-name": "ActiveHalfyear" 22328 }, 22329 "activeMonth": { 22330 "type": "integer", 22331 "format": "int64", 22332 "x-go-name": "ActiveMonth" 22333 }, 22334 "total": { 22335 "type": "integer", 22336 "format": "int64", 22337 "x-go-name": "Total" 22338 } 22339 }, 22340 "x-go-package": "code.gitea.io/gitea/modules/structs" 22341 }, 22342 "Note": { 22343 "description": "Note contains information related to a git note", 22344 "type": "object", 22345 "properties": { 22346 "commit": { 22347 "$ref": "#/definitions/Commit" 22348 }, 22349 "message": { 22350 "type": "string", 22351 "x-go-name": "Message" 22352 } 22353 }, 22354 "x-go-package": "code.gitea.io/gitea/modules/structs" 22355 }, 22356 "NotificationCount": { 22357 "description": "NotificationCount number of unread notifications", 22358 "type": "object", 22359 "properties": { 22360 "new": { 22361 "type": "integer", 22362 "format": "int64", 22363 "x-go-name": "New" 22364 } 22365 }, 22366 "x-go-package": "code.gitea.io/gitea/modules/structs" 22367 }, 22368 "NotificationSubject": { 22369 "description": "NotificationSubject contains the notification subject (Issue/Pull/Commit)", 22370 "type": "object", 22371 "properties": { 22372 "html_url": { 22373 "type": "string", 22374 "x-go-name": "HTMLURL" 22375 }, 22376 "latest_comment_html_url": { 22377 "type": "string", 22378 "x-go-name": "LatestCommentHTMLURL" 22379 }, 22380 "latest_comment_url": { 22381 "type": "string", 22382 "x-go-name": "LatestCommentURL" 22383 }, 22384 "state": { 22385 "$ref": "#/definitions/StateType" 22386 }, 22387 "title": { 22388 "type": "string", 22389 "x-go-name": "Title" 22390 }, 22391 "type": { 22392 "$ref": "#/definitions/NotifySubjectType" 22393 }, 22394 "url": { 22395 "type": "string", 22396 "x-go-name": "URL" 22397 } 22398 }, 22399 "x-go-package": "code.gitea.io/gitea/modules/structs" 22400 }, 22401 "NotificationThread": { 22402 "description": "NotificationThread expose Notification on API", 22403 "type": "object", 22404 "properties": { 22405 "id": { 22406 "type": "integer", 22407 "format": "int64", 22408 "x-go-name": "ID" 22409 }, 22410 "pinned": { 22411 "type": "boolean", 22412 "x-go-name": "Pinned" 22413 }, 22414 "repository": { 22415 "$ref": "#/definitions/Repository" 22416 }, 22417 "subject": { 22418 "$ref": "#/definitions/NotificationSubject" 22419 }, 22420 "unread": { 22421 "type": "boolean", 22422 "x-go-name": "Unread" 22423 }, 22424 "updated_at": { 22425 "type": "string", 22426 "format": "date-time", 22427 "x-go-name": "UpdatedAt" 22428 }, 22429 "url": { 22430 "type": "string", 22431 "x-go-name": "URL" 22432 } 22433 }, 22434 "x-go-package": "code.gitea.io/gitea/modules/structs" 22435 }, 22436 "NotifySubjectType": { 22437 "description": "NotifySubjectType represent type of notification subject", 22438 "type": "string", 22439 "x-go-package": "code.gitea.io/gitea/modules/structs" 22440 }, 22441 "OAuth2Application": { 22442 "type": "object", 22443 "title": "OAuth2Application represents an OAuth2 application.", 22444 "properties": { 22445 "client_id": { 22446 "type": "string", 22447 "x-go-name": "ClientID" 22448 }, 22449 "client_secret": { 22450 "type": "string", 22451 "x-go-name": "ClientSecret" 22452 }, 22453 "confidential_client": { 22454 "type": "boolean", 22455 "x-go-name": "ConfidentialClient" 22456 }, 22457 "created": { 22458 "type": "string", 22459 "format": "date-time", 22460 "x-go-name": "Created" 22461 }, 22462 "id": { 22463 "type": "integer", 22464 "format": "int64", 22465 "x-go-name": "ID" 22466 }, 22467 "name": { 22468 "type": "string", 22469 "x-go-name": "Name" 22470 }, 22471 "redirect_uris": { 22472 "type": "array", 22473 "items": { 22474 "type": "string" 22475 }, 22476 "x-go-name": "RedirectURIs" 22477 } 22478 }, 22479 "x-go-package": "code.gitea.io/gitea/modules/structs" 22480 }, 22481 "Organization": { 22482 "description": "Organization represents an organization", 22483 "type": "object", 22484 "properties": { 22485 "avatar_url": { 22486 "type": "string", 22487 "x-go-name": "AvatarURL" 22488 }, 22489 "description": { 22490 "type": "string", 22491 "x-go-name": "Description" 22492 }, 22493 "email": { 22494 "type": "string", 22495 "x-go-name": "Email" 22496 }, 22497 "full_name": { 22498 "type": "string", 22499 "x-go-name": "FullName" 22500 }, 22501 "id": { 22502 "type": "integer", 22503 "format": "int64", 22504 "x-go-name": "ID" 22505 }, 22506 "location": { 22507 "type": "string", 22508 "x-go-name": "Location" 22509 }, 22510 "name": { 22511 "type": "string", 22512 "x-go-name": "Name" 22513 }, 22514 "repo_admin_change_team_access": { 22515 "type": "boolean", 22516 "x-go-name": "RepoAdminChangeTeamAccess" 22517 }, 22518 "username": { 22519 "description": "deprecated", 22520 "type": "string", 22521 "x-go-name": "UserName" 22522 }, 22523 "visibility": { 22524 "type": "string", 22525 "x-go-name": "Visibility" 22526 }, 22527 "website": { 22528 "type": "string", 22529 "x-go-name": "Website" 22530 } 22531 }, 22532 "x-go-package": "code.gitea.io/gitea/modules/structs" 22533 }, 22534 "OrganizationPermissions": { 22535 "description": "OrganizationPermissions list different users permissions on an organization", 22536 "type": "object", 22537 "properties": { 22538 "can_create_repository": { 22539 "type": "boolean", 22540 "x-go-name": "CanCreateRepository" 22541 }, 22542 "can_read": { 22543 "type": "boolean", 22544 "x-go-name": "CanRead" 22545 }, 22546 "can_write": { 22547 "type": "boolean", 22548 "x-go-name": "CanWrite" 22549 }, 22550 "is_admin": { 22551 "type": "boolean", 22552 "x-go-name": "IsAdmin" 22553 }, 22554 "is_owner": { 22555 "type": "boolean", 22556 "x-go-name": "IsOwner" 22557 } 22558 }, 22559 "x-go-package": "code.gitea.io/gitea/modules/structs" 22560 }, 22561 "PRBranchInfo": { 22562 "description": "PRBranchInfo information about a branch", 22563 "type": "object", 22564 "properties": { 22565 "label": { 22566 "type": "string", 22567 "x-go-name": "Name" 22568 }, 22569 "ref": { 22570 "type": "string", 22571 "x-go-name": "Ref" 22572 }, 22573 "repo": { 22574 "$ref": "#/definitions/Repository" 22575 }, 22576 "repo_id": { 22577 "type": "integer", 22578 "format": "int64", 22579 "x-go-name": "RepoID" 22580 }, 22581 "sha": { 22582 "type": "string", 22583 "x-go-name": "Sha" 22584 } 22585 }, 22586 "x-go-package": "code.gitea.io/gitea/modules/structs" 22587 }, 22588 "Package": { 22589 "description": "Package represents a package", 22590 "type": "object", 22591 "properties": { 22592 "created_at": { 22593 "type": "string", 22594 "format": "date-time", 22595 "x-go-name": "CreatedAt" 22596 }, 22597 "creator": { 22598 "$ref": "#/definitions/User" 22599 }, 22600 "html_url": { 22601 "type": "string", 22602 "x-go-name": "HTMLURL" 22603 }, 22604 "id": { 22605 "type": "integer", 22606 "format": "int64", 22607 "x-go-name": "ID" 22608 }, 22609 "name": { 22610 "type": "string", 22611 "x-go-name": "Name" 22612 }, 22613 "owner": { 22614 "$ref": "#/definitions/User" 22615 }, 22616 "repository": { 22617 "$ref": "#/definitions/Repository" 22618 }, 22619 "type": { 22620 "type": "string", 22621 "x-go-name": "Type" 22622 }, 22623 "version": { 22624 "type": "string", 22625 "x-go-name": "Version" 22626 } 22627 }, 22628 "x-go-package": "code.gitea.io/gitea/modules/structs" 22629 }, 22630 "PackageFile": { 22631 "description": "PackageFile represents a package file", 22632 "type": "object", 22633 "properties": { 22634 "Size": { 22635 "type": "integer", 22636 "format": "int64" 22637 }, 22638 "id": { 22639 "type": "integer", 22640 "format": "int64", 22641 "x-go-name": "ID" 22642 }, 22643 "md5": { 22644 "type": "string", 22645 "x-go-name": "HashMD5" 22646 }, 22647 "name": { 22648 "type": "string", 22649 "x-go-name": "Name" 22650 }, 22651 "sha1": { 22652 "type": "string", 22653 "x-go-name": "HashSHA1" 22654 }, 22655 "sha256": { 22656 "type": "string", 22657 "x-go-name": "HashSHA256" 22658 }, 22659 "sha512": { 22660 "type": "string", 22661 "x-go-name": "HashSHA512" 22662 } 22663 }, 22664 "x-go-package": "code.gitea.io/gitea/modules/structs" 22665 }, 22666 "PayloadCommit": { 22667 "description": "PayloadCommit represents a commit", 22668 "type": "object", 22669 "properties": { 22670 "added": { 22671 "type": "array", 22672 "items": { 22673 "type": "string" 22674 }, 22675 "x-go-name": "Added" 22676 }, 22677 "author": { 22678 "$ref": "#/definitions/PayloadUser" 22679 }, 22680 "committer": { 22681 "$ref": "#/definitions/PayloadUser" 22682 }, 22683 "id": { 22684 "description": "sha1 hash of the commit", 22685 "type": "string", 22686 "x-go-name": "ID" 22687 }, 22688 "message": { 22689 "type": "string", 22690 "x-go-name": "Message" 22691 }, 22692 "modified": { 22693 "type": "array", 22694 "items": { 22695 "type": "string" 22696 }, 22697 "x-go-name": "Modified" 22698 }, 22699 "removed": { 22700 "type": "array", 22701 "items": { 22702 "type": "string" 22703 }, 22704 "x-go-name": "Removed" 22705 }, 22706 "timestamp": { 22707 "type": "string", 22708 "format": "date-time", 22709 "x-go-name": "Timestamp" 22710 }, 22711 "url": { 22712 "type": "string", 22713 "x-go-name": "URL" 22714 }, 22715 "verification": { 22716 "$ref": "#/definitions/PayloadCommitVerification" 22717 } 22718 }, 22719 "x-go-package": "code.gitea.io/gitea/modules/structs" 22720 }, 22721 "PayloadCommitVerification": { 22722 "description": "PayloadCommitVerification represents the GPG verification of a commit", 22723 "type": "object", 22724 "properties": { 22725 "payload": { 22726 "type": "string", 22727 "x-go-name": "Payload" 22728 }, 22729 "reason": { 22730 "type": "string", 22731 "x-go-name": "Reason" 22732 }, 22733 "signature": { 22734 "type": "string", 22735 "x-go-name": "Signature" 22736 }, 22737 "signer": { 22738 "$ref": "#/definitions/PayloadUser" 22739 }, 22740 "verified": { 22741 "type": "boolean", 22742 "x-go-name": "Verified" 22743 } 22744 }, 22745 "x-go-package": "code.gitea.io/gitea/modules/structs" 22746 }, 22747 "PayloadUser": { 22748 "description": "PayloadUser represents the author or committer of a commit", 22749 "type": "object", 22750 "properties": { 22751 "email": { 22752 "type": "string", 22753 "format": "email", 22754 "x-go-name": "Email" 22755 }, 22756 "name": { 22757 "description": "Full name of the commit author", 22758 "type": "string", 22759 "x-go-name": "Name" 22760 }, 22761 "username": { 22762 "type": "string", 22763 "x-go-name": "UserName" 22764 } 22765 }, 22766 "x-go-package": "code.gitea.io/gitea/modules/structs" 22767 }, 22768 "Permission": { 22769 "description": "Permission represents a set of permissions", 22770 "type": "object", 22771 "properties": { 22772 "admin": { 22773 "type": "boolean", 22774 "x-go-name": "Admin" 22775 }, 22776 "pull": { 22777 "type": "boolean", 22778 "x-go-name": "Pull" 22779 }, 22780 "push": { 22781 "type": "boolean", 22782 "x-go-name": "Push" 22783 } 22784 }, 22785 "x-go-package": "code.gitea.io/gitea/modules/structs" 22786 }, 22787 "PublicKey": { 22788 "description": "PublicKey publickey is a user key to push code to repository", 22789 "type": "object", 22790 "properties": { 22791 "created_at": { 22792 "type": "string", 22793 "format": "date-time", 22794 "x-go-name": "Created" 22795 }, 22796 "fingerprint": { 22797 "type": "string", 22798 "x-go-name": "Fingerprint" 22799 }, 22800 "id": { 22801 "type": "integer", 22802 "format": "int64", 22803 "x-go-name": "ID" 22804 }, 22805 "key": { 22806 "type": "string", 22807 "x-go-name": "Key" 22808 }, 22809 "key_type": { 22810 "type": "string", 22811 "x-go-name": "KeyType" 22812 }, 22813 "read_only": { 22814 "type": "boolean", 22815 "x-go-name": "ReadOnly" 22816 }, 22817 "title": { 22818 "type": "string", 22819 "x-go-name": "Title" 22820 }, 22821 "url": { 22822 "type": "string", 22823 "x-go-name": "URL" 22824 }, 22825 "user": { 22826 "$ref": "#/definitions/User" 22827 } 22828 }, 22829 "x-go-package": "code.gitea.io/gitea/modules/structs" 22830 }, 22831 "PullRequest": { 22832 "description": "PullRequest represents a pull request", 22833 "type": "object", 22834 "properties": { 22835 "additions": { 22836 "type": "integer", 22837 "format": "int64", 22838 "x-go-name": "Additions" 22839 }, 22840 "allow_maintainer_edit": { 22841 "type": "boolean", 22842 "x-go-name": "AllowMaintainerEdit" 22843 }, 22844 "assignee": { 22845 "$ref": "#/definitions/User" 22846 }, 22847 "assignees": { 22848 "type": "array", 22849 "items": { 22850 "$ref": "#/definitions/User" 22851 }, 22852 "x-go-name": "Assignees" 22853 }, 22854 "base": { 22855 "$ref": "#/definitions/PRBranchInfo" 22856 }, 22857 "body": { 22858 "type": "string", 22859 "x-go-name": "Body" 22860 }, 22861 "changed_files": { 22862 "type": "integer", 22863 "format": "int64", 22864 "x-go-name": "ChangedFiles" 22865 }, 22866 "closed_at": { 22867 "type": "string", 22868 "format": "date-time", 22869 "x-go-name": "Closed" 22870 }, 22871 "comments": { 22872 "type": "integer", 22873 "format": "int64", 22874 "x-go-name": "Comments" 22875 }, 22876 "created_at": { 22877 "type": "string", 22878 "format": "date-time", 22879 "x-go-name": "Created" 22880 }, 22881 "deletions": { 22882 "type": "integer", 22883 "format": "int64", 22884 "x-go-name": "Deletions" 22885 }, 22886 "diff_url": { 22887 "type": "string", 22888 "x-go-name": "DiffURL" 22889 }, 22890 "draft": { 22891 "type": "boolean", 22892 "x-go-name": "Draft" 22893 }, 22894 "due_date": { 22895 "type": "string", 22896 "format": "date-time", 22897 "x-go-name": "Deadline" 22898 }, 22899 "head": { 22900 "$ref": "#/definitions/PRBranchInfo" 22901 }, 22902 "html_url": { 22903 "type": "string", 22904 "x-go-name": "HTMLURL" 22905 }, 22906 "id": { 22907 "type": "integer", 22908 "format": "int64", 22909 "x-go-name": "ID" 22910 }, 22911 "is_locked": { 22912 "type": "boolean", 22913 "x-go-name": "IsLocked" 22914 }, 22915 "labels": { 22916 "type": "array", 22917 "items": { 22918 "$ref": "#/definitions/Label" 22919 }, 22920 "x-go-name": "Labels" 22921 }, 22922 "merge_base": { 22923 "type": "string", 22924 "x-go-name": "MergeBase" 22925 }, 22926 "merge_commit_sha": { 22927 "type": "string", 22928 "x-go-name": "MergedCommitID" 22929 }, 22930 "mergeable": { 22931 "type": "boolean", 22932 "x-go-name": "Mergeable" 22933 }, 22934 "merged": { 22935 "type": "boolean", 22936 "x-go-name": "HasMerged" 22937 }, 22938 "merged_at": { 22939 "type": "string", 22940 "format": "date-time", 22941 "x-go-name": "Merged" 22942 }, 22943 "merged_by": { 22944 "$ref": "#/definitions/User" 22945 }, 22946 "milestone": { 22947 "$ref": "#/definitions/Milestone" 22948 }, 22949 "number": { 22950 "type": "integer", 22951 "format": "int64", 22952 "x-go-name": "Index" 22953 }, 22954 "patch_url": { 22955 "type": "string", 22956 "x-go-name": "PatchURL" 22957 }, 22958 "pin_order": { 22959 "type": "integer", 22960 "format": "int64", 22961 "x-go-name": "PinOrder" 22962 }, 22963 "requested_reviewers": { 22964 "type": "array", 22965 "items": { 22966 "$ref": "#/definitions/User" 22967 }, 22968 "x-go-name": "RequestedReviewers" 22969 }, 22970 "review_comments": { 22971 "description": "number of review comments made on the diff of a PR review (not including comments on commits or issues in a PR)", 22972 "type": "integer", 22973 "format": "int64", 22974 "x-go-name": "ReviewComments" 22975 }, 22976 "state": { 22977 "$ref": "#/definitions/StateType" 22978 }, 22979 "title": { 22980 "type": "string", 22981 "x-go-name": "Title" 22982 }, 22983 "updated_at": { 22984 "type": "string", 22985 "format": "date-time", 22986 "x-go-name": "Updated" 22987 }, 22988 "url": { 22989 "type": "string", 22990 "x-go-name": "URL" 22991 }, 22992 "user": { 22993 "$ref": "#/definitions/User" 22994 } 22995 }, 22996 "x-go-package": "code.gitea.io/gitea/modules/structs" 22997 }, 22998 "PullRequestMeta": { 22999 "description": "PullRequestMeta PR info if an issue is a PR", 23000 "type": "object", 23001 "properties": { 23002 "draft": { 23003 "type": "boolean", 23004 "x-go-name": "IsWorkInProgress" 23005 }, 23006 "html_url": { 23007 "type": "string", 23008 "x-go-name": "HTMLURL" 23009 }, 23010 "merged": { 23011 "type": "boolean", 23012 "x-go-name": "HasMerged" 23013 }, 23014 "merged_at": { 23015 "type": "string", 23016 "format": "date-time", 23017 "x-go-name": "Merged" 23018 } 23019 }, 23020 "x-go-package": "code.gitea.io/gitea/modules/structs" 23021 }, 23022 "PullReview": { 23023 "description": "PullReview represents a pull request review", 23024 "type": "object", 23025 "properties": { 23026 "body": { 23027 "type": "string", 23028 "x-go-name": "Body" 23029 }, 23030 "comments_count": { 23031 "type": "integer", 23032 "format": "int64", 23033 "x-go-name": "CodeCommentsCount" 23034 }, 23035 "commit_id": { 23036 "type": "string", 23037 "x-go-name": "CommitID" 23038 }, 23039 "dismissed": { 23040 "type": "boolean", 23041 "x-go-name": "Dismissed" 23042 }, 23043 "html_url": { 23044 "type": "string", 23045 "x-go-name": "HTMLURL" 23046 }, 23047 "id": { 23048 "type": "integer", 23049 "format": "int64", 23050 "x-go-name": "ID" 23051 }, 23052 "official": { 23053 "type": "boolean", 23054 "x-go-name": "Official" 23055 }, 23056 "pull_request_url": { 23057 "type": "string", 23058 "x-go-name": "HTMLPullURL" 23059 }, 23060 "stale": { 23061 "type": "boolean", 23062 "x-go-name": "Stale" 23063 }, 23064 "state": { 23065 "$ref": "#/definitions/ReviewStateType" 23066 }, 23067 "submitted_at": { 23068 "type": "string", 23069 "format": "date-time", 23070 "x-go-name": "Submitted" 23071 }, 23072 "team": { 23073 "$ref": "#/definitions/Team" 23074 }, 23075 "updated_at": { 23076 "type": "string", 23077 "format": "date-time", 23078 "x-go-name": "Updated" 23079 }, 23080 "user": { 23081 "$ref": "#/definitions/User" 23082 } 23083 }, 23084 "x-go-package": "code.gitea.io/gitea/modules/structs" 23085 }, 23086 "PullReviewComment": { 23087 "description": "PullReviewComment represents a comment on a pull request review", 23088 "type": "object", 23089 "properties": { 23090 "body": { 23091 "type": "string", 23092 "x-go-name": "Body" 23093 }, 23094 "commit_id": { 23095 "type": "string", 23096 "x-go-name": "CommitID" 23097 }, 23098 "created_at": { 23099 "type": "string", 23100 "format": "date-time", 23101 "x-go-name": "Created" 23102 }, 23103 "diff_hunk": { 23104 "type": "string", 23105 "x-go-name": "DiffHunk" 23106 }, 23107 "html_url": { 23108 "type": "string", 23109 "x-go-name": "HTMLURL" 23110 }, 23111 "id": { 23112 "type": "integer", 23113 "format": "int64", 23114 "x-go-name": "ID" 23115 }, 23116 "original_commit_id": { 23117 "type": "string", 23118 "x-go-name": "OrigCommitID" 23119 }, 23120 "original_position": { 23121 "type": "integer", 23122 "format": "uint64", 23123 "x-go-name": "OldLineNum" 23124 }, 23125 "path": { 23126 "type": "string", 23127 "x-go-name": "Path" 23128 }, 23129 "position": { 23130 "type": "integer", 23131 "format": "uint64", 23132 "x-go-name": "LineNum" 23133 }, 23134 "pull_request_review_id": { 23135 "type": "integer", 23136 "format": "int64", 23137 "x-go-name": "ReviewID" 23138 }, 23139 "pull_request_url": { 23140 "type": "string", 23141 "x-go-name": "HTMLPullURL" 23142 }, 23143 "resolver": { 23144 "$ref": "#/definitions/User" 23145 }, 23146 "updated_at": { 23147 "type": "string", 23148 "format": "date-time", 23149 "x-go-name": "Updated" 23150 }, 23151 "user": { 23152 "$ref": "#/definitions/User" 23153 } 23154 }, 23155 "x-go-package": "code.gitea.io/gitea/modules/structs" 23156 }, 23157 "PullReviewRequestOptions": { 23158 "description": "PullReviewRequestOptions are options to add or remove pull review requests", 23159 "type": "object", 23160 "properties": { 23161 "reviewers": { 23162 "type": "array", 23163 "items": { 23164 "type": "string" 23165 }, 23166 "x-go-name": "Reviewers" 23167 }, 23168 "team_reviewers": { 23169 "type": "array", 23170 "items": { 23171 "type": "string" 23172 }, 23173 "x-go-name": "TeamReviewers" 23174 } 23175 }, 23176 "x-go-package": "code.gitea.io/gitea/modules/structs" 23177 }, 23178 "PushMirror": { 23179 "description": "PushMirror represents information of a push mirror", 23180 "type": "object", 23181 "properties": { 23182 "created": { 23183 "type": "string", 23184 "format": "date-time", 23185 "x-go-name": "CreatedUnix" 23186 }, 23187 "interval": { 23188 "type": "string", 23189 "x-go-name": "Interval" 23190 }, 23191 "last_error": { 23192 "type": "string", 23193 "x-go-name": "LastError" 23194 }, 23195 "last_update": { 23196 "type": "string", 23197 "format": "date-time", 23198 "x-go-name": "LastUpdateUnix" 23199 }, 23200 "remote_address": { 23201 "type": "string", 23202 "x-go-name": "RemoteAddress" 23203 }, 23204 "remote_name": { 23205 "type": "string", 23206 "x-go-name": "RemoteName" 23207 }, 23208 "repo_name": { 23209 "type": "string", 23210 "x-go-name": "RepoName" 23211 }, 23212 "sync_on_commit": { 23213 "type": "boolean", 23214 "x-go-name": "SyncOnCommit" 23215 } 23216 }, 23217 "x-go-package": "code.gitea.io/gitea/modules/structs" 23218 }, 23219 "Reaction": { 23220 "description": "Reaction contain one reaction", 23221 "type": "object", 23222 "properties": { 23223 "content": { 23224 "type": "string", 23225 "x-go-name": "Reaction" 23226 }, 23227 "created_at": { 23228 "type": "string", 23229 "format": "date-time", 23230 "x-go-name": "Created" 23231 }, 23232 "user": { 23233 "$ref": "#/definitions/User" 23234 } 23235 }, 23236 "x-go-package": "code.gitea.io/gitea/modules/structs" 23237 }, 23238 "Reference": { 23239 "type": "object", 23240 "title": "Reference represents a Git reference.", 23241 "properties": { 23242 "object": { 23243 "$ref": "#/definitions/GitObject" 23244 }, 23245 "ref": { 23246 "type": "string", 23247 "x-go-name": "Ref" 23248 }, 23249 "url": { 23250 "type": "string", 23251 "x-go-name": "URL" 23252 } 23253 }, 23254 "x-go-package": "code.gitea.io/gitea/modules/structs" 23255 }, 23256 "Release": { 23257 "description": "Release represents a repository release", 23258 "type": "object", 23259 "properties": { 23260 "assets": { 23261 "type": "array", 23262 "items": { 23263 "$ref": "#/definitions/Attachment" 23264 }, 23265 "x-go-name": "Attachments" 23266 }, 23267 "author": { 23268 "$ref": "#/definitions/User" 23269 }, 23270 "body": { 23271 "type": "string", 23272 "x-go-name": "Note" 23273 }, 23274 "created_at": { 23275 "type": "string", 23276 "format": "date-time", 23277 "x-go-name": "CreatedAt" 23278 }, 23279 "draft": { 23280 "type": "boolean", 23281 "x-go-name": "IsDraft" 23282 }, 23283 "html_url": { 23284 "type": "string", 23285 "x-go-name": "HTMLURL" 23286 }, 23287 "id": { 23288 "type": "integer", 23289 "format": "int64", 23290 "x-go-name": "ID" 23291 }, 23292 "name": { 23293 "type": "string", 23294 "x-go-name": "Title" 23295 }, 23296 "prerelease": { 23297 "type": "boolean", 23298 "x-go-name": "IsPrerelease" 23299 }, 23300 "published_at": { 23301 "type": "string", 23302 "format": "date-time", 23303 "x-go-name": "PublishedAt" 23304 }, 23305 "tag_name": { 23306 "type": "string", 23307 "x-go-name": "TagName" 23308 }, 23309 "tarball_url": { 23310 "type": "string", 23311 "x-go-name": "TarURL" 23312 }, 23313 "target_commitish": { 23314 "type": "string", 23315 "x-go-name": "Target" 23316 }, 23317 "upload_url": { 23318 "type": "string", 23319 "x-go-name": "UploadURL" 23320 }, 23321 "url": { 23322 "type": "string", 23323 "x-go-name": "URL" 23324 }, 23325 "zipball_url": { 23326 "type": "string", 23327 "x-go-name": "ZipURL" 23328 } 23329 }, 23330 "x-go-package": "code.gitea.io/gitea/modules/structs" 23331 }, 23332 "RenameUserOption": { 23333 "description": "RenameUserOption options when renaming a user", 23334 "type": "object", 23335 "required": [ 23336 "new_username" 23337 ], 23338 "properties": { 23339 "new_username": { 23340 "description": "New username for this user. This name cannot be in use yet by any other user.", 23341 "type": "string", 23342 "uniqueItems": true, 23343 "x-go-name": "NewName" 23344 } 23345 }, 23346 "x-go-package": "code.gitea.io/gitea/modules/structs" 23347 }, 23348 "RepoCollaboratorPermission": { 23349 "description": "RepoCollaboratorPermission to get repository permission for a collaborator", 23350 "type": "object", 23351 "properties": { 23352 "permission": { 23353 "type": "string", 23354 "x-go-name": "Permission" 23355 }, 23356 "role_name": { 23357 "type": "string", 23358 "x-go-name": "RoleName" 23359 }, 23360 "user": { 23361 "$ref": "#/definitions/User" 23362 } 23363 }, 23364 "x-go-package": "code.gitea.io/gitea/modules/structs" 23365 }, 23366 "RepoCommit": { 23367 "type": "object", 23368 "title": "RepoCommit contains information of a commit in the context of a repository.", 23369 "properties": { 23370 "author": { 23371 "$ref": "#/definitions/CommitUser" 23372 }, 23373 "committer": { 23374 "$ref": "#/definitions/CommitUser" 23375 }, 23376 "message": { 23377 "type": "string", 23378 "x-go-name": "Message" 23379 }, 23380 "tree": { 23381 "$ref": "#/definitions/CommitMeta" 23382 }, 23383 "url": { 23384 "type": "string", 23385 "x-go-name": "URL" 23386 }, 23387 "verification": { 23388 "$ref": "#/definitions/PayloadCommitVerification" 23389 } 23390 }, 23391 "x-go-package": "code.gitea.io/gitea/modules/structs" 23392 }, 23393 "RepoTopicOptions": { 23394 "description": "RepoTopicOptions a collection of repo topic names", 23395 "type": "object", 23396 "properties": { 23397 "topics": { 23398 "description": "list of topic names", 23399 "type": "array", 23400 "items": { 23401 "type": "string" 23402 }, 23403 "x-go-name": "Topics" 23404 } 23405 }, 23406 "x-go-package": "code.gitea.io/gitea/modules/structs" 23407 }, 23408 "RepoTransfer": { 23409 "description": "RepoTransfer represents a pending repo transfer", 23410 "type": "object", 23411 "properties": { 23412 "doer": { 23413 "$ref": "#/definitions/User" 23414 }, 23415 "recipient": { 23416 "$ref": "#/definitions/User" 23417 }, 23418 "teams": { 23419 "type": "array", 23420 "items": { 23421 "$ref": "#/definitions/Team" 23422 }, 23423 "x-go-name": "Teams" 23424 } 23425 }, 23426 "x-go-package": "code.gitea.io/gitea/modules/structs" 23427 }, 23428 "Repository": { 23429 "description": "Repository represents a repository", 23430 "type": "object", 23431 "properties": { 23432 "allow_fast_forward_only_merge": { 23433 "type": "boolean", 23434 "x-go-name": "AllowFastForwardOnly" 23435 }, 23436 "allow_merge_commits": { 23437 "type": "boolean", 23438 "x-go-name": "AllowMerge" 23439 }, 23440 "allow_rebase": { 23441 "type": "boolean", 23442 "x-go-name": "AllowRebase" 23443 }, 23444 "allow_rebase_explicit": { 23445 "type": "boolean", 23446 "x-go-name": "AllowRebaseMerge" 23447 }, 23448 "allow_rebase_update": { 23449 "type": "boolean", 23450 "x-go-name": "AllowRebaseUpdate" 23451 }, 23452 "allow_squash_merge": { 23453 "type": "boolean", 23454 "x-go-name": "AllowSquash" 23455 }, 23456 "archived": { 23457 "type": "boolean", 23458 "x-go-name": "Archived" 23459 }, 23460 "archived_at": { 23461 "type": "string", 23462 "format": "date-time", 23463 "x-go-name": "ArchivedAt" 23464 }, 23465 "avatar_url": { 23466 "type": "string", 23467 "x-go-name": "AvatarURL" 23468 }, 23469 "clone_url": { 23470 "type": "string", 23471 "x-go-name": "CloneURL" 23472 }, 23473 "created_at": { 23474 "type": "string", 23475 "format": "date-time", 23476 "x-go-name": "Created" 23477 }, 23478 "default_allow_maintainer_edit": { 23479 "type": "boolean", 23480 "x-go-name": "DefaultAllowMaintainerEdit" 23481 }, 23482 "default_branch": { 23483 "type": "string", 23484 "x-go-name": "DefaultBranch" 23485 }, 23486 "default_delete_branch_after_merge": { 23487 "type": "boolean", 23488 "x-go-name": "DefaultDeleteBranchAfterMerge" 23489 }, 23490 "default_merge_style": { 23491 "type": "string", 23492 "x-go-name": "DefaultMergeStyle" 23493 }, 23494 "description": { 23495 "type": "string", 23496 "x-go-name": "Description" 23497 }, 23498 "empty": { 23499 "type": "boolean", 23500 "x-go-name": "Empty" 23501 }, 23502 "external_tracker": { 23503 "$ref": "#/definitions/ExternalTracker" 23504 }, 23505 "external_wiki": { 23506 "$ref": "#/definitions/ExternalWiki" 23507 }, 23508 "fork": { 23509 "type": "boolean", 23510 "x-go-name": "Fork" 23511 }, 23512 "forks_count": { 23513 "type": "integer", 23514 "format": "int64", 23515 "x-go-name": "Forks" 23516 }, 23517 "full_name": { 23518 "type": "string", 23519 "x-go-name": "FullName" 23520 }, 23521 "has_actions": { 23522 "type": "boolean", 23523 "x-go-name": "HasActions" 23524 }, 23525 "has_issues": { 23526 "type": "boolean", 23527 "x-go-name": "HasIssues" 23528 }, 23529 "has_packages": { 23530 "type": "boolean", 23531 "x-go-name": "HasPackages" 23532 }, 23533 "has_projects": { 23534 "type": "boolean", 23535 "x-go-name": "HasProjects" 23536 }, 23537 "has_pull_requests": { 23538 "type": "boolean", 23539 "x-go-name": "HasPullRequests" 23540 }, 23541 "has_releases": { 23542 "type": "boolean", 23543 "x-go-name": "HasReleases" 23544 }, 23545 "has_wiki": { 23546 "type": "boolean", 23547 "x-go-name": "HasWiki" 23548 }, 23549 "html_url": { 23550 "type": "string", 23551 "x-go-name": "HTMLURL" 23552 }, 23553 "id": { 23554 "type": "integer", 23555 "format": "int64", 23556 "x-go-name": "ID" 23557 }, 23558 "ignore_whitespace_conflicts": { 23559 "type": "boolean", 23560 "x-go-name": "IgnoreWhitespaceConflicts" 23561 }, 23562 "internal": { 23563 "type": "boolean", 23564 "x-go-name": "Internal" 23565 }, 23566 "internal_tracker": { 23567 "$ref": "#/definitions/InternalTracker" 23568 }, 23569 "language": { 23570 "type": "string", 23571 "x-go-name": "Language" 23572 }, 23573 "languages_url": { 23574 "type": "string", 23575 "x-go-name": "LanguagesURL" 23576 }, 23577 "link": { 23578 "type": "string", 23579 "x-go-name": "Link" 23580 }, 23581 "mirror": { 23582 "type": "boolean", 23583 "x-go-name": "Mirror" 23584 }, 23585 "mirror_interval": { 23586 "type": "string", 23587 "x-go-name": "MirrorInterval" 23588 }, 23589 "mirror_updated": { 23590 "type": "string", 23591 "format": "date-time", 23592 "x-go-name": "MirrorUpdated" 23593 }, 23594 "name": { 23595 "type": "string", 23596 "x-go-name": "Name" 23597 }, 23598 "object_format_name": { 23599 "description": "ObjectFormatName of the underlying git repository", 23600 "type": "string", 23601 "enum": [ 23602 "sha1", 23603 "sha256" 23604 ], 23605 "x-go-name": "ObjectFormatName" 23606 }, 23607 "open_issues_count": { 23608 "type": "integer", 23609 "format": "int64", 23610 "x-go-name": "OpenIssues" 23611 }, 23612 "open_pr_counter": { 23613 "type": "integer", 23614 "format": "int64", 23615 "x-go-name": "OpenPulls" 23616 }, 23617 "original_url": { 23618 "type": "string", 23619 "x-go-name": "OriginalURL" 23620 }, 23621 "owner": { 23622 "$ref": "#/definitions/User" 23623 }, 23624 "parent": { 23625 "$ref": "#/definitions/Repository" 23626 }, 23627 "permissions": { 23628 "$ref": "#/definitions/Permission" 23629 }, 23630 "private": { 23631 "type": "boolean", 23632 "x-go-name": "Private" 23633 }, 23634 "projects_mode": { 23635 "type": "string", 23636 "x-go-name": "ProjectsMode" 23637 }, 23638 "release_counter": { 23639 "type": "integer", 23640 "format": "int64", 23641 "x-go-name": "Releases" 23642 }, 23643 "repo_transfer": { 23644 "$ref": "#/definitions/RepoTransfer" 23645 }, 23646 "size": { 23647 "type": "integer", 23648 "format": "int64", 23649 "x-go-name": "Size" 23650 }, 23651 "ssh_url": { 23652 "type": "string", 23653 "x-go-name": "SSHURL" 23654 }, 23655 "stars_count": { 23656 "type": "integer", 23657 "format": "int64", 23658 "x-go-name": "Stars" 23659 }, 23660 "template": { 23661 "type": "boolean", 23662 "x-go-name": "Template" 23663 }, 23664 "updated_at": { 23665 "type": "string", 23666 "format": "date-time", 23667 "x-go-name": "Updated" 23668 }, 23669 "url": { 23670 "type": "string", 23671 "x-go-name": "URL" 23672 }, 23673 "watchers_count": { 23674 "type": "integer", 23675 "format": "int64", 23676 "x-go-name": "Watchers" 23677 }, 23678 "website": { 23679 "type": "string", 23680 "x-go-name": "Website" 23681 } 23682 }, 23683 "x-go-package": "code.gitea.io/gitea/modules/structs" 23684 }, 23685 "RepositoryMeta": { 23686 "description": "RepositoryMeta basic repository information", 23687 "type": "object", 23688 "properties": { 23689 "full_name": { 23690 "type": "string", 23691 "x-go-name": "FullName" 23692 }, 23693 "id": { 23694 "type": "integer", 23695 "format": "int64", 23696 "x-go-name": "ID" 23697 }, 23698 "name": { 23699 "type": "string", 23700 "x-go-name": "Name" 23701 }, 23702 "owner": { 23703 "type": "string", 23704 "x-go-name": "Owner" 23705 } 23706 }, 23707 "x-go-package": "code.gitea.io/gitea/modules/structs" 23708 }, 23709 "ReviewStateType": { 23710 "description": "ReviewStateType review state type", 23711 "type": "string", 23712 "x-go-package": "code.gitea.io/gitea/modules/structs" 23713 }, 23714 "SearchResults": { 23715 "description": "SearchResults results of a successful search", 23716 "type": "object", 23717 "properties": { 23718 "data": { 23719 "type": "array", 23720 "items": { 23721 "$ref": "#/definitions/Repository" 23722 }, 23723 "x-go-name": "Data" 23724 }, 23725 "ok": { 23726 "type": "boolean", 23727 "x-go-name": "OK" 23728 } 23729 }, 23730 "x-go-package": "code.gitea.io/gitea/modules/structs" 23731 }, 23732 "Secret": { 23733 "description": "Secret represents a secret", 23734 "type": "object", 23735 "properties": { 23736 "created_at": { 23737 "type": "string", 23738 "format": "date-time", 23739 "x-go-name": "Created" 23740 }, 23741 "name": { 23742 "description": "the secret's name", 23743 "type": "string", 23744 "x-go-name": "Name" 23745 } 23746 }, 23747 "x-go-package": "code.gitea.io/gitea/modules/structs" 23748 }, 23749 "ServerVersion": { 23750 "description": "ServerVersion wraps the version of the server", 23751 "type": "object", 23752 "properties": { 23753 "version": { 23754 "type": "string", 23755 "x-go-name": "Version" 23756 } 23757 }, 23758 "x-go-package": "code.gitea.io/gitea/modules/structs" 23759 }, 23760 "StateType": { 23761 "description": "StateType issue state type", 23762 "type": "string", 23763 "x-go-package": "code.gitea.io/gitea/modules/structs" 23764 }, 23765 "StopWatch": { 23766 "description": "StopWatch represent a running stopwatch", 23767 "type": "object", 23768 "properties": { 23769 "created": { 23770 "type": "string", 23771 "format": "date-time", 23772 "x-go-name": "Created" 23773 }, 23774 "duration": { 23775 "type": "string", 23776 "x-go-name": "Duration" 23777 }, 23778 "issue_index": { 23779 "type": "integer", 23780 "format": "int64", 23781 "x-go-name": "IssueIndex" 23782 }, 23783 "issue_title": { 23784 "type": "string", 23785 "x-go-name": "IssueTitle" 23786 }, 23787 "repo_name": { 23788 "type": "string", 23789 "x-go-name": "RepoName" 23790 }, 23791 "repo_owner_name": { 23792 "type": "string", 23793 "x-go-name": "RepoOwnerName" 23794 }, 23795 "seconds": { 23796 "type": "integer", 23797 "format": "int64", 23798 "x-go-name": "Seconds" 23799 } 23800 }, 23801 "x-go-package": "code.gitea.io/gitea/modules/structs" 23802 }, 23803 "SubmitPullReviewOptions": { 23804 "description": "SubmitPullReviewOptions are options to submit a pending pull review", 23805 "type": "object", 23806 "properties": { 23807 "body": { 23808 "type": "string", 23809 "x-go-name": "Body" 23810 }, 23811 "event": { 23812 "$ref": "#/definitions/ReviewStateType" 23813 } 23814 }, 23815 "x-go-package": "code.gitea.io/gitea/modules/structs" 23816 }, 23817 "Tag": { 23818 "description": "Tag represents a repository tag", 23819 "type": "object", 23820 "properties": { 23821 "commit": { 23822 "$ref": "#/definitions/CommitMeta" 23823 }, 23824 "id": { 23825 "type": "string", 23826 "x-go-name": "ID" 23827 }, 23828 "message": { 23829 "type": "string", 23830 "x-go-name": "Message" 23831 }, 23832 "name": { 23833 "type": "string", 23834 "x-go-name": "Name" 23835 }, 23836 "tarball_url": { 23837 "type": "string", 23838 "x-go-name": "TarballURL" 23839 }, 23840 "zipball_url": { 23841 "type": "string", 23842 "x-go-name": "ZipballURL" 23843 } 23844 }, 23845 "x-go-package": "code.gitea.io/gitea/modules/structs" 23846 }, 23847 "Team": { 23848 "description": "Team represents a team in an organization", 23849 "type": "object", 23850 "properties": { 23851 "can_create_org_repo": { 23852 "type": "boolean", 23853 "x-go-name": "CanCreateOrgRepo" 23854 }, 23855 "description": { 23856 "type": "string", 23857 "x-go-name": "Description" 23858 }, 23859 "id": { 23860 "type": "integer", 23861 "format": "int64", 23862 "x-go-name": "ID" 23863 }, 23864 "includes_all_repositories": { 23865 "type": "boolean", 23866 "x-go-name": "IncludesAllRepositories" 23867 }, 23868 "name": { 23869 "type": "string", 23870 "x-go-name": "Name" 23871 }, 23872 "organization": { 23873 "$ref": "#/definitions/Organization" 23874 }, 23875 "permission": { 23876 "type": "string", 23877 "enum": [ 23878 "none", 23879 "read", 23880 "write", 23881 "admin", 23882 "owner" 23883 ], 23884 "x-go-name": "Permission" 23885 }, 23886 "units": { 23887 "type": "array", 23888 "items": { 23889 "type": "string" 23890 }, 23891 "x-go-name": "Units", 23892 "example": [ 23893 "repo.code", 23894 "repo.issues", 23895 "repo.ext_issues", 23896 "repo.wiki", 23897 "repo.pulls", 23898 "repo.releases", 23899 "repo.projects", 23900 "repo.ext_wiki" 23901 ] 23902 }, 23903 "units_map": { 23904 "type": "object", 23905 "additionalProperties": { 23906 "type": "string" 23907 }, 23908 "x-go-name": "UnitsMap", 23909 "example": { 23910 "repo.code": "read", 23911 "repo.ext_issues": "none", 23912 "repo.ext_wiki": "none", 23913 "repo.issues": "write", 23914 "repo.projects": "none", 23915 "repo.pulls": "owner", 23916 "repo.releases": "none", 23917 "repo.wiki": "admin" 23918 } 23919 } 23920 }, 23921 "x-go-package": "code.gitea.io/gitea/modules/structs" 23922 }, 23923 "TimeStamp": { 23924 "description": "TimeStamp defines a timestamp", 23925 "type": "integer", 23926 "format": "int64", 23927 "x-go-package": "code.gitea.io/gitea/modules/timeutil" 23928 }, 23929 "TimelineComment": { 23930 "description": "TimelineComment represents a timeline comment (comment of any type) on a commit or issue", 23931 "type": "object", 23932 "properties": { 23933 "assignee": { 23934 "$ref": "#/definitions/User" 23935 }, 23936 "assignee_team": { 23937 "$ref": "#/definitions/Team" 23938 }, 23939 "body": { 23940 "type": "string", 23941 "x-go-name": "Body" 23942 }, 23943 "created_at": { 23944 "type": "string", 23945 "format": "date-time", 23946 "x-go-name": "Created" 23947 }, 23948 "dependent_issue": { 23949 "$ref": "#/definitions/Issue" 23950 }, 23951 "html_url": { 23952 "type": "string", 23953 "x-go-name": "HTMLURL" 23954 }, 23955 "id": { 23956 "type": "integer", 23957 "format": "int64", 23958 "x-go-name": "ID" 23959 }, 23960 "issue_url": { 23961 "type": "string", 23962 "x-go-name": "IssueURL" 23963 }, 23964 "label": { 23965 "$ref": "#/definitions/Label" 23966 }, 23967 "milestone": { 23968 "$ref": "#/definitions/Milestone" 23969 }, 23970 "new_ref": { 23971 "type": "string", 23972 "x-go-name": "NewRef" 23973 }, 23974 "new_title": { 23975 "type": "string", 23976 "x-go-name": "NewTitle" 23977 }, 23978 "old_milestone": { 23979 "$ref": "#/definitions/Milestone" 23980 }, 23981 "old_project_id": { 23982 "type": "integer", 23983 "format": "int64", 23984 "x-go-name": "OldProjectID" 23985 }, 23986 "old_ref": { 23987 "type": "string", 23988 "x-go-name": "OldRef" 23989 }, 23990 "old_title": { 23991 "type": "string", 23992 "x-go-name": "OldTitle" 23993 }, 23994 "project_id": { 23995 "type": "integer", 23996 "format": "int64", 23997 "x-go-name": "ProjectID" 23998 }, 23999 "pull_request_url": { 24000 "type": "string", 24001 "x-go-name": "PRURL" 24002 }, 24003 "ref_action": { 24004 "type": "string", 24005 "x-go-name": "RefAction" 24006 }, 24007 "ref_comment": { 24008 "$ref": "#/definitions/Comment" 24009 }, 24010 "ref_commit_sha": { 24011 "description": "commit SHA where issue/PR was referenced", 24012 "type": "string", 24013 "x-go-name": "RefCommitSHA" 24014 }, 24015 "ref_issue": { 24016 "$ref": "#/definitions/Issue" 24017 }, 24018 "removed_assignee": { 24019 "description": "whether the assignees were removed or added", 24020 "type": "boolean", 24021 "x-go-name": "RemovedAssignee" 24022 }, 24023 "resolve_doer": { 24024 "$ref": "#/definitions/User" 24025 }, 24026 "review_id": { 24027 "type": "integer", 24028 "format": "int64", 24029 "x-go-name": "ReviewID" 24030 }, 24031 "tracked_time": { 24032 "$ref": "#/definitions/TrackedTime" 24033 }, 24034 "type": { 24035 "type": "string", 24036 "x-go-name": "Type" 24037 }, 24038 "updated_at": { 24039 "type": "string", 24040 "format": "date-time", 24041 "x-go-name": "Updated" 24042 }, 24043 "user": { 24044 "$ref": "#/definitions/User" 24045 } 24046 }, 24047 "x-go-package": "code.gitea.io/gitea/modules/structs" 24048 }, 24049 "TopicName": { 24050 "description": "TopicName a list of repo topic names", 24051 "type": "object", 24052 "properties": { 24053 "topics": { 24054 "type": "array", 24055 "items": { 24056 "type": "string" 24057 }, 24058 "x-go-name": "TopicNames" 24059 } 24060 }, 24061 "x-go-package": "code.gitea.io/gitea/modules/structs" 24062 }, 24063 "TopicResponse": { 24064 "description": "TopicResponse for returning topics", 24065 "type": "object", 24066 "properties": { 24067 "created": { 24068 "type": "string", 24069 "format": "date-time", 24070 "x-go-name": "Created" 24071 }, 24072 "id": { 24073 "type": "integer", 24074 "format": "int64", 24075 "x-go-name": "ID" 24076 }, 24077 "repo_count": { 24078 "type": "integer", 24079 "format": "int64", 24080 "x-go-name": "RepoCount" 24081 }, 24082 "topic_name": { 24083 "type": "string", 24084 "x-go-name": "Name" 24085 }, 24086 "updated": { 24087 "type": "string", 24088 "format": "date-time", 24089 "x-go-name": "Updated" 24090 } 24091 }, 24092 "x-go-package": "code.gitea.io/gitea/modules/structs" 24093 }, 24094 "TrackedTime": { 24095 "description": "TrackedTime worked time for an issue / pr", 24096 "type": "object", 24097 "properties": { 24098 "created": { 24099 "type": "string", 24100 "format": "date-time", 24101 "x-go-name": "Created" 24102 }, 24103 "id": { 24104 "type": "integer", 24105 "format": "int64", 24106 "x-go-name": "ID" 24107 }, 24108 "issue": { 24109 "$ref": "#/definitions/Issue" 24110 }, 24111 "issue_id": { 24112 "description": "deprecated (only for backwards compatibility)", 24113 "type": "integer", 24114 "format": "int64", 24115 "x-go-name": "IssueID" 24116 }, 24117 "time": { 24118 "description": "Time in seconds", 24119 "type": "integer", 24120 "format": "int64", 24121 "x-go-name": "Time" 24122 }, 24123 "user_id": { 24124 "description": "deprecated (only for backwards compatibility)", 24125 "type": "integer", 24126 "format": "int64", 24127 "x-go-name": "UserID" 24128 }, 24129 "user_name": { 24130 "type": "string", 24131 "x-go-name": "UserName" 24132 } 24133 }, 24134 "x-go-package": "code.gitea.io/gitea/modules/structs" 24135 }, 24136 "TransferRepoOption": { 24137 "description": "TransferRepoOption options when transfer a repository's ownership", 24138 "type": "object", 24139 "required": [ 24140 "new_owner" 24141 ], 24142 "properties": { 24143 "new_owner": { 24144 "type": "string", 24145 "x-go-name": "NewOwner" 24146 }, 24147 "team_ids": { 24148 "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", 24149 "type": "array", 24150 "items": { 24151 "type": "integer", 24152 "format": "int64" 24153 }, 24154 "x-go-name": "TeamIDs" 24155 } 24156 }, 24157 "x-go-package": "code.gitea.io/gitea/modules/structs" 24158 }, 24159 "UpdateFileOptions": { 24160 "description": "UpdateFileOptions options for updating files\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)", 24161 "type": "object", 24162 "required": [ 24163 "sha", 24164 "content" 24165 ], 24166 "properties": { 24167 "author": { 24168 "$ref": "#/definitions/Identity" 24169 }, 24170 "branch": { 24171 "description": "branch (optional) to base this file from. if not given, the default branch is used", 24172 "type": "string", 24173 "x-go-name": "BranchName" 24174 }, 24175 "committer": { 24176 "$ref": "#/definitions/Identity" 24177 }, 24178 "content": { 24179 "description": "content must be base64 encoded", 24180 "type": "string", 24181 "x-go-name": "ContentBase64" 24182 }, 24183 "dates": { 24184 "$ref": "#/definitions/CommitDateOptions" 24185 }, 24186 "from_path": { 24187 "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL", 24188 "type": "string", 24189 "x-go-name": "FromPath" 24190 }, 24191 "message": { 24192 "description": "message (optional) for the commit of this file. if not supplied, a default message will be used", 24193 "type": "string", 24194 "x-go-name": "Message" 24195 }, 24196 "new_branch": { 24197 "description": "new_branch (optional) will make a new branch from `branch` before creating the file", 24198 "type": "string", 24199 "x-go-name": "NewBranchName" 24200 }, 24201 "sha": { 24202 "description": "sha is the SHA for the file that already exists", 24203 "type": "string", 24204 "x-go-name": "SHA" 24205 }, 24206 "signoff": { 24207 "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.", 24208 "type": "boolean", 24209 "x-go-name": "Signoff" 24210 } 24211 }, 24212 "x-go-package": "code.gitea.io/gitea/modules/structs" 24213 }, 24214 "UpdateRepoAvatarOption": { 24215 "description": "UpdateRepoAvatarUserOption options when updating the repo avatar", 24216 "type": "object", 24217 "properties": { 24218 "image": { 24219 "description": "image must be base64 encoded", 24220 "type": "string", 24221 "x-go-name": "Image" 24222 } 24223 }, 24224 "x-go-package": "code.gitea.io/gitea/modules/structs" 24225 }, 24226 "UpdateUserAvatarOption": { 24227 "description": "UpdateUserAvatarUserOption options when updating the user avatar", 24228 "type": "object", 24229 "properties": { 24230 "image": { 24231 "description": "image must be base64 encoded", 24232 "type": "string", 24233 "x-go-name": "Image" 24234 } 24235 }, 24236 "x-go-package": "code.gitea.io/gitea/modules/structs" 24237 }, 24238 "UpdateVariableOption": { 24239 "description": "UpdateVariableOption the option when updating variable", 24240 "type": "object", 24241 "required": [ 24242 "value" 24243 ], 24244 "properties": { 24245 "name": { 24246 "description": "New name for the variable. If the field is empty, the variable name won't be updated.", 24247 "type": "string", 24248 "x-go-name": "Name" 24249 }, 24250 "value": { 24251 "description": "Value of the variable to update", 24252 "type": "string", 24253 "x-go-name": "Value" 24254 } 24255 }, 24256 "x-go-package": "code.gitea.io/gitea/modules/structs" 24257 }, 24258 "User": { 24259 "description": "User represents a user", 24260 "type": "object", 24261 "properties": { 24262 "active": { 24263 "description": "Is user active", 24264 "type": "boolean", 24265 "x-go-name": "IsActive" 24266 }, 24267 "avatar_url": { 24268 "description": "URL to the user's avatar", 24269 "type": "string", 24270 "x-go-name": "AvatarURL" 24271 }, 24272 "created": { 24273 "type": "string", 24274 "format": "date-time", 24275 "x-go-name": "Created" 24276 }, 24277 "description": { 24278 "description": "the user's description", 24279 "type": "string", 24280 "x-go-name": "Description" 24281 }, 24282 "email": { 24283 "type": "string", 24284 "format": "email", 24285 "x-go-name": "Email" 24286 }, 24287 "followers_count": { 24288 "description": "user counts", 24289 "type": "integer", 24290 "format": "int64", 24291 "x-go-name": "Followers" 24292 }, 24293 "following_count": { 24294 "type": "integer", 24295 "format": "int64", 24296 "x-go-name": "Following" 24297 }, 24298 "full_name": { 24299 "description": "the user's full name", 24300 "type": "string", 24301 "x-go-name": "FullName" 24302 }, 24303 "html_url": { 24304 "description": "URL to the user's gitea page", 24305 "type": "string", 24306 "x-go-name": "HTMLURL" 24307 }, 24308 "id": { 24309 "description": "the user's id", 24310 "type": "integer", 24311 "format": "int64", 24312 "x-go-name": "ID" 24313 }, 24314 "is_admin": { 24315 "description": "Is the user an administrator", 24316 "type": "boolean", 24317 "x-go-name": "IsAdmin" 24318 }, 24319 "language": { 24320 "description": "User locale", 24321 "type": "string", 24322 "x-go-name": "Language" 24323 }, 24324 "last_login": { 24325 "type": "string", 24326 "format": "date-time", 24327 "x-go-name": "LastLogin" 24328 }, 24329 "location": { 24330 "description": "the user's location", 24331 "type": "string", 24332 "x-go-name": "Location" 24333 }, 24334 "login": { 24335 "description": "the user's username", 24336 "type": "string", 24337 "x-go-name": "UserName" 24338 }, 24339 "login_name": { 24340 "description": "the user's authentication sign-in name.", 24341 "type": "string", 24342 "default": "empty", 24343 "x-go-name": "LoginName" 24344 }, 24345 "prohibit_login": { 24346 "description": "Is user login prohibited", 24347 "type": "boolean", 24348 "x-go-name": "ProhibitLogin" 24349 }, 24350 "restricted": { 24351 "description": "Is user restricted", 24352 "type": "boolean", 24353 "x-go-name": "Restricted" 24354 }, 24355 "source_id": { 24356 "description": "The ID of the user's Authentication Source", 24357 "type": "integer", 24358 "format": "int64", 24359 "x-go-name": "SourceID" 24360 }, 24361 "starred_repos_count": { 24362 "type": "integer", 24363 "format": "int64", 24364 "x-go-name": "StarredRepos" 24365 }, 24366 "visibility": { 24367 "description": "User visibility level option: public, limited, private", 24368 "type": "string", 24369 "x-go-name": "Visibility" 24370 }, 24371 "website": { 24372 "description": "the user's website", 24373 "type": "string", 24374 "x-go-name": "Website" 24375 } 24376 }, 24377 "x-go-package": "code.gitea.io/gitea/modules/structs" 24378 }, 24379 "UserBadgeOption": { 24380 "description": "UserBadgeOption options for link between users and badges", 24381 "type": "object", 24382 "properties": { 24383 "badge_slugs": { 24384 "type": "array", 24385 "items": { 24386 "type": "string" 24387 }, 24388 "x-go-name": "BadgeSlugs", 24389 "example": [ 24390 "badge1", 24391 "badge2" 24392 ] 24393 } 24394 }, 24395 "x-go-package": "code.gitea.io/gitea/modules/structs" 24396 }, 24397 "UserHeatmapData": { 24398 "description": "UserHeatmapData represents the data needed to create a heatmap", 24399 "type": "object", 24400 "properties": { 24401 "contributions": { 24402 "type": "integer", 24403 "format": "int64", 24404 "x-go-name": "Contributions" 24405 }, 24406 "timestamp": { 24407 "$ref": "#/definitions/TimeStamp" 24408 } 24409 }, 24410 "x-go-package": "code.gitea.io/gitea/models/activities" 24411 }, 24412 "UserSettings": { 24413 "description": "UserSettings represents user settings", 24414 "type": "object", 24415 "properties": { 24416 "description": { 24417 "type": "string", 24418 "x-go-name": "Description" 24419 }, 24420 "diff_view_style": { 24421 "type": "string", 24422 "x-go-name": "DiffViewStyle" 24423 }, 24424 "full_name": { 24425 "type": "string", 24426 "x-go-name": "FullName" 24427 }, 24428 "hide_activity": { 24429 "type": "boolean", 24430 "x-go-name": "HideActivity" 24431 }, 24432 "hide_email": { 24433 "description": "Privacy", 24434 "type": "boolean", 24435 "x-go-name": "HideEmail" 24436 }, 24437 "language": { 24438 "type": "string", 24439 "x-go-name": "Language" 24440 }, 24441 "location": { 24442 "type": "string", 24443 "x-go-name": "Location" 24444 }, 24445 "theme": { 24446 "type": "string", 24447 "x-go-name": "Theme" 24448 }, 24449 "website": { 24450 "type": "string", 24451 "x-go-name": "Website" 24452 } 24453 }, 24454 "x-go-package": "code.gitea.io/gitea/modules/structs" 24455 }, 24456 "UserSettingsOptions": { 24457 "description": "UserSettingsOptions represents options to change user settings", 24458 "type": "object", 24459 "properties": { 24460 "description": { 24461 "type": "string", 24462 "x-go-name": "Description" 24463 }, 24464 "diff_view_style": { 24465 "type": "string", 24466 "x-go-name": "DiffViewStyle" 24467 }, 24468 "full_name": { 24469 "type": "string", 24470 "x-go-name": "FullName" 24471 }, 24472 "hide_activity": { 24473 "type": "boolean", 24474 "x-go-name": "HideActivity" 24475 }, 24476 "hide_email": { 24477 "description": "Privacy", 24478 "type": "boolean", 24479 "x-go-name": "HideEmail" 24480 }, 24481 "language": { 24482 "type": "string", 24483 "x-go-name": "Language" 24484 }, 24485 "location": { 24486 "type": "string", 24487 "x-go-name": "Location" 24488 }, 24489 "theme": { 24490 "type": "string", 24491 "x-go-name": "Theme" 24492 }, 24493 "website": { 24494 "type": "string", 24495 "x-go-name": "Website" 24496 } 24497 }, 24498 "x-go-package": "code.gitea.io/gitea/modules/structs" 24499 }, 24500 "WatchInfo": { 24501 "description": "WatchInfo represents an API watch status of one repository", 24502 "type": "object", 24503 "properties": { 24504 "created_at": { 24505 "type": "string", 24506 "format": "date-time", 24507 "x-go-name": "CreatedAt" 24508 }, 24509 "ignored": { 24510 "type": "boolean", 24511 "x-go-name": "Ignored" 24512 }, 24513 "reason": { 24514 "x-go-name": "Reason" 24515 }, 24516 "repository_url": { 24517 "type": "string", 24518 "x-go-name": "RepositoryURL" 24519 }, 24520 "subscribed": { 24521 "type": "boolean", 24522 "x-go-name": "Subscribed" 24523 }, 24524 "url": { 24525 "type": "string", 24526 "x-go-name": "URL" 24527 } 24528 }, 24529 "x-go-package": "code.gitea.io/gitea/modules/structs" 24530 }, 24531 "WikiCommit": { 24532 "description": "WikiCommit page commit/revision", 24533 "type": "object", 24534 "properties": { 24535 "author": { 24536 "$ref": "#/definitions/CommitUser" 24537 }, 24538 "commiter": { 24539 "$ref": "#/definitions/CommitUser" 24540 }, 24541 "message": { 24542 "type": "string", 24543 "x-go-name": "Message" 24544 }, 24545 "sha": { 24546 "type": "string", 24547 "x-go-name": "ID" 24548 } 24549 }, 24550 "x-go-package": "code.gitea.io/gitea/modules/structs" 24551 }, 24552 "WikiCommitList": { 24553 "description": "WikiCommitList commit/revision list", 24554 "type": "object", 24555 "properties": { 24556 "commits": { 24557 "type": "array", 24558 "items": { 24559 "$ref": "#/definitions/WikiCommit" 24560 }, 24561 "x-go-name": "WikiCommits" 24562 }, 24563 "count": { 24564 "type": "integer", 24565 "format": "int64", 24566 "x-go-name": "Count" 24567 } 24568 }, 24569 "x-go-package": "code.gitea.io/gitea/modules/structs" 24570 }, 24571 "WikiPage": { 24572 "description": "WikiPage a wiki page", 24573 "type": "object", 24574 "properties": { 24575 "commit_count": { 24576 "type": "integer", 24577 "format": "int64", 24578 "x-go-name": "CommitCount" 24579 }, 24580 "content_base64": { 24581 "description": "Page content, base64 encoded", 24582 "type": "string", 24583 "x-go-name": "ContentBase64" 24584 }, 24585 "footer": { 24586 "type": "string", 24587 "x-go-name": "Footer" 24588 }, 24589 "html_url": { 24590 "type": "string", 24591 "x-go-name": "HTMLURL" 24592 }, 24593 "last_commit": { 24594 "$ref": "#/definitions/WikiCommit" 24595 }, 24596 "sidebar": { 24597 "type": "string", 24598 "x-go-name": "Sidebar" 24599 }, 24600 "sub_url": { 24601 "type": "string", 24602 "x-go-name": "SubURL" 24603 }, 24604 "title": { 24605 "type": "string", 24606 "x-go-name": "Title" 24607 } 24608 }, 24609 "x-go-package": "code.gitea.io/gitea/modules/structs" 24610 }, 24611 "WikiPageMetaData": { 24612 "description": "WikiPageMetaData wiki page meta information", 24613 "type": "object", 24614 "properties": { 24615 "html_url": { 24616 "type": "string", 24617 "x-go-name": "HTMLURL" 24618 }, 24619 "last_commit": { 24620 "$ref": "#/definitions/WikiCommit" 24621 }, 24622 "sub_url": { 24623 "type": "string", 24624 "x-go-name": "SubURL" 24625 }, 24626 "title": { 24627 "type": "string", 24628 "x-go-name": "Title" 24629 } 24630 }, 24631 "x-go-package": "code.gitea.io/gitea/modules/structs" 24632 } 24633 }, 24634 "responses": { 24635 "AccessToken": { 24636 "description": "AccessToken represents an API access token.", 24637 "schema": { 24638 "$ref": "#/definitions/AccessToken" 24639 } 24640 }, 24641 "AccessTokenList": { 24642 "description": "AccessTokenList represents a list of API access token.", 24643 "schema": { 24644 "type": "array", 24645 "items": { 24646 "$ref": "#/definitions/AccessToken" 24647 } 24648 } 24649 }, 24650 "ActionVariable": { 24651 "description": "ActionVariable", 24652 "schema": { 24653 "$ref": "#/definitions/ActionVariable" 24654 } 24655 }, 24656 "ActivityFeedsList": { 24657 "description": "ActivityFeedsList", 24658 "schema": { 24659 "type": "array", 24660 "items": { 24661 "$ref": "#/definitions/Activity" 24662 } 24663 } 24664 }, 24665 "ActivityPub": { 24666 "description": "ActivityPub", 24667 "schema": { 24668 "$ref": "#/definitions/ActivityPub" 24669 } 24670 }, 24671 "AnnotatedTag": { 24672 "description": "AnnotatedTag", 24673 "schema": { 24674 "$ref": "#/definitions/AnnotatedTag" 24675 } 24676 }, 24677 "Attachment": { 24678 "description": "Attachment", 24679 "schema": { 24680 "$ref": "#/definitions/Attachment" 24681 } 24682 }, 24683 "AttachmentList": { 24684 "description": "AttachmentList", 24685 "schema": { 24686 "type": "array", 24687 "items": { 24688 "$ref": "#/definitions/Attachment" 24689 } 24690 } 24691 }, 24692 "BadgeList": { 24693 "description": "BadgeList", 24694 "schema": { 24695 "type": "array", 24696 "items": { 24697 "$ref": "#/definitions/Badge" 24698 } 24699 } 24700 }, 24701 "Branch": { 24702 "description": "Branch", 24703 "schema": { 24704 "$ref": "#/definitions/Branch" 24705 } 24706 }, 24707 "BranchList": { 24708 "description": "BranchList", 24709 "schema": { 24710 "type": "array", 24711 "items": { 24712 "$ref": "#/definitions/Branch" 24713 } 24714 } 24715 }, 24716 "BranchProtection": { 24717 "description": "BranchProtection", 24718 "schema": { 24719 "$ref": "#/definitions/BranchProtection" 24720 } 24721 }, 24722 "BranchProtectionList": { 24723 "description": "BranchProtectionList", 24724 "schema": { 24725 "type": "array", 24726 "items": { 24727 "$ref": "#/definitions/BranchProtection" 24728 } 24729 } 24730 }, 24731 "ChangedFileList": { 24732 "description": "ChangedFileList", 24733 "schema": { 24734 "type": "array", 24735 "items": { 24736 "$ref": "#/definitions/ChangedFile" 24737 } 24738 }, 24739 "headers": { 24740 "X-HasMore": { 24741 "type": "boolean", 24742 "description": "True if there is another page" 24743 }, 24744 "X-Page": { 24745 "type": "integer", 24746 "format": "int64", 24747 "description": "The current page" 24748 }, 24749 "X-PageCount": { 24750 "type": "integer", 24751 "format": "int64", 24752 "description": "Total number of pages" 24753 }, 24754 "X-PerPage": { 24755 "type": "integer", 24756 "format": "int64", 24757 "description": "Commits per page" 24758 }, 24759 "X-Total": { 24760 "type": "integer", 24761 "format": "int64", 24762 "description": "Total commit count" 24763 } 24764 } 24765 }, 24766 "CombinedStatus": { 24767 "description": "CombinedStatus", 24768 "schema": { 24769 "$ref": "#/definitions/CombinedStatus" 24770 } 24771 }, 24772 "Comment": { 24773 "description": "Comment", 24774 "schema": { 24775 "$ref": "#/definitions/Comment" 24776 } 24777 }, 24778 "CommentList": { 24779 "description": "CommentList", 24780 "schema": { 24781 "type": "array", 24782 "items": { 24783 "$ref": "#/definitions/Comment" 24784 } 24785 } 24786 }, 24787 "Commit": { 24788 "description": "Commit", 24789 "schema": { 24790 "$ref": "#/definitions/Commit" 24791 } 24792 }, 24793 "CommitList": { 24794 "description": "CommitList", 24795 "schema": { 24796 "type": "array", 24797 "items": { 24798 "$ref": "#/definitions/Commit" 24799 } 24800 }, 24801 "headers": { 24802 "X-HasMore": { 24803 "type": "boolean", 24804 "description": "True if there is another page" 24805 }, 24806 "X-Page": { 24807 "type": "integer", 24808 "format": "int64", 24809 "description": "The current page" 24810 }, 24811 "X-PageCount": { 24812 "type": "integer", 24813 "format": "int64", 24814 "description": "Total number of pages" 24815 }, 24816 "X-PerPage": { 24817 "type": "integer", 24818 "format": "int64", 24819 "description": "Commits per page" 24820 }, 24821 "X-Total": { 24822 "type": "integer", 24823 "format": "int64", 24824 "description": "Total commit count" 24825 } 24826 } 24827 }, 24828 "CommitStatus": { 24829 "description": "CommitStatus", 24830 "schema": { 24831 "$ref": "#/definitions/CommitStatus" 24832 } 24833 }, 24834 "CommitStatusList": { 24835 "description": "CommitStatusList", 24836 "schema": { 24837 "type": "array", 24838 "items": { 24839 "$ref": "#/definitions/CommitStatus" 24840 } 24841 } 24842 }, 24843 "Compare": { 24844 "description": "", 24845 "schema": { 24846 "$ref": "#/definitions/Compare" 24847 } 24848 }, 24849 "ContentsListResponse": { 24850 "description": "ContentsListResponse", 24851 "schema": { 24852 "type": "array", 24853 "items": { 24854 "$ref": "#/definitions/ContentsResponse" 24855 } 24856 } 24857 }, 24858 "ContentsResponse": { 24859 "description": "ContentsResponse", 24860 "schema": { 24861 "$ref": "#/definitions/ContentsResponse" 24862 } 24863 }, 24864 "CronList": { 24865 "description": "CronList", 24866 "schema": { 24867 "type": "array", 24868 "items": { 24869 "$ref": "#/definitions/Cron" 24870 } 24871 } 24872 }, 24873 "DeployKey": { 24874 "description": "DeployKey", 24875 "schema": { 24876 "$ref": "#/definitions/DeployKey" 24877 } 24878 }, 24879 "DeployKeyList": { 24880 "description": "DeployKeyList", 24881 "schema": { 24882 "type": "array", 24883 "items": { 24884 "$ref": "#/definitions/DeployKey" 24885 } 24886 } 24887 }, 24888 "EmailList": { 24889 "description": "EmailList", 24890 "schema": { 24891 "type": "array", 24892 "items": { 24893 "$ref": "#/definitions/Email" 24894 } 24895 } 24896 }, 24897 "EmptyRepository": { 24898 "description": "EmptyRepository", 24899 "schema": { 24900 "$ref": "#/definitions/APIError" 24901 } 24902 }, 24903 "FileDeleteResponse": { 24904 "description": "FileDeleteResponse", 24905 "schema": { 24906 "$ref": "#/definitions/FileDeleteResponse" 24907 } 24908 }, 24909 "FileResponse": { 24910 "description": "FileResponse", 24911 "schema": { 24912 "$ref": "#/definitions/FileResponse" 24913 } 24914 }, 24915 "FilesResponse": { 24916 "description": "FilesResponse", 24917 "schema": { 24918 "$ref": "#/definitions/FilesResponse" 24919 } 24920 }, 24921 "GPGKey": { 24922 "description": "GPGKey", 24923 "schema": { 24924 "$ref": "#/definitions/GPGKey" 24925 } 24926 }, 24927 "GPGKeyList": { 24928 "description": "GPGKeyList", 24929 "schema": { 24930 "type": "array", 24931 "items": { 24932 "$ref": "#/definitions/GPGKey" 24933 } 24934 } 24935 }, 24936 "GeneralAPISettings": { 24937 "description": "GeneralAPISettings", 24938 "schema": { 24939 "$ref": "#/definitions/GeneralAPISettings" 24940 } 24941 }, 24942 "GeneralAttachmentSettings": { 24943 "description": "GeneralAttachmentSettings", 24944 "schema": { 24945 "$ref": "#/definitions/GeneralAttachmentSettings" 24946 } 24947 }, 24948 "GeneralRepoSettings": { 24949 "description": "GeneralRepoSettings", 24950 "schema": { 24951 "$ref": "#/definitions/GeneralRepoSettings" 24952 } 24953 }, 24954 "GeneralUISettings": { 24955 "description": "GeneralUISettings", 24956 "schema": { 24957 "$ref": "#/definitions/GeneralUISettings" 24958 } 24959 }, 24960 "GitBlobResponse": { 24961 "description": "GitBlobResponse", 24962 "schema": { 24963 "$ref": "#/definitions/GitBlobResponse" 24964 } 24965 }, 24966 "GitHook": { 24967 "description": "GitHook", 24968 "schema": { 24969 "$ref": "#/definitions/GitHook" 24970 } 24971 }, 24972 "GitHookList": { 24973 "description": "GitHookList", 24974 "schema": { 24975 "type": "array", 24976 "items": { 24977 "$ref": "#/definitions/GitHook" 24978 } 24979 } 24980 }, 24981 "GitTreeResponse": { 24982 "description": "GitTreeResponse", 24983 "schema": { 24984 "$ref": "#/definitions/GitTreeResponse" 24985 } 24986 }, 24987 "GitignoreTemplateInfo": { 24988 "description": "GitignoreTemplateInfo", 24989 "schema": { 24990 "$ref": "#/definitions/GitignoreTemplateInfo" 24991 } 24992 }, 24993 "GitignoreTemplateList": { 24994 "description": "GitignoreTemplateList", 24995 "schema": { 24996 "type": "array", 24997 "items": { 24998 "type": "string" 24999 } 25000 } 25001 }, 25002 "Hook": { 25003 "description": "Hook", 25004 "schema": { 25005 "$ref": "#/definitions/Hook" 25006 } 25007 }, 25008 "HookList": { 25009 "description": "HookList", 25010 "schema": { 25011 "type": "array", 25012 "items": { 25013 "$ref": "#/definitions/Hook" 25014 } 25015 } 25016 }, 25017 "Issue": { 25018 "description": "Issue", 25019 "schema": { 25020 "$ref": "#/definitions/Issue" 25021 } 25022 }, 25023 "IssueDeadline": { 25024 "description": "IssueDeadline", 25025 "schema": { 25026 "$ref": "#/definitions/IssueDeadline" 25027 } 25028 }, 25029 "IssueList": { 25030 "description": "IssueList", 25031 "schema": { 25032 "type": "array", 25033 "items": { 25034 "$ref": "#/definitions/Issue" 25035 } 25036 } 25037 }, 25038 "IssueTemplates": { 25039 "description": "IssueTemplates", 25040 "schema": { 25041 "type": "array", 25042 "items": { 25043 "$ref": "#/definitions/IssueTemplate" 25044 } 25045 } 25046 }, 25047 "Label": { 25048 "description": "Label", 25049 "schema": { 25050 "$ref": "#/definitions/Label" 25051 } 25052 }, 25053 "LabelList": { 25054 "description": "LabelList", 25055 "schema": { 25056 "type": "array", 25057 "items": { 25058 "$ref": "#/definitions/Label" 25059 } 25060 } 25061 }, 25062 "LabelTemplateInfo": { 25063 "description": "LabelTemplateInfo", 25064 "schema": { 25065 "type": "array", 25066 "items": { 25067 "$ref": "#/definitions/LabelTemplate" 25068 } 25069 } 25070 }, 25071 "LabelTemplateList": { 25072 "description": "LabelTemplateList", 25073 "schema": { 25074 "type": "array", 25075 "items": { 25076 "type": "string" 25077 } 25078 } 25079 }, 25080 "LanguageStatistics": { 25081 "description": "LanguageStatistics", 25082 "schema": { 25083 "type": "object", 25084 "additionalProperties": { 25085 "type": "integer", 25086 "format": "int64" 25087 } 25088 } 25089 }, 25090 "LicenseTemplateInfo": { 25091 "description": "LicenseTemplateInfo", 25092 "schema": { 25093 "$ref": "#/definitions/LicenseTemplateInfo" 25094 } 25095 }, 25096 "LicenseTemplateList": { 25097 "description": "LicenseTemplateList", 25098 "schema": { 25099 "type": "array", 25100 "items": { 25101 "$ref": "#/definitions/LicensesTemplateListEntry" 25102 } 25103 } 25104 }, 25105 "MarkdownRender": { 25106 "description": "MarkdownRender is a rendered markdown document", 25107 "schema": { 25108 "type": "string" 25109 } 25110 }, 25111 "MarkupRender": { 25112 "description": "MarkupRender is a rendered markup document", 25113 "schema": { 25114 "type": "string" 25115 } 25116 }, 25117 "Milestone": { 25118 "description": "Milestone", 25119 "schema": { 25120 "$ref": "#/definitions/Milestone" 25121 } 25122 }, 25123 "MilestoneList": { 25124 "description": "MilestoneList", 25125 "schema": { 25126 "type": "array", 25127 "items": { 25128 "$ref": "#/definitions/Milestone" 25129 } 25130 } 25131 }, 25132 "NodeInfo": { 25133 "description": "NodeInfo", 25134 "schema": { 25135 "$ref": "#/definitions/NodeInfo" 25136 } 25137 }, 25138 "Note": { 25139 "description": "Note", 25140 "schema": { 25141 "$ref": "#/definitions/Note" 25142 } 25143 }, 25144 "NotificationCount": { 25145 "description": "Number of unread notifications", 25146 "schema": { 25147 "$ref": "#/definitions/NotificationCount" 25148 } 25149 }, 25150 "NotificationThread": { 25151 "description": "NotificationThread", 25152 "schema": { 25153 "$ref": "#/definitions/NotificationThread" 25154 } 25155 }, 25156 "NotificationThreadList": { 25157 "description": "NotificationThreadList", 25158 "schema": { 25159 "type": "array", 25160 "items": { 25161 "$ref": "#/definitions/NotificationThread" 25162 } 25163 } 25164 }, 25165 "OAuth2Application": { 25166 "description": "OAuth2Application", 25167 "schema": { 25168 "$ref": "#/definitions/OAuth2Application" 25169 } 25170 }, 25171 "OAuth2ApplicationList": { 25172 "description": "OAuth2ApplicationList represents a list of OAuth2 applications.", 25173 "schema": { 25174 "type": "array", 25175 "items": { 25176 "$ref": "#/definitions/OAuth2Application" 25177 } 25178 } 25179 }, 25180 "Organization": { 25181 "description": "Organization", 25182 "schema": { 25183 "$ref": "#/definitions/Organization" 25184 } 25185 }, 25186 "OrganizationList": { 25187 "description": "OrganizationList", 25188 "schema": { 25189 "type": "array", 25190 "items": { 25191 "$ref": "#/definitions/Organization" 25192 } 25193 } 25194 }, 25195 "OrganizationPermissions": { 25196 "description": "OrganizationPermissions", 25197 "schema": { 25198 "$ref": "#/definitions/OrganizationPermissions" 25199 } 25200 }, 25201 "Package": { 25202 "description": "Package", 25203 "schema": { 25204 "$ref": "#/definitions/Package" 25205 } 25206 }, 25207 "PackageFileList": { 25208 "description": "PackageFileList", 25209 "schema": { 25210 "type": "array", 25211 "items": { 25212 "$ref": "#/definitions/PackageFile" 25213 } 25214 } 25215 }, 25216 "PackageList": { 25217 "description": "PackageList", 25218 "schema": { 25219 "type": "array", 25220 "items": { 25221 "$ref": "#/definitions/Package" 25222 } 25223 } 25224 }, 25225 "PublicKey": { 25226 "description": "PublicKey", 25227 "schema": { 25228 "$ref": "#/definitions/PublicKey" 25229 } 25230 }, 25231 "PublicKeyList": { 25232 "description": "PublicKeyList", 25233 "schema": { 25234 "type": "array", 25235 "items": { 25236 "$ref": "#/definitions/PublicKey" 25237 } 25238 } 25239 }, 25240 "PullRequest": { 25241 "description": "PullRequest", 25242 "schema": { 25243 "$ref": "#/definitions/PullRequest" 25244 } 25245 }, 25246 "PullRequestList": { 25247 "description": "PullRequestList", 25248 "schema": { 25249 "type": "array", 25250 "items": { 25251 "$ref": "#/definitions/PullRequest" 25252 } 25253 } 25254 }, 25255 "PullReview": { 25256 "description": "PullReview", 25257 "schema": { 25258 "$ref": "#/definitions/PullReview" 25259 } 25260 }, 25261 "PullReviewComment": { 25262 "description": "PullComment", 25263 "schema": { 25264 "$ref": "#/definitions/PullReviewComment" 25265 } 25266 }, 25267 "PullReviewCommentList": { 25268 "description": "PullCommentList", 25269 "schema": { 25270 "type": "array", 25271 "items": { 25272 "$ref": "#/definitions/PullReviewComment" 25273 } 25274 } 25275 }, 25276 "PullReviewList": { 25277 "description": "PullReviewList", 25278 "schema": { 25279 "type": "array", 25280 "items": { 25281 "$ref": "#/definitions/PullReview" 25282 } 25283 } 25284 }, 25285 "PushMirror": { 25286 "description": "PushMirror", 25287 "schema": { 25288 "$ref": "#/definitions/PushMirror" 25289 } 25290 }, 25291 "PushMirrorList": { 25292 "description": "PushMirrorList", 25293 "schema": { 25294 "type": "array", 25295 "items": { 25296 "$ref": "#/definitions/PushMirror" 25297 } 25298 } 25299 }, 25300 "Reaction": { 25301 "description": "Reaction", 25302 "schema": { 25303 "$ref": "#/definitions/Reaction" 25304 } 25305 }, 25306 "ReactionList": { 25307 "description": "ReactionList", 25308 "schema": { 25309 "type": "array", 25310 "items": { 25311 "$ref": "#/definitions/Reaction" 25312 } 25313 } 25314 }, 25315 "Reference": { 25316 "description": "Reference", 25317 "schema": { 25318 "$ref": "#/definitions/Reference" 25319 } 25320 }, 25321 "ReferenceList": { 25322 "description": "ReferenceList", 25323 "schema": { 25324 "type": "array", 25325 "items": { 25326 "$ref": "#/definitions/Reference" 25327 } 25328 } 25329 }, 25330 "RegistrationToken": { 25331 "description": "RegistrationToken is response related to registration token", 25332 "headers": { 25333 "token": { 25334 "type": "string" 25335 } 25336 } 25337 }, 25338 "Release": { 25339 "description": "Release", 25340 "schema": { 25341 "$ref": "#/definitions/Release" 25342 } 25343 }, 25344 "ReleaseList": { 25345 "description": "ReleaseList", 25346 "schema": { 25347 "type": "array", 25348 "items": { 25349 "$ref": "#/definitions/Release" 25350 } 25351 } 25352 }, 25353 "RepoCollaboratorPermission": { 25354 "description": "RepoCollaboratorPermission", 25355 "schema": { 25356 "$ref": "#/definitions/RepoCollaboratorPermission" 25357 } 25358 }, 25359 "RepoIssueConfig": { 25360 "description": "RepoIssueConfig", 25361 "schema": { 25362 "$ref": "#/definitions/IssueConfig" 25363 } 25364 }, 25365 "RepoIssueConfigValidation": { 25366 "description": "RepoIssueConfigValidation", 25367 "schema": { 25368 "$ref": "#/definitions/IssueConfigValidation" 25369 } 25370 }, 25371 "RepoNewIssuePinsAllowed": { 25372 "description": "RepoNewIssuePinsAllowed", 25373 "schema": { 25374 "$ref": "#/definitions/NewIssuePinsAllowed" 25375 } 25376 }, 25377 "Repository": { 25378 "description": "Repository", 25379 "schema": { 25380 "$ref": "#/definitions/Repository" 25381 } 25382 }, 25383 "RepositoryList": { 25384 "description": "RepositoryList", 25385 "schema": { 25386 "type": "array", 25387 "items": { 25388 "$ref": "#/definitions/Repository" 25389 } 25390 } 25391 }, 25392 "SearchResults": { 25393 "description": "SearchResults", 25394 "schema": { 25395 "$ref": "#/definitions/SearchResults" 25396 } 25397 }, 25398 "Secret": { 25399 "description": "Secret", 25400 "schema": { 25401 "$ref": "#/definitions/Secret" 25402 } 25403 }, 25404 "SecretList": { 25405 "description": "SecretList", 25406 "schema": { 25407 "type": "array", 25408 "items": { 25409 "$ref": "#/definitions/Secret" 25410 } 25411 } 25412 }, 25413 "ServerVersion": { 25414 "description": "ServerVersion", 25415 "schema": { 25416 "$ref": "#/definitions/ServerVersion" 25417 } 25418 }, 25419 "StopWatch": { 25420 "description": "StopWatch", 25421 "schema": { 25422 "$ref": "#/definitions/StopWatch" 25423 } 25424 }, 25425 "StopWatchList": { 25426 "description": "StopWatchList", 25427 "schema": { 25428 "type": "array", 25429 "items": { 25430 "$ref": "#/definitions/StopWatch" 25431 } 25432 } 25433 }, 25434 "StringSlice": { 25435 "description": "StringSlice", 25436 "schema": { 25437 "type": "array", 25438 "items": { 25439 "type": "string" 25440 } 25441 } 25442 }, 25443 "Tag": { 25444 "description": "Tag", 25445 "schema": { 25446 "$ref": "#/definitions/Tag" 25447 } 25448 }, 25449 "TagList": { 25450 "description": "TagList", 25451 "schema": { 25452 "type": "array", 25453 "items": { 25454 "$ref": "#/definitions/Tag" 25455 } 25456 } 25457 }, 25458 "Team": { 25459 "description": "Team", 25460 "schema": { 25461 "$ref": "#/definitions/Team" 25462 } 25463 }, 25464 "TeamList": { 25465 "description": "TeamList", 25466 "schema": { 25467 "type": "array", 25468 "items": { 25469 "$ref": "#/definitions/Team" 25470 } 25471 } 25472 }, 25473 "TimelineList": { 25474 "description": "TimelineList", 25475 "schema": { 25476 "type": "array", 25477 "items": { 25478 "$ref": "#/definitions/TimelineComment" 25479 } 25480 } 25481 }, 25482 "TopicListResponse": { 25483 "description": "TopicListResponse", 25484 "schema": { 25485 "type": "array", 25486 "items": { 25487 "$ref": "#/definitions/TopicResponse" 25488 } 25489 } 25490 }, 25491 "TopicNames": { 25492 "description": "TopicNames", 25493 "schema": { 25494 "$ref": "#/definitions/TopicName" 25495 } 25496 }, 25497 "TrackedTime": { 25498 "description": "TrackedTime", 25499 "schema": { 25500 "$ref": "#/definitions/TrackedTime" 25501 } 25502 }, 25503 "TrackedTimeList": { 25504 "description": "TrackedTimeList", 25505 "schema": { 25506 "type": "array", 25507 "items": { 25508 "$ref": "#/definitions/TrackedTime" 25509 } 25510 } 25511 }, 25512 "User": { 25513 "description": "User", 25514 "schema": { 25515 "$ref": "#/definitions/User" 25516 } 25517 }, 25518 "UserHeatmapData": { 25519 "description": "UserHeatmapData", 25520 "schema": { 25521 "type": "array", 25522 "items": { 25523 "$ref": "#/definitions/UserHeatmapData" 25524 } 25525 } 25526 }, 25527 "UserList": { 25528 "description": "UserList", 25529 "schema": { 25530 "type": "array", 25531 "items": { 25532 "$ref": "#/definitions/User" 25533 } 25534 } 25535 }, 25536 "UserSettings": { 25537 "description": "UserSettings", 25538 "schema": { 25539 "type": "array", 25540 "items": { 25541 "$ref": "#/definitions/UserSettings" 25542 } 25543 } 25544 }, 25545 "VariableList": { 25546 "description": "VariableList", 25547 "schema": { 25548 "type": "array", 25549 "items": { 25550 "$ref": "#/definitions/ActionVariable" 25551 } 25552 } 25553 }, 25554 "WatchInfo": { 25555 "description": "WatchInfo", 25556 "schema": { 25557 "$ref": "#/definitions/WatchInfo" 25558 } 25559 }, 25560 "WikiCommitList": { 25561 "description": "WikiCommitList", 25562 "schema": { 25563 "$ref": "#/definitions/WikiCommitList" 25564 } 25565 }, 25566 "WikiPage": { 25567 "description": "WikiPage", 25568 "schema": { 25569 "$ref": "#/definitions/WikiPage" 25570 } 25571 }, 25572 "WikiPageList": { 25573 "description": "WikiPageList", 25574 "schema": { 25575 "type": "array", 25576 "items": { 25577 "$ref": "#/definitions/WikiPageMetaData" 25578 } 25579 } 25580 }, 25581 "conflict": { 25582 "description": "APIConflict is a conflict empty response" 25583 }, 25584 "empty": { 25585 "description": "APIEmpty is an empty response" 25586 }, 25587 "error": { 25588 "description": "APIError is error format response", 25589 "headers": { 25590 "message": { 25591 "type": "string" 25592 }, 25593 "url": { 25594 "type": "string" 25595 } 25596 } 25597 }, 25598 "forbidden": { 25599 "description": "APIForbiddenError is a forbidden error response", 25600 "headers": { 25601 "message": { 25602 "type": "string" 25603 }, 25604 "url": { 25605 "type": "string" 25606 } 25607 } 25608 }, 25609 "invalidTopicsError": { 25610 "description": "APIInvalidTopicsError is error format response to invalid topics", 25611 "headers": { 25612 "invalidTopics": { 25613 "type": "array", 25614 "items": { 25615 "type": "string" 25616 } 25617 }, 25618 "message": { 25619 "type": "string" 25620 } 25621 } 25622 }, 25623 "notFound": { 25624 "description": "APINotFound is a not found empty response" 25625 }, 25626 "parameterBodies": { 25627 "description": "parameterBodies", 25628 "schema": { 25629 "$ref": "#/definitions/UpdateVariableOption" 25630 } 25631 }, 25632 "redirect": { 25633 "description": "APIRedirect is a redirect response" 25634 }, 25635 "repoArchivedError": { 25636 "description": "APIRepoArchivedError is an error that is raised when an archived repo should be modified", 25637 "headers": { 25638 "message": { 25639 "type": "string" 25640 }, 25641 "url": { 25642 "type": "string" 25643 } 25644 } 25645 }, 25646 "string": { 25647 "description": "APIString is a string response", 25648 "schema": { 25649 "type": "string" 25650 } 25651 }, 25652 "validationError": { 25653 "description": "APIValidationError is error format response related to input validation", 25654 "headers": { 25655 "message": { 25656 "type": "string" 25657 }, 25658 "url": { 25659 "type": "string" 25660 } 25661 } 25662 } 25663 }, 25664 "securityDefinitions": { 25665 "AccessToken": { 25666 "description": "This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead.", 25667 "type": "apiKey", 25668 "name": "access_token", 25669 "in": "query" 25670 }, 25671 "AuthorizationHeaderToken": { 25672 "description": "API tokens must be prepended with \"token\" followed by a space.", 25673 "type": "apiKey", 25674 "name": "Authorization", 25675 "in": "header" 25676 }, 25677 "BasicAuth": { 25678 "type": "basic" 25679 }, 25680 "SudoHeader": { 25681 "description": "Sudo API request as the user provided as the key. Admin privileges are required.", 25682 "type": "apiKey", 25683 "name": "Sudo", 25684 "in": "header" 25685 }, 25686 "SudoParam": { 25687 "description": "Sudo API request as the user provided as the key. Admin privileges are required.", 25688 "type": "apiKey", 25689 "name": "sudo", 25690 "in": "query" 25691 }, 25692 "TOTPHeader": { 25693 "description": "Must be used in combination with BasicAuth if two-factor authentication is enabled.", 25694 "type": "apiKey", 25695 "name": "X-GITEA-OTP", 25696 "in": "header" 25697 }, 25698 "Token": { 25699 "description": "This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead.", 25700 "type": "apiKey", 25701 "name": "token", 25702 "in": "query" 25703 } 25704 }, 25705 "security": [ 25706 { 25707 "BasicAuth": [] 25708 }, 25709 { 25710 "Token": [] 25711 }, 25712 { 25713 "AccessToken": [] 25714 }, 25715 { 25716 "AuthorizationHeaderToken": [] 25717 }, 25718 { 25719 "SudoParam": [] 25720 }, 25721 { 25722 "SudoHeader": [] 25723 }, 25724 { 25725 "TOTPHeader": [] 25726 } 25727 ] 25728 }