|
715 | 715 | } |
716 | 716 | } |
717 | 717 | }, |
718 | | - "/badges/{owner}/{repository}.png": { |
719 | | - "get": { |
720 | | - "tags": [ |
721 | | - "badges" |
722 | | - ], |
723 | | - "summary": "Get PNG badge", |
724 | | - "description": "Get badge in PNG image format", |
725 | | - "operationId": "badge_png_badges__owner___repository__png_get", |
726 | | - "deprecated": true, |
727 | | - "parameters": [ |
728 | | - { |
729 | | - "name": "owner", |
730 | | - "in": "path", |
731 | | - "required": true, |
732 | | - "schema": { |
733 | | - "type": "string", |
734 | | - "minLength": 1, |
735 | | - "maxLength": 40, |
736 | | - "pattern": "^[a-zA-Z0-9\\-]+$", |
737 | | - "description": "The owner of the repository", |
738 | | - "title": "Owner" |
739 | | - }, |
740 | | - "description": "The owner of the repository" |
741 | | - }, |
742 | | - { |
743 | | - "name": "repository", |
744 | | - "in": "path", |
745 | | - "required": true, |
746 | | - "schema": { |
747 | | - "type": "string", |
748 | | - "minLength": 1, |
749 | | - "maxLength": 100, |
750 | | - "pattern": "^[\\w\\-\\.]+$", |
751 | | - "description": "The name of the repository", |
752 | | - "title": "Repository" |
753 | | - }, |
754 | | - "description": "The name of the repository" |
755 | | - }, |
756 | | - { |
757 | | - "name": "style", |
758 | | - "in": "query", |
759 | | - "required": false, |
760 | | - "schema": { |
761 | | - "type": "string", |
762 | | - "description": "The style of the button, more details on https://shields.io/.", |
763 | | - "default": "flat", |
764 | | - "title": "Style" |
765 | | - }, |
766 | | - "description": "The style of the button, more details on https://shields.io/." |
767 | | - } |
768 | | - ], |
769 | | - "responses": { |
770 | | - "200": { |
771 | | - "description": "An PNG image.", |
772 | | - "content": { |
773 | | - "image/png": {} |
774 | | - } |
775 | | - }, |
776 | | - "403": { |
777 | | - "description": "Forbidden" |
778 | | - }, |
779 | | - "404": { |
780 | | - "description": "Not found" |
781 | | - }, |
782 | | - "409": { |
783 | | - "description": "Conflict" |
784 | | - }, |
785 | | - "422": { |
786 | | - "description": "Unprocessable entity" |
787 | | - } |
788 | | - } |
789 | | - } |
790 | | - }, |
791 | | - "/badges/{owner}/{repository}.svg": { |
792 | | - "get": { |
793 | | - "tags": [ |
794 | | - "badges" |
795 | | - ], |
796 | | - "summary": "Get SVG badge", |
797 | | - "description": "Get badge in SVG image format", |
798 | | - "operationId": "badge_svg_badges__owner___repository__svg_get", |
799 | | - "deprecated": true, |
800 | | - "parameters": [ |
801 | | - { |
802 | | - "name": "owner", |
803 | | - "in": "path", |
804 | | - "required": true, |
805 | | - "schema": { |
806 | | - "type": "string", |
807 | | - "minLength": 1, |
808 | | - "maxLength": 40, |
809 | | - "pattern": "^[a-zA-Z0-9\\-]+$", |
810 | | - "description": "The owner of the repository", |
811 | | - "title": "Owner" |
812 | | - }, |
813 | | - "description": "The owner of the repository" |
814 | | - }, |
815 | | - { |
816 | | - "name": "repository", |
817 | | - "in": "path", |
818 | | - "required": true, |
819 | | - "schema": { |
820 | | - "type": "string", |
821 | | - "minLength": 1, |
822 | | - "maxLength": 100, |
823 | | - "pattern": "^[\\w\\-\\.]+$", |
824 | | - "description": "The name of the repository", |
825 | | - "title": "Repository" |
826 | | - }, |
827 | | - "description": "The name of the repository" |
828 | | - }, |
829 | | - { |
830 | | - "name": "style", |
831 | | - "in": "query", |
832 | | - "required": false, |
833 | | - "schema": { |
834 | | - "type": "string", |
835 | | - "description": "The style of the button, more details on https://shields.io/.", |
836 | | - "default": "flat", |
837 | | - "title": "Style" |
838 | | - }, |
839 | | - "description": "The style of the button, more details on https://shields.io/." |
840 | | - } |
841 | | - ], |
842 | | - "responses": { |
843 | | - "200": { |
844 | | - "description": "An SVG image.", |
845 | | - "content": { |
846 | | - "image/png": {} |
847 | | - } |
848 | | - }, |
849 | | - "403": { |
850 | | - "description": "Forbidden" |
851 | | - }, |
852 | | - "404": { |
853 | | - "description": "Not found" |
854 | | - }, |
855 | | - "409": { |
856 | | - "description": "Conflict" |
857 | | - }, |
858 | | - "422": { |
859 | | - "description": "Unprocessable entity" |
860 | | - } |
861 | | - } |
862 | | - } |
863 | | - }, |
864 | | - "/badges/{owner}/{repository}": { |
865 | | - "get": { |
866 | | - "tags": [ |
867 | | - "badges" |
868 | | - ], |
869 | | - "summary": "Get shields.io badge config", |
870 | | - "description": "Get shields.io badge JSON configuration", |
871 | | - "operationId": "badge_badges__owner___repository__get", |
872 | | - "deprecated": true, |
873 | | - "parameters": [ |
874 | | - { |
875 | | - "name": "owner", |
876 | | - "in": "path", |
877 | | - "required": true, |
878 | | - "schema": { |
879 | | - "type": "string", |
880 | | - "minLength": 1, |
881 | | - "maxLength": 40, |
882 | | - "pattern": "^[a-zA-Z0-9\\-]+$", |
883 | | - "description": "The owner of the repository", |
884 | | - "title": "Owner" |
885 | | - }, |
886 | | - "description": "The owner of the repository" |
887 | | - }, |
888 | | - { |
889 | | - "name": "repository", |
890 | | - "in": "path", |
891 | | - "required": true, |
892 | | - "schema": { |
893 | | - "type": "string", |
894 | | - "minLength": 1, |
895 | | - "maxLength": 100, |
896 | | - "pattern": "^[\\w\\-\\.]+$", |
897 | | - "description": "The name of the repository", |
898 | | - "title": "Repository" |
899 | | - }, |
900 | | - "description": "The name of the repository" |
901 | | - } |
902 | | - ], |
903 | | - "responses": { |
904 | | - "200": { |
905 | | - "description": "The shields.io badge JSON configuration", |
906 | | - "content": { |
907 | | - "application/json": {} |
908 | | - } |
909 | | - }, |
910 | | - "403": { |
911 | | - "description": "Forbidden" |
912 | | - }, |
913 | | - "404": { |
914 | | - "description": "Not found" |
915 | | - }, |
916 | | - "409": { |
917 | | - "description": "Conflict" |
918 | | - }, |
919 | | - "422": { |
920 | | - "description": "Unprocessable entity" |
921 | | - } |
922 | | - } |
923 | | - } |
924 | | - }, |
925 | 718 | "/repos/{owner}/{repository}/pulls/{number}/simulator": { |
926 | 719 | "post": { |
927 | 720 | "tags": [ |
|
1525 | 1318 | "type": "null" |
1526 | 1319 | } |
1527 | 1320 | ], |
1528 | | - "description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get first/previous/next/last pages", |
| 1321 | + "description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get the previous/next pages", |
1529 | 1322 | "title": "Cursor" |
1530 | 1323 | }, |
1531 | | - "description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get first/previous/next/last pages" |
| 1324 | + "description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get the previous/next pages" |
1532 | 1325 | }, |
1533 | 1326 | { |
1534 | 1327 | "name": "per_page", |
|
1557 | 1350 | }, |
1558 | 1351 | "headers": { |
1559 | 1352 | "Link": { |
1560 | | - "description": "Pagination links (rfc5988)", |
1561 | | - "example": "Link: <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=def&per_page=20>; rel=\"next\",\n <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=xyz&per_page=20>; rel=\"last\",\n <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=abc&per_page=20>; rel=\"first\",\n <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=abc&per_page=20>; rel=\"prev\"", |
| 1353 | + "description": "Pagination links (rfc5988). `next` and `prev` are each present only when there is a page to go to, so a response with nothing before or after it carries no `Link` header at all. To return to the first page, call the endpoint again without a `cursor`.", |
| 1354 | + "example": "Link: <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=def&per_page=20>; rel=\"next\",\n <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=abc&per_page=20>; rel=\"prev\"", |
1562 | 1355 | "schema": { |
1563 | 1356 | "type": "string" |
1564 | 1357 | } |
|
5499 | 5292 | "type": "null" |
5500 | 5293 | } |
5501 | 5294 | ], |
5502 | | - "description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get first/previous/next/last pages", |
| 5295 | + "description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get the previous/next pages", |
5503 | 5296 | "title": "Cursor" |
5504 | 5297 | }, |
5505 | | - "description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get first/previous/next/last pages" |
| 5298 | + "description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get the previous/next pages" |
5506 | 5299 | }, |
5507 | 5300 | { |
5508 | 5301 | "name": "per_page", |
|
6206 | 5999 | "type": "null" |
6207 | 6000 | } |
6208 | 6001 | ], |
6209 | | - "description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get first/previous/next/last pages", |
| 6002 | + "description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get the previous/next pages", |
6210 | 6003 | "title": "Cursor" |
6211 | 6004 | }, |
6212 | | - "description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get first/previous/next/last pages" |
| 6005 | + "description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get the previous/next pages" |
6213 | 6006 | }, |
6214 | 6007 | { |
6215 | 6008 | "name": "per_page", |
|
6402 | 6195 | "type": "null" |
6403 | 6196 | } |
6404 | 6197 | ], |
6405 | | - "description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get first/previous/next/last pages.", |
| 6198 | + "description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get the previous/next pages.", |
6406 | 6199 | "title": "Cursor" |
6407 | 6200 | }, |
6408 | | - "description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get first/previous/next/last pages." |
| 6201 | + "description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get the previous/next pages." |
6409 | 6202 | }, |
6410 | 6203 | { |
6411 | 6204 | "name": "per_page", |
|
6440 | 6233 | }, |
6441 | 6234 | "headers": { |
6442 | 6235 | "Link": { |
6443 | | - "description": "Pagination links (rfc5988)", |
6444 | | - "example": "Link: <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=def&per_page=20>; rel=\"next\",\n <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=xyz&per_page=20>; rel=\"last\",\n <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=abc&per_page=20>; rel=\"first\",\n <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=abc&per_page=20>; rel=\"prev\"", |
| 6236 | + "description": "Pagination links (rfc5988). `next` and `prev` are each present only when there is a page to go to, so a response with nothing before or after it carries no `Link` header at all. To return to the first page, call the endpoint again without a `cursor`.", |
| 6237 | + "example": "Link: <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=def&per_page=20>; rel=\"next\",\n <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=abc&per_page=20>; rel=\"prev\"", |
6445 | 6238 | "schema": { |
6446 | 6239 | "type": "string" |
6447 | 6240 | } |
|
20159 | 19952 | "name": "applications", |
20160 | 19953 | "description": "Operations with applications." |
20161 | 19954 | }, |
20162 | | - { |
20163 | | - "name": "badges", |
20164 | | - "description": "Operations with badges." |
20165 | | - }, |
20166 | 19955 | { |
20167 | 19956 | "name": "ci_insights", |
20168 | 19957 | "description": "Operations with ci insights." |
|
0 commit comments