+5

.changeset/short-suits-hunt.md

··· 1 1 + --- 2 2 + '@hey-api/openapi-ts': patch 3 3 + --- 4 4 + 5 5 + fix: do not generate types tree by default if services are enabled as it is unused

+6 -3

packages/openapi-ts/src/index.ts

··· 180 180 return services; 181 181 }; 182 182 183 183 - const getTypes = (userConfig: ClientConfig): Config['types'] => { 183 183 + const getTypes = ( 184 184 + userConfig: ClientConfig, 185 185 + services: Config['services'], 186 186 + ): Config['types'] => { 184 187 let types: Config['types'] = { 185 188 dates: false, 186 189 enums: false, 187 190 export: true, 188 191 name: 'preserve', 189 189 - tree: true, 192 192 + tree: !services.export, 190 193 }; 191 194 if (typeof userConfig.types === 'boolean') { 192 195 types.export = userConfig.types; ··· 273 276 const plugins = getPlugins(userConfig); 274 277 const schemas = getSchemas(userConfig); 275 278 const services = getServices(userConfig); 276 276 - const types = getTypes(userConfig); 279 279 + const types = getTypes(userConfig, services); 277 280 278 281 output.path = path.resolve(process.cwd(), output.path); 279 282

+1 -270

packages/openapi-ts/test/__snapshots__/test/generated/v2/types.gen.ts.snap

··· 755 755 nonAsciiParamæøåÆøÅöôêÊ: number; 756 756 }; 757 757 758 758 - export type NonAsciiæøåÆøÅöôêÊ字符串Response = NonAsciiStringæøåÆØÅöôêÊ字符串; 759 759 - 760 760 - export type $OpenApiTs = { 761 761 - '/api/v{api-version}/body': { 762 762 - post: { 763 763 - req: PostApiBodyData; 764 764 - res: { 765 765 - /** 766 766 - * OK 767 767 - */ 768 768 - 200: response_PostActivityResponse; 769 769 - /** 770 770 - * Bad Request 771 771 - */ 772 772 - 400: failure_Failure; 773 773 - /** 774 774 - * Internal Server Error 775 775 - */ 776 776 - 500: failure_Failure; 777 777 - }; 778 778 - }; 779 779 - }; 780 780 - '/api/v{api-version}/descriptions/': { 781 781 - post: { 782 782 - req: CallWithDescriptionsData; 783 783 - }; 784 784 - }; 785 785 - '/api/v{api-version}/parameters/{parameterPath}': { 786 786 - post: { 787 787 - req: CallWithParametersData; 788 788 - }; 789 789 - }; 790 790 - '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}': { 791 791 - post: { 792 792 - req: CallWithWeirdParameterNamesData; 793 793 - }; 794 794 - }; 795 795 - '/api/v{api-version}/defaults': { 796 796 - get: { 797 797 - req: CallWithDefaultParametersData; 798 798 - }; 799 799 - post: { 800 800 - req: CallWithDefaultOptionalParametersData; 801 801 - }; 802 802 - put: { 803 803 - req: CallToTestOrderOfParamsData; 804 804 - }; 805 805 - }; 806 806 - '/api/v{api-version}/no-content': { 807 807 - get: { 808 808 - res: { 809 809 - /** 810 810 - * Success 811 811 - */ 812 812 - 204: void; 813 813 - }; 814 814 - }; 815 815 - }; 816 816 - '/api/v{api-version}/multiple-tags/response-and-no-content': { 817 817 - get: { 818 818 - res: { 819 819 - /** 820 820 - * Response is a simple number 821 821 - */ 822 822 - 200: unknown; 823 823 - /** 824 824 - * Success 825 825 - */ 826 826 - 204: void; 827 827 - }; 828 828 - }; 829 829 - }; 830 830 - '/api/v{api-version}/response': { 831 831 - get: { 832 832 - res: { 833 833 - /** 834 834 - * Message for default response 835 835 - */ 836 836 - default: ModelWithString; 837 837 - }; 838 838 - }; 839 839 - post: { 840 840 - res: { 841 841 - /** 842 842 - * Message for 201 response 843 843 - */ 844 844 - 201: ModelWithString; 845 845 - /** 846 846 - * Message for 202 response 847 847 - */ 848 848 - 202: ModelWithString; 849 849 - /** 850 850 - * Message for 500 error 851 851 - */ 852 852 - 500: ModelWithStringError; 853 853 - /** 854 854 - * Message for 501 error 855 855 - */ 856 856 - 501: ModelWithStringError; 857 857 - /** 858 858 - * Message for 502 error 859 859 - */ 860 860 - 502: ModelWithStringError; 861 861 - /** 862 862 - * Message for default response 863 863 - */ 864 864 - default: ModelWithString; 865 865 - }; 866 866 - }; 867 867 - put: { 868 868 - res: { 869 869 - /** 870 870 - * Message for 200 response 871 871 - */ 872 872 - 200: { 873 873 - readonly '@namespace.string'?: string; 874 874 - readonly '@namespace.integer'?: number; 875 875 - readonly value?: Array<ModelWithString>; 876 876 - }; 877 877 - /** 878 878 - * Message for 201 response 879 879 - */ 880 880 - 201: ModelThatExtends; 881 881 - /** 882 882 - * Message for 202 response 883 883 - */ 884 884 - 202: ModelThatExtendsExtends; 885 885 - /** 886 886 - * Message for 500 error 887 887 - */ 888 888 - 500: ModelWithStringError; 889 889 - /** 890 890 - * Message for 501 error 891 891 - */ 892 892 - 501: ModelWithStringError; 893 893 - /** 894 894 - * Message for 502 error 895 895 - */ 896 896 - 502: ModelWithStringError; 897 897 - /** 898 898 - * Message for default response 899 899 - */ 900 900 - default: ModelWithString; 901 901 - }; 902 902 - }; 903 903 - }; 904 904 - '/api/v{api-version}/multiple-tags/a': { 905 905 - get: { 906 906 - res: { 907 907 - /** 908 908 - * Success 909 909 - */ 910 910 - 204: void; 911 911 - }; 912 912 - }; 913 913 - }; 914 914 - '/api/v{api-version}/multiple-tags/b': { 915 915 - get: { 916 916 - res: { 917 917 - /** 918 918 - * Success 919 919 - */ 920 920 - 204: void; 921 921 - }; 922 922 - }; 923 923 - }; 924 924 - '/api/v{api-version}/collectionFormat': { 925 925 - get: { 926 926 - req: CollectionFormatData; 927 927 - }; 928 928 - }; 929 929 - '/api/v{api-version}/types': { 930 930 - get: { 931 931 - req: TypesData; 932 932 - res: { 933 933 - /** 934 934 - * Response is a simple number 935 935 - */ 936 936 - 200: number; 937 937 - /** 938 938 - * Response is a simple string 939 939 - */ 940 940 - 201: string; 941 941 - /** 942 942 - * Response is a simple boolean 943 943 - */ 944 944 - 202: boolean; 945 945 - /** 946 946 - * Response is a simple object 947 947 - */ 948 948 - 203: unknown; 949 949 - }; 950 950 - }; 951 951 - }; 952 952 - '/api/v{api-version}/complex': { 953 953 - get: { 954 954 - req: ComplexTypesData; 955 955 - res: { 956 956 - /** 957 957 - * Successful response 958 958 - */ 959 959 - 200: Array<ModelWithString>; 960 960 - /** 961 961 - * 400 server error 962 962 - */ 963 963 - 400: unknown; 964 964 - /** 965 965 - * 500 server error 966 966 - */ 967 967 - 500: unknown; 968 968 - }; 969 969 - }; 970 970 - }; 971 971 - '/api/v{api-version}/header': { 972 972 - post: { 973 973 - res: { 974 974 - /** 975 975 - * Successful response 976 976 - */ 977 977 - 200: string; 978 978 - /** 979 979 - * 400 server error 980 980 - */ 981 981 - 400: unknown; 982 982 - /** 983 983 - * 500 server error 984 984 - */ 985 985 - 500: unknown; 986 986 - }; 987 987 - }; 988 988 - }; 989 989 - '/api/v{api-version}/error': { 990 990 - post: { 991 991 - req: TestErrorCodeData; 992 992 - res: { 993 993 - /** 994 994 - * Custom message: Successful response 995 995 - */ 996 996 - 200: unknown; 997 997 - /** 998 998 - * Custom message: Internal Server Error 999 999 - */ 1000 1000 - 500: unknown; 1001 1001 - /** 1002 1002 - * Custom message: Not Implemented 1003 1003 - */ 1004 1004 - 501: unknown; 1005 1005 - /** 1006 1006 - * Custom message: Bad Gateway 1007 1007 - */ 1008 1008 - 502: unknown; 1009 1009 - /** 1010 1010 - * Custom message: Service Unavailable 1011 1011 - */ 1012 1012 - 503: unknown; 1013 1013 - }; 1014 1014 - }; 1015 1015 - }; 1016 1016 - '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串': { 1017 1017 - post: { 1018 1018 - req: NonAsciiæøåÆøÅöôêÊ字符串Data; 1019 1019 - res: { 1020 1020 - /** 1021 1021 - * Successful response 1022 1022 - */ 1023 1023 - 200: NonAsciiStringæøåÆØÅöôêÊ字符串; 1024 1024 - }; 1025 1025 - }; 1026 1026 - }; 1027 1027 - }; 758 758 + export type NonAsciiæøåÆøÅöôêÊ字符串Response = NonAsciiStringæøåÆØÅöôêÊ字符串;

-369

packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-axios-bundle/types.gen.ts.snap

··· 1578 1578 1579 1579 export type PutWithFormUrlEncodedData = { 1580 1580 body: ArrayWithStrings; 1581 1581 - }; 1582 1582 - 1583 1583 - export type $OpenApiTs = { 1584 1584 - '/api/v{api-version}/no-tag': { 1585 1585 - post: { 1586 1586 - req: ImportData; 1587 1587 - res: { 1588 1588 - /** 1589 1589 - * Success 1590 1590 - */ 1591 1591 - '200': Model_From_Zendesk; 1592 1592 - /** 1593 1593 - * Default success response 1594 1594 - */ 1595 1595 - default: ModelWithReadOnlyAndWriteOnly; 1596 1596 - }; 1597 1597 - }; 1598 1598 - }; 1599 1599 - '/api/v{api-version}/simple/$count': { 1600 1600 - get: { 1601 1601 - res: { 1602 1602 - /** 1603 1603 - * Success 1604 1604 - */ 1605 1605 - '200': Model_From_Zendesk; 1606 1606 - }; 1607 1607 - }; 1608 1608 - }; 1609 1609 - '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}': { 1610 1610 - delete: { 1611 1611 - req: DeleteFooData3; 1612 1612 - }; 1613 1613 - }; 1614 1614 - '/api/v{api-version}/descriptions/': { 1615 1615 - post: { 1616 1616 - req: CallWithDescriptionsData; 1617 1617 - }; 1618 1618 - }; 1619 1619 - '/api/v{api-version}/parameters/deprecated': { 1620 1620 - post: { 1621 1621 - req: DeprecatedCallData; 1622 1622 - }; 1623 1623 - }; 1624 1624 - '/api/v{api-version}/parameters/{parameterPath}': { 1625 1625 - post: { 1626 1626 - req: CallWithParametersData; 1627 1627 - }; 1628 1628 - }; 1629 1629 - '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}': { 1630 1630 - post: { 1631 1631 - req: CallWithWeirdParameterNamesData; 1632 1632 - }; 1633 1633 - }; 1634 1634 - '/api/v{api-version}/parameters/': { 1635 1635 - get: { 1636 1636 - req: GetCallWithOptionalParamData; 1637 1637 - }; 1638 1638 - post: { 1639 1639 - req: PostCallWithOptionalParamData; 1640 1640 - res: { 1641 1641 - /** 1642 1642 - * Response is a simple number 1643 1643 - */ 1644 1644 - '200': number; 1645 1645 - /** 1646 1646 - * Success 1647 1647 - */ 1648 1648 - '204': void; 1649 1649 - }; 1650 1650 - }; 1651 1651 - }; 1652 1652 - '/api/v{api-version}/requestBody/': { 1653 1653 - post: { 1654 1654 - req: PostApiVbyApiVersionRequestBodyData; 1655 1655 - }; 1656 1656 - }; 1657 1657 - '/api/v{api-version}/formData/': { 1658 1658 - post: { 1659 1659 - req: PostApiVbyApiVersionFormDataData; 1660 1660 - }; 1661 1661 - }; 1662 1662 - '/api/v{api-version}/defaults': { 1663 1663 - get: { 1664 1664 - req: CallWithDefaultParametersData; 1665 1665 - }; 1666 1666 - post: { 1667 1667 - req: CallWithDefaultOptionalParametersData; 1668 1668 - }; 1669 1669 - put: { 1670 1670 - req: CallToTestOrderOfParamsData; 1671 1671 - }; 1672 1672 - }; 1673 1673 - '/api/v{api-version}/no-content': { 1674 1674 - get: { 1675 1675 - res: { 1676 1676 - /** 1677 1677 - * Success 1678 1678 - */ 1679 1679 - '204': void; 1680 1680 - }; 1681 1681 - }; 1682 1682 - }; 1683 1683 - '/api/v{api-version}/multiple-tags/response-and-no-content': { 1684 1684 - get: { 1685 1685 - res: { 1686 1686 - /** 1687 1687 - * Response is a simple number 1688 1688 - */ 1689 1689 - '200': number; 1690 1690 - /** 1691 1691 - * Success 1692 1692 - */ 1693 1693 - '204': void; 1694 1694 - }; 1695 1695 - }; 1696 1696 - }; 1697 1697 - '/api/v{api-version}/multiple-tags/a': { 1698 1698 - get: { 1699 1699 - res: { 1700 1700 - '200': _400; 1701 1701 - }; 1702 1702 - }; 1703 1703 - }; 1704 1704 - '/api/v{api-version}/multiple-tags/b': { 1705 1705 - get: { 1706 1706 - res: { 1707 1707 - /** 1708 1708 - * Success 1709 1709 - */ 1710 1710 - '204': void; 1711 1711 - }; 1712 1712 - }; 1713 1713 - }; 1714 1714 - '/api/v{api-version}/response': { 1715 1715 - get: { 1716 1716 - res: { 1717 1717 - default: _import; 1718 1718 - }; 1719 1719 - }; 1720 1720 - post: { 1721 1721 - res: { 1722 1722 - /** 1723 1723 - * Message for 200 response 1724 1724 - */ 1725 1725 - '200': ModelWithBoolean & ModelWithInteger; 1726 1726 - /** 1727 1727 - * Message for 201 response 1728 1728 - */ 1729 1729 - '201': ModelWithString; 1730 1730 - /** 1731 1731 - * Message for 202 response 1732 1732 - */ 1733 1733 - '202': ModelWithString; 1734 1734 - /** 1735 1735 - * Message for 500 error 1736 1736 - */ 1737 1737 - '500': ModelWithStringError; 1738 1738 - /** 1739 1739 - * Message for 501 error 1740 1740 - */ 1741 1741 - '501': ModelWithStringError; 1742 1742 - /** 1743 1743 - * Message for 502 error 1744 1744 - */ 1745 1745 - '502': ModelWithStringError; 1746 1746 - /** 1747 1747 - * Message for 4XX errors 1748 1748 - */ 1749 1749 - '4XX': DictionaryWithArray; 1750 1750 - /** 1751 1751 - * Default error response 1752 1752 - */ 1753 1753 - default: ModelWithBoolean; 1754 1754 - }; 1755 1755 - }; 1756 1756 - put: { 1757 1757 - res: { 1758 1758 - /** 1759 1759 - * Message for 200 response 1760 1760 - */ 1761 1761 - '200': { 1762 1762 - readonly '@namespace.string'?: string; 1763 1763 - readonly '@namespace.integer'?: number; 1764 1764 - readonly value?: Array<ModelWithString>; 1765 1765 - }; 1766 1766 - /** 1767 1767 - * Message for 201 response 1768 1768 - */ 1769 1769 - '201': ModelThatExtends; 1770 1770 - /** 1771 1771 - * Message for 202 response 1772 1772 - */ 1773 1773 - '202': ModelThatExtendsExtends; 1774 1774 - /** 1775 1775 - * Message for 500 error 1776 1776 - */ 1777 1777 - '500': ModelWithStringError; 1778 1778 - /** 1779 1779 - * Message for 501 error 1780 1780 - */ 1781 1781 - '501': ModelWithStringError; 1782 1782 - /** 1783 1783 - * Message for 502 error 1784 1784 - */ 1785 1785 - '502': ModelWithStringError; 1786 1786 - /** 1787 1787 - * Message for default response 1788 1788 - */ 1789 1789 - default: ModelWithStringError; 1790 1790 - }; 1791 1791 - }; 1792 1792 - }; 1793 1793 - '/api/v{api-version}/collectionFormat': { 1794 1794 - get: { 1795 1795 - req: CollectionFormatData; 1796 1796 - }; 1797 1797 - }; 1798 1798 - '/api/v{api-version}/types': { 1799 1799 - get: { 1800 1800 - req: TypesData; 1801 1801 - res: { 1802 1802 - /** 1803 1803 - * Response is a simple number 1804 1804 - */ 1805 1805 - '200': number; 1806 1806 - /** 1807 1807 - * Response is a simple string 1808 1808 - */ 1809 1809 - '201': string; 1810 1810 - /** 1811 1811 - * Response is a simple boolean 1812 1812 - */ 1813 1813 - '202': boolean; 1814 1814 - /** 1815 1815 - * Response is a simple object 1816 1816 - */ 1817 1817 - '203': { 1818 1818 - [key: string]: unknown; 1819 1819 - }; 1820 1820 - }; 1821 1821 - }; 1822 1822 - }; 1823 1823 - '/api/v{api-version}/upload': { 1824 1824 - post: { 1825 1825 - req: UploadFileData; 1826 1826 - res: { 1827 1827 - '200': boolean; 1828 1828 - }; 1829 1829 - }; 1830 1830 - }; 1831 1831 - '/api/v{api-version}/file/{id}': { 1832 1832 - get: { 1833 1833 - req: FileResponseData; 1834 1834 - res: { 1835 1835 - /** 1836 1836 - * Success 1837 1837 - */ 1838 1838 - '200': (Blob | File); 1839 1839 - }; 1840 1840 - }; 1841 1841 - }; 1842 1842 - '/api/v{api-version}/complex': { 1843 1843 - get: { 1844 1844 - req: ComplexTypesData; 1845 1845 - res: { 1846 1846 - /** 1847 1847 - * Successful response 1848 1848 - */ 1849 1849 - '200': Array<ModelWithString>; 1850 1850 - /** 1851 1851 - * 400 `server` error 1852 1852 - */ 1853 1853 - '400': unknown; 1854 1854 - /** 1855 1855 - * 500 server error 1856 1856 - */ 1857 1857 - '500': unknown; 1858 1858 - }; 1859 1859 - }; 1860 1860 - }; 1861 1861 - '/api/v{api-version}/multipart': { 1862 1862 - post: { 1863 1863 - req: MultipartRequestData; 1864 1864 - }; 1865 1865 - get: { 1866 1866 - res: { 1867 1867 - /** 1868 1868 - * OK 1869 1869 - */ 1870 1870 - '200': { 1871 1871 - file?: (Blob | File); 1872 1872 - metadata?: { 1873 1873 - foo?: string; 1874 1874 - bar?: string; 1875 1875 - }; 1876 1876 - }; 1877 1877 - }; 1878 1878 - }; 1879 1879 - }; 1880 1880 - '/api/v{api-version}/complex/{id}': { 1881 1881 - put: { 1882 1882 - req: ComplexParamsData; 1883 1883 - res: { 1884 1884 - /** 1885 1885 - * Success 1886 1886 - */ 1887 1887 - '200': ModelWithString; 1888 1888 - }; 1889 1889 - }; 1890 1890 - }; 1891 1891 - '/api/v{api-version}/header': { 1892 1892 - post: { 1893 1893 - res: { 1894 1894 - /** 1895 1895 - * Successful response 1896 1896 - */ 1897 1897 - '200': string; 1898 1898 - /** 1899 1899 - * 400 server error 1900 1900 - */ 1901 1901 - '400': unknown; 1902 1902 - /** 1903 1903 - * 500 server error 1904 1904 - */ 1905 1905 - '500': unknown; 1906 1906 - }; 1907 1907 - }; 1908 1908 - }; 1909 1909 - '/api/v{api-version}/error': { 1910 1910 - post: { 1911 1911 - req: TestErrorCodeData; 1912 1912 - res: { 1913 1913 - /** 1914 1914 - * Custom message: Successful response 1915 1915 - */ 1916 1916 - '200': unknown; 1917 1917 - /** 1918 1918 - * Custom message: Internal Server Error 1919 1919 - */ 1920 1920 - '500': unknown; 1921 1921 - /** 1922 1922 - * Custom message: Not Implemented 1923 1923 - */ 1924 1924 - '501': unknown; 1925 1925 - /** 1926 1926 - * Custom message: Bad Gateway 1927 1927 - */ 1928 1928 - '502': unknown; 1929 1929 - /** 1930 1930 - * Custom message: Service Unavailable 1931 1931 - */ 1932 1932 - '503': unknown; 1933 1933 - }; 1934 1934 - }; 1935 1935 - }; 1936 1936 - '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串': { 1937 1937 - post: { 1938 1938 - req: NonAsciiæøåÆøÅöôêÊ字符串Data; 1939 1939 - res: { 1940 1940 - /** 1941 1941 - * Successful response 1942 1942 - */ 1943 1943 - '200': Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1944 1944 - }; 1945 1945 - }; 1946 1946 - put: { 1947 1947 - req: PutWithFormUrlEncodedData; 1948 1948 - }; 1949 1949 - }; 1950 1581 };

-69

packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-axios-bundle_transform/types.gen.ts.snap

··· 58 58 59 59 export type MultipleResponsesError = unknown; 60 60 61 61 - export type $OpenApiTs = { 62 62 - '/api/model-with-dates': { 63 63 - post: { 64 64 - res: { 65 65 - /** 66 66 - * Success 67 67 - */ 68 68 - '200': ParentModelWithDates; 69 69 - /** 70 70 - * Success 71 71 - */ 72 72 - '201': unknown; 73 73 - }; 74 74 - }; 75 75 - put: { 76 76 - res: { 77 77 - /** 78 78 - * Success 79 79 - */ 80 80 - '200': ModelWithDates; 81 81 - }; 82 82 - }; 83 83 - }; 84 84 - '/api/model-with-dates-array': { 85 85 - put: { 86 86 - res: { 87 87 - /** 88 88 - * Success 89 89 - */ 90 90 - '200': Array<ModelWithDates>; 91 91 - }; 92 92 - }; 93 93 - }; 94 94 - '/api/array-of-dates': { 95 95 - put: { 96 96 - res: { 97 97 - /** 98 98 - * Success 99 99 - */ 100 100 - '200': Array<(Date)>; 101 101 - }; 102 102 - }; 103 103 - }; 104 104 - '/api/date': { 105 105 - put: { 106 106 - res: { 107 107 - /** 108 108 - * Success 109 109 - */ 110 110 - '200': Date; 111 111 - }; 112 112 - }; 113 113 - }; 114 114 - '/api/multiple-responses': { 115 115 - put: { 116 116 - res: { 117 117 - /** 118 118 - * Updated 119 119 - */ 120 120 - '200': Array<ModelWithDates>; 121 121 - /** 122 122 - * Created 123 123 - */ 124 124 - '201': Array<SimpleModel>; 125 125 - }; 126 126 - }; 127 127 - }; 128 128 - }; 129 129 - 130 61 export type ParentModelWithDatesResponseTransformer = (data: any) => Promise<ParentModelWithDatesResponse>; 131 62 132 63 export type ParentModelWithDatesModelResponseTransformer = (data: any) => ParentModelWithDates;

-369

packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-axios-class/types.gen.ts.snap

··· 1578 1578 1579 1579 export type PutWithFormUrlEncodedData = { 1580 1580 body: ArrayWithStrings; 1581 1581 - }; 1582 1582 - 1583 1583 - export type $OpenApiTs = { 1584 1584 - '/api/v{api-version}/no-tag': { 1585 1585 - post: { 1586 1586 - req: ImportData; 1587 1587 - res: { 1588 1588 - /** 1589 1589 - * Success 1590 1590 - */ 1591 1591 - '200': Model_From_Zendesk; 1592 1592 - /** 1593 1593 - * Default success response 1594 1594 - */ 1595 1595 - default: ModelWithReadOnlyAndWriteOnly; 1596 1596 - }; 1597 1597 - }; 1598 1598 - }; 1599 1599 - '/api/v{api-version}/simple/$count': { 1600 1600 - get: { 1601 1601 - res: { 1602 1602 - /** 1603 1603 - * Success 1604 1604 - */ 1605 1605 - '200': Model_From_Zendesk; 1606 1606 - }; 1607 1607 - }; 1608 1608 - }; 1609 1609 - '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}': { 1610 1610 - delete: { 1611 1611 - req: DeleteFooData3; 1612 1612 - }; 1613 1613 - }; 1614 1614 - '/api/v{api-version}/parameters/{parameterPath}': { 1615 1615 - post: { 1616 1616 - req: CallWithParametersData; 1617 1617 - }; 1618 1618 - }; 1619 1619 - '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}': { 1620 1620 - post: { 1621 1621 - req: CallWithWeirdParameterNamesData; 1622 1622 - }; 1623 1623 - }; 1624 1624 - '/api/v{api-version}/parameters/': { 1625 1625 - get: { 1626 1626 - req: GetCallWithOptionalParamData; 1627 1627 - }; 1628 1628 - post: { 1629 1629 - req: PostCallWithOptionalParamData; 1630 1630 - res: { 1631 1631 - /** 1632 1632 - * Response is a simple number 1633 1633 - */ 1634 1634 - '200': number; 1635 1635 - /** 1636 1636 - * Success 1637 1637 - */ 1638 1638 - '204': void; 1639 1639 - }; 1640 1640 - }; 1641 1641 - }; 1642 1642 - '/api/v{api-version}/descriptions/': { 1643 1643 - post: { 1644 1644 - req: CallWithDescriptionsData; 1645 1645 - }; 1646 1646 - }; 1647 1647 - '/api/v{api-version}/parameters/deprecated': { 1648 1648 - post: { 1649 1649 - req: DeprecatedCallData; 1650 1650 - }; 1651 1651 - }; 1652 1652 - '/api/v{api-version}/requestBody/': { 1653 1653 - post: { 1654 1654 - req: PostApiVbyApiVersionRequestBodyData; 1655 1655 - }; 1656 1656 - }; 1657 1657 - '/api/v{api-version}/formData/': { 1658 1658 - post: { 1659 1659 - req: PostApiVbyApiVersionFormDataData; 1660 1660 - }; 1661 1661 - }; 1662 1662 - '/api/v{api-version}/defaults': { 1663 1663 - get: { 1664 1664 - req: CallWithDefaultParametersData; 1665 1665 - }; 1666 1666 - post: { 1667 1667 - req: CallWithDefaultOptionalParametersData; 1668 1668 - }; 1669 1669 - put: { 1670 1670 - req: CallToTestOrderOfParamsData; 1671 1671 - }; 1672 1672 - }; 1673 1673 - '/api/v{api-version}/no-content': { 1674 1674 - get: { 1675 1675 - res: { 1676 1676 - /** 1677 1677 - * Success 1678 1678 - */ 1679 1679 - '204': void; 1680 1680 - }; 1681 1681 - }; 1682 1682 - }; 1683 1683 - '/api/v{api-version}/multiple-tags/response-and-no-content': { 1684 1684 - get: { 1685 1685 - res: { 1686 1686 - /** 1687 1687 - * Response is a simple number 1688 1688 - */ 1689 1689 - '200': number; 1690 1690 - /** 1691 1691 - * Success 1692 1692 - */ 1693 1693 - '204': void; 1694 1694 - }; 1695 1695 - }; 1696 1696 - }; 1697 1697 - '/api/v{api-version}/response': { 1698 1698 - get: { 1699 1699 - res: { 1700 1700 - default: _import; 1701 1701 - }; 1702 1702 - }; 1703 1703 - post: { 1704 1704 - res: { 1705 1705 - /** 1706 1706 - * Message for 200 response 1707 1707 - */ 1708 1708 - '200': ModelWithBoolean & ModelWithInteger; 1709 1709 - /** 1710 1710 - * Message for 201 response 1711 1711 - */ 1712 1712 - '201': ModelWithString; 1713 1713 - /** 1714 1714 - * Message for 202 response 1715 1715 - */ 1716 1716 - '202': ModelWithString; 1717 1717 - /** 1718 1718 - * Message for 500 error 1719 1719 - */ 1720 1720 - '500': ModelWithStringError; 1721 1721 - /** 1722 1722 - * Message for 501 error 1723 1723 - */ 1724 1724 - '501': ModelWithStringError; 1725 1725 - /** 1726 1726 - * Message for 502 error 1727 1727 - */ 1728 1728 - '502': ModelWithStringError; 1729 1729 - /** 1730 1730 - * Message for 4XX errors 1731 1731 - */ 1732 1732 - '4XX': DictionaryWithArray; 1733 1733 - /** 1734 1734 - * Default error response 1735 1735 - */ 1736 1736 - default: ModelWithBoolean; 1737 1737 - }; 1738 1738 - }; 1739 1739 - put: { 1740 1740 - res: { 1741 1741 - /** 1742 1742 - * Message for 200 response 1743 1743 - */ 1744 1744 - '200': { 1745 1745 - readonly '@namespace.string'?: string; 1746 1746 - readonly '@namespace.integer'?: number; 1747 1747 - readonly value?: Array<ModelWithString>; 1748 1748 - }; 1749 1749 - /** 1750 1750 - * Message for 201 response 1751 1751 - */ 1752 1752 - '201': ModelThatExtends; 1753 1753 - /** 1754 1754 - * Message for 202 response 1755 1755 - */ 1756 1756 - '202': ModelThatExtendsExtends; 1757 1757 - /** 1758 1758 - * Message for 500 error 1759 1759 - */ 1760 1760 - '500': ModelWithStringError; 1761 1761 - /** 1762 1762 - * Message for 501 error 1763 1763 - */ 1764 1764 - '501': ModelWithStringError; 1765 1765 - /** 1766 1766 - * Message for 502 error 1767 1767 - */ 1768 1768 - '502': ModelWithStringError; 1769 1769 - /** 1770 1770 - * Message for default response 1771 1771 - */ 1772 1772 - default: ModelWithStringError; 1773 1773 - }; 1774 1774 - }; 1775 1775 - }; 1776 1776 - '/api/v{api-version}/multiple-tags/a': { 1777 1777 - get: { 1778 1778 - res: { 1779 1779 - '200': _400; 1780 1780 - }; 1781 1781 - }; 1782 1782 - }; 1783 1783 - '/api/v{api-version}/multiple-tags/b': { 1784 1784 - get: { 1785 1785 - res: { 1786 1786 - /** 1787 1787 - * Success 1788 1788 - */ 1789 1789 - '204': void; 1790 1790 - }; 1791 1791 - }; 1792 1792 - }; 1793 1793 - '/api/v{api-version}/collectionFormat': { 1794 1794 - get: { 1795 1795 - req: CollectionFormatData; 1796 1796 - }; 1797 1797 - }; 1798 1798 - '/api/v{api-version}/types': { 1799 1799 - get: { 1800 1800 - req: TypesData; 1801 1801 - res: { 1802 1802 - /** 1803 1803 - * Response is a simple number 1804 1804 - */ 1805 1805 - '200': number; 1806 1806 - /** 1807 1807 - * Response is a simple string 1808 1808 - */ 1809 1809 - '201': string; 1810 1810 - /** 1811 1811 - * Response is a simple boolean 1812 1812 - */ 1813 1813 - '202': boolean; 1814 1814 - /** 1815 1815 - * Response is a simple object 1816 1816 - */ 1817 1817 - '203': { 1818 1818 - [key: string]: unknown; 1819 1819 - }; 1820 1820 - }; 1821 1821 - }; 1822 1822 - }; 1823 1823 - '/api/v{api-version}/upload': { 1824 1824 - post: { 1825 1825 - req: UploadFileData; 1826 1826 - res: { 1827 1827 - '200': boolean; 1828 1828 - }; 1829 1829 - }; 1830 1830 - }; 1831 1831 - '/api/v{api-version}/file/{id}': { 1832 1832 - get: { 1833 1833 - req: FileResponseData; 1834 1834 - res: { 1835 1835 - /** 1836 1836 - * Success 1837 1837 - */ 1838 1838 - '200': (Blob | File); 1839 1839 - }; 1840 1840 - }; 1841 1841 - }; 1842 1842 - '/api/v{api-version}/complex': { 1843 1843 - get: { 1844 1844 - req: ComplexTypesData; 1845 1845 - res: { 1846 1846 - /** 1847 1847 - * Successful response 1848 1848 - */ 1849 1849 - '200': Array<ModelWithString>; 1850 1850 - /** 1851 1851 - * 400 `server` error 1852 1852 - */ 1853 1853 - '400': unknown; 1854 1854 - /** 1855 1855 - * 500 server error 1856 1856 - */ 1857 1857 - '500': unknown; 1858 1858 - }; 1859 1859 - }; 1860 1860 - }; 1861 1861 - '/api/v{api-version}/complex/{id}': { 1862 1862 - put: { 1863 1863 - req: ComplexParamsData; 1864 1864 - res: { 1865 1865 - /** 1866 1866 - * Success 1867 1867 - */ 1868 1868 - '200': ModelWithString; 1869 1869 - }; 1870 1870 - }; 1871 1871 - }; 1872 1872 - '/api/v{api-version}/multipart': { 1873 1873 - post: { 1874 1874 - req: MultipartRequestData; 1875 1875 - }; 1876 1876 - get: { 1877 1877 - res: { 1878 1878 - /** 1879 1879 - * OK 1880 1880 - */ 1881 1881 - '200': { 1882 1882 - file?: (Blob | File); 1883 1883 - metadata?: { 1884 1884 - foo?: string; 1885 1885 - bar?: string; 1886 1886 - }; 1887 1887 - }; 1888 1888 - }; 1889 1889 - }; 1890 1890 - }; 1891 1891 - '/api/v{api-version}/header': { 1892 1892 - post: { 1893 1893 - res: { 1894 1894 - /** 1895 1895 - * Successful response 1896 1896 - */ 1897 1897 - '200': string; 1898 1898 - /** 1899 1899 - * 400 server error 1900 1900 - */ 1901 1901 - '400': unknown; 1902 1902 - /** 1903 1903 - * 500 server error 1904 1904 - */ 1905 1905 - '500': unknown; 1906 1906 - }; 1907 1907 - }; 1908 1908 - }; 1909 1909 - '/api/v{api-version}/error': { 1910 1910 - post: { 1911 1911 - req: TestErrorCodeData; 1912 1912 - res: { 1913 1913 - /** 1914 1914 - * Custom message: Successful response 1915 1915 - */ 1916 1916 - '200': unknown; 1917 1917 - /** 1918 1918 - * Custom message: Internal Server Error 1919 1919 - */ 1920 1920 - '500': unknown; 1921 1921 - /** 1922 1922 - * Custom message: Not Implemented 1923 1923 - */ 1924 1924 - '501': unknown; 1925 1925 - /** 1926 1926 - * Custom message: Bad Gateway 1927 1927 - */ 1928 1928 - '502': unknown; 1929 1929 - /** 1930 1930 - * Custom message: Service Unavailable 1931 1931 - */ 1932 1932 - '503': unknown; 1933 1933 - }; 1934 1934 - }; 1935 1935 - }; 1936 1936 - '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串': { 1937 1937 - post: { 1938 1938 - req: NonAsciiæøåÆøÅöôêÊ字符串Data; 1939 1939 - res: { 1940 1940 - /** 1941 1941 - * Successful response 1942 1942 - */ 1943 1943 - '200': Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1944 1944 - }; 1945 1945 - }; 1946 1946 - put: { 1947 1947 - req: PutWithFormUrlEncodedData; 1948 1948 - }; 1949 1949 - }; 1950 1581 };

-69

packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-axios-class_transform/types.gen.ts.snap

··· 58 58 59 59 export type MultipleResponsesError = unknown; 60 60 61 61 - export type $OpenApiTs = { 62 62 - '/api/model-with-dates': { 63 63 - post: { 64 64 - res: { 65 65 - /** 66 66 - * Success 67 67 - */ 68 68 - '200': ParentModelWithDates; 69 69 - /** 70 70 - * Success 71 71 - */ 72 72 - '201': unknown; 73 73 - }; 74 74 - }; 75 75 - put: { 76 76 - res: { 77 77 - /** 78 78 - * Success 79 79 - */ 80 80 - '200': ModelWithDates; 81 81 - }; 82 82 - }; 83 83 - }; 84 84 - '/api/model-with-dates-array': { 85 85 - put: { 86 86 - res: { 87 87 - /** 88 88 - * Success 89 89 - */ 90 90 - '200': Array<ModelWithDates>; 91 91 - }; 92 92 - }; 93 93 - }; 94 94 - '/api/array-of-dates': { 95 95 - put: { 96 96 - res: { 97 97 - /** 98 98 - * Success 99 99 - */ 100 100 - '200': Array<(Date)>; 101 101 - }; 102 102 - }; 103 103 - }; 104 104 - '/api/date': { 105 105 - put: { 106 106 - res: { 107 107 - /** 108 108 - * Success 109 109 - */ 110 110 - '200': Date; 111 111 - }; 112 112 - }; 113 113 - }; 114 114 - '/api/multiple-responses': { 115 115 - put: { 116 116 - res: { 117 117 - /** 118 118 - * Updated 119 119 - */ 120 120 - '200': Array<ModelWithDates>; 121 121 - /** 122 122 - * Created 123 123 - */ 124 124 - '201': Array<SimpleModel>; 125 125 - }; 126 126 - }; 127 127 - }; 128 128 - }; 129 129 - 130 61 export type ParentModelWithDatesResponseTransformer = (data: any) => Promise<ParentModelWithDatesResponse>; 131 62 132 63 export type ParentModelWithDatesModelResponseTransformer = (data: any) => ParentModelWithDates;

-369

packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-axios-plugin-tanstack-react-query/types.gen.ts.snap

··· 1578 1578 1579 1579 export type PutWithFormUrlEncodedData = { 1580 1580 body: ArrayWithStrings; 1581 1581 - }; 1582 1582 - 1583 1583 - export type $OpenApiTs = { 1584 1584 - '/api/v{api-version}/no-tag': { 1585 1585 - post: { 1586 1586 - req: ImportData; 1587 1587 - res: { 1588 1588 - /** 1589 1589 - * Success 1590 1590 - */ 1591 1591 - '200': Model_From_Zendesk; 1592 1592 - /** 1593 1593 - * Default success response 1594 1594 - */ 1595 1595 - default: ModelWithReadOnlyAndWriteOnly; 1596 1596 - }; 1597 1597 - }; 1598 1598 - }; 1599 1599 - '/api/v{api-version}/simple/$count': { 1600 1600 - get: { 1601 1601 - res: { 1602 1602 - /** 1603 1603 - * Success 1604 1604 - */ 1605 1605 - '200': Model_From_Zendesk; 1606 1606 - }; 1607 1607 - }; 1608 1608 - }; 1609 1609 - '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}': { 1610 1610 - delete: { 1611 1611 - req: DeleteFooData3; 1612 1612 - }; 1613 1613 - }; 1614 1614 - '/api/v{api-version}/descriptions/': { 1615 1615 - post: { 1616 1616 - req: CallWithDescriptionsData; 1617 1617 - }; 1618 1618 - }; 1619 1619 - '/api/v{api-version}/parameters/deprecated': { 1620 1620 - post: { 1621 1621 - req: DeprecatedCallData; 1622 1622 - }; 1623 1623 - }; 1624 1624 - '/api/v{api-version}/parameters/{parameterPath}': { 1625 1625 - post: { 1626 1626 - req: CallWithParametersData; 1627 1627 - }; 1628 1628 - }; 1629 1629 - '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}': { 1630 1630 - post: { 1631 1631 - req: CallWithWeirdParameterNamesData; 1632 1632 - }; 1633 1633 - }; 1634 1634 - '/api/v{api-version}/parameters/': { 1635 1635 - get: { 1636 1636 - req: GetCallWithOptionalParamData; 1637 1637 - }; 1638 1638 - post: { 1639 1639 - req: PostCallWithOptionalParamData; 1640 1640 - res: { 1641 1641 - /** 1642 1642 - * Response is a simple number 1643 1643 - */ 1644 1644 - '200': number; 1645 1645 - /** 1646 1646 - * Success 1647 1647 - */ 1648 1648 - '204': void; 1649 1649 - }; 1650 1650 - }; 1651 1651 - }; 1652 1652 - '/api/v{api-version}/requestBody/': { 1653 1653 - post: { 1654 1654 - req: PostApiVbyApiVersionRequestBodyData; 1655 1655 - }; 1656 1656 - }; 1657 1657 - '/api/v{api-version}/formData/': { 1658 1658 - post: { 1659 1659 - req: PostApiVbyApiVersionFormDataData; 1660 1660 - }; 1661 1661 - }; 1662 1662 - '/api/v{api-version}/defaults': { 1663 1663 - get: { 1664 1664 - req: CallWithDefaultParametersData; 1665 1665 - }; 1666 1666 - post: { 1667 1667 - req: CallWithDefaultOptionalParametersData; 1668 1668 - }; 1669 1669 - put: { 1670 1670 - req: CallToTestOrderOfParamsData; 1671 1671 - }; 1672 1672 - }; 1673 1673 - '/api/v{api-version}/no-content': { 1674 1674 - get: { 1675 1675 - res: { 1676 1676 - /** 1677 1677 - * Success 1678 1678 - */ 1679 1679 - '204': void; 1680 1680 - }; 1681 1681 - }; 1682 1682 - }; 1683 1683 - '/api/v{api-version}/multiple-tags/response-and-no-content': { 1684 1684 - get: { 1685 1685 - res: { 1686 1686 - /** 1687 1687 - * Response is a simple number 1688 1688 - */ 1689 1689 - '200': number; 1690 1690 - /** 1691 1691 - * Success 1692 1692 - */ 1693 1693 - '204': void; 1694 1694 - }; 1695 1695 - }; 1696 1696 - }; 1697 1697 - '/api/v{api-version}/multiple-tags/a': { 1698 1698 - get: { 1699 1699 - res: { 1700 1700 - '200': _400; 1701 1701 - }; 1702 1702 - }; 1703 1703 - }; 1704 1704 - '/api/v{api-version}/multiple-tags/b': { 1705 1705 - get: { 1706 1706 - res: { 1707 1707 - /** 1708 1708 - * Success 1709 1709 - */ 1710 1710 - '204': void; 1711 1711 - }; 1712 1712 - }; 1713 1713 - }; 1714 1714 - '/api/v{api-version}/response': { 1715 1715 - get: { 1716 1716 - res: { 1717 1717 - default: _import; 1718 1718 - }; 1719 1719 - }; 1720 1720 - post: { 1721 1721 - res: { 1722 1722 - /** 1723 1723 - * Message for 200 response 1724 1724 - */ 1725 1725 - '200': ModelWithBoolean & ModelWithInteger; 1726 1726 - /** 1727 1727 - * Message for 201 response 1728 1728 - */ 1729 1729 - '201': ModelWithString; 1730 1730 - /** 1731 1731 - * Message for 202 response 1732 1732 - */ 1733 1733 - '202': ModelWithString; 1734 1734 - /** 1735 1735 - * Message for 500 error 1736 1736 - */ 1737 1737 - '500': ModelWithStringError; 1738 1738 - /** 1739 1739 - * Message for 501 error 1740 1740 - */ 1741 1741 - '501': ModelWithStringError; 1742 1742 - /** 1743 1743 - * Message for 502 error 1744 1744 - */ 1745 1745 - '502': ModelWithStringError; 1746 1746 - /** 1747 1747 - * Message for 4XX errors 1748 1748 - */ 1749 1749 - '4XX': DictionaryWithArray; 1750 1750 - /** 1751 1751 - * Default error response 1752 1752 - */ 1753 1753 - default: ModelWithBoolean; 1754 1754 - }; 1755 1755 - }; 1756 1756 - put: { 1757 1757 - res: { 1758 1758 - /** 1759 1759 - * Message for 200 response 1760 1760 - */ 1761 1761 - '200': { 1762 1762 - readonly '@namespace.string'?: string; 1763 1763 - readonly '@namespace.integer'?: number; 1764 1764 - readonly value?: Array<ModelWithString>; 1765 1765 - }; 1766 1766 - /** 1767 1767 - * Message for 201 response 1768 1768 - */ 1769 1769 - '201': ModelThatExtends; 1770 1770 - /** 1771 1771 - * Message for 202 response 1772 1772 - */ 1773 1773 - '202': ModelThatExtendsExtends; 1774 1774 - /** 1775 1775 - * Message for 500 error 1776 1776 - */ 1777 1777 - '500': ModelWithStringError; 1778 1778 - /** 1779 1779 - * Message for 501 error 1780 1780 - */ 1781 1781 - '501': ModelWithStringError; 1782 1782 - /** 1783 1783 - * Message for 502 error 1784 1784 - */ 1785 1785 - '502': ModelWithStringError; 1786 1786 - /** 1787 1787 - * Message for default response 1788 1788 - */ 1789 1789 - default: ModelWithStringError; 1790 1790 - }; 1791 1791 - }; 1792 1792 - }; 1793 1793 - '/api/v{api-version}/collectionFormat': { 1794 1794 - get: { 1795 1795 - req: CollectionFormatData; 1796 1796 - }; 1797 1797 - }; 1798 1798 - '/api/v{api-version}/types': { 1799 1799 - get: { 1800 1800 - req: TypesData; 1801 1801 - res: { 1802 1802 - /** 1803 1803 - * Response is a simple number 1804 1804 - */ 1805 1805 - '200': number; 1806 1806 - /** 1807 1807 - * Response is a simple string 1808 1808 - */ 1809 1809 - '201': string; 1810 1810 - /** 1811 1811 - * Response is a simple boolean 1812 1812 - */ 1813 1813 - '202': boolean; 1814 1814 - /** 1815 1815 - * Response is a simple object 1816 1816 - */ 1817 1817 - '203': { 1818 1818 - [key: string]: unknown; 1819 1819 - }; 1820 1820 - }; 1821 1821 - }; 1822 1822 - }; 1823 1823 - '/api/v{api-version}/upload': { 1824 1824 - post: { 1825 1825 - req: UploadFileData; 1826 1826 - res: { 1827 1827 - '200': boolean; 1828 1828 - }; 1829 1829 - }; 1830 1830 - }; 1831 1831 - '/api/v{api-version}/file/{id}': { 1832 1832 - get: { 1833 1833 - req: FileResponseData; 1834 1834 - res: { 1835 1835 - /** 1836 1836 - * Success 1837 1837 - */ 1838 1838 - '200': (Blob | File); 1839 1839 - }; 1840 1840 - }; 1841 1841 - }; 1842 1842 - '/api/v{api-version}/complex': { 1843 1843 - get: { 1844 1844 - req: ComplexTypesData; 1845 1845 - res: { 1846 1846 - /** 1847 1847 - * Successful response 1848 1848 - */ 1849 1849 - '200': Array<ModelWithString>; 1850 1850 - /** 1851 1851 - * 400 `server` error 1852 1852 - */ 1853 1853 - '400': unknown; 1854 1854 - /** 1855 1855 - * 500 server error 1856 1856 - */ 1857 1857 - '500': unknown; 1858 1858 - }; 1859 1859 - }; 1860 1860 - }; 1861 1861 - '/api/v{api-version}/multipart': { 1862 1862 - post: { 1863 1863 - req: MultipartRequestData; 1864 1864 - }; 1865 1865 - get: { 1866 1866 - res: { 1867 1867 - /** 1868 1868 - * OK 1869 1869 - */ 1870 1870 - '200': { 1871 1871 - file?: (Blob | File); 1872 1872 - metadata?: { 1873 1873 - foo?: string; 1874 1874 - bar?: string; 1875 1875 - }; 1876 1876 - }; 1877 1877 - }; 1878 1878 - }; 1879 1879 - }; 1880 1880 - '/api/v{api-version}/complex/{id}': { 1881 1881 - put: { 1882 1882 - req: ComplexParamsData; 1883 1883 - res: { 1884 1884 - /** 1885 1885 - * Success 1886 1886 - */ 1887 1887 - '200': ModelWithString; 1888 1888 - }; 1889 1889 - }; 1890 1890 - }; 1891 1891 - '/api/v{api-version}/header': { 1892 1892 - post: { 1893 1893 - res: { 1894 1894 - /** 1895 1895 - * Successful response 1896 1896 - */ 1897 1897 - '200': string; 1898 1898 - /** 1899 1899 - * 400 server error 1900 1900 - */ 1901 1901 - '400': unknown; 1902 1902 - /** 1903 1903 - * 500 server error 1904 1904 - */ 1905 1905 - '500': unknown; 1906 1906 - }; 1907 1907 - }; 1908 1908 - }; 1909 1909 - '/api/v{api-version}/error': { 1910 1910 - post: { 1911 1911 - req: TestErrorCodeData; 1912 1912 - res: { 1913 1913 - /** 1914 1914 - * Custom message: Successful response 1915 1915 - */ 1916 1916 - '200': unknown; 1917 1917 - /** 1918 1918 - * Custom message: Internal Server Error 1919 1919 - */ 1920 1920 - '500': unknown; 1921 1921 - /** 1922 1922 - * Custom message: Not Implemented 1923 1923 - */ 1924 1924 - '501': unknown; 1925 1925 - /** 1926 1926 - * Custom message: Bad Gateway 1927 1927 - */ 1928 1928 - '502': unknown; 1929 1929 - /** 1930 1930 - * Custom message: Service Unavailable 1931 1931 - */ 1932 1932 - '503': unknown; 1933 1933 - }; 1934 1934 - }; 1935 1935 - }; 1936 1936 - '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串': { 1937 1937 - post: { 1938 1938 - req: NonAsciiæøåÆøÅöôêÊ字符串Data; 1939 1939 - res: { 1940 1940 - /** 1941 1941 - * Successful response 1942 1942 - */ 1943 1943 - '200': Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1944 1944 - }; 1945 1945 - }; 1946 1946 - put: { 1947 1947 - req: PutWithFormUrlEncodedData; 1948 1948 - }; 1949 1949 - }; 1950 1581 };

-69

packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-axios-plugin-tanstack-react-query_transform/types.gen.ts.snap

··· 58 58 59 59 export type MultipleResponsesError = unknown; 60 60 61 61 - export type $OpenApiTs = { 62 62 - '/api/model-with-dates': { 63 63 - post: { 64 64 - res: { 65 65 - /** 66 66 - * Success 67 67 - */ 68 68 - '200': ParentModelWithDates; 69 69 - /** 70 70 - * Success 71 71 - */ 72 72 - '201': unknown; 73 73 - }; 74 74 - }; 75 75 - put: { 76 76 - res: { 77 77 - /** 78 78 - * Success 79 79 - */ 80 80 - '200': ModelWithDates; 81 81 - }; 82 82 - }; 83 83 - }; 84 84 - '/api/model-with-dates-array': { 85 85 - put: { 86 86 - res: { 87 87 - /** 88 88 - * Success 89 89 - */ 90 90 - '200': Array<ModelWithDates>; 91 91 - }; 92 92 - }; 93 93 - }; 94 94 - '/api/array-of-dates': { 95 95 - put: { 96 96 - res: { 97 97 - /** 98 98 - * Success 99 99 - */ 100 100 - '200': Array<(Date)>; 101 101 - }; 102 102 - }; 103 103 - }; 104 104 - '/api/date': { 105 105 - put: { 106 106 - res: { 107 107 - /** 108 108 - * Success 109 109 - */ 110 110 - '200': Date; 111 111 - }; 112 112 - }; 113 113 - }; 114 114 - '/api/multiple-responses': { 115 115 - put: { 116 116 - res: { 117 117 - /** 118 118 - * Updated 119 119 - */ 120 120 - '200': Array<ModelWithDates>; 121 121 - /** 122 122 - * Created 123 123 - */ 124 124 - '201': Array<SimpleModel>; 125 125 - }; 126 126 - }; 127 127 - }; 128 128 - }; 129 129 - 130 61 export type ParentModelWithDatesResponseTransformer = (data: any) => Promise<ParentModelWithDatesResponse>; 131 62 132 63 export type ParentModelWithDatesModelResponseTransformer = (data: any) => ParentModelWithDates;

-369

packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-axios/types.gen.ts.snap

··· 1578 1578 1579 1579 export type PutWithFormUrlEncodedData = { 1580 1580 body: ArrayWithStrings; 1581 1581 - }; 1582 1582 - 1583 1583 - export type $OpenApiTs = { 1584 1584 - '/api/v{api-version}/no-tag': { 1585 1585 - post: { 1586 1586 - req: ImportData; 1587 1587 - res: { 1588 1588 - /** 1589 1589 - * Success 1590 1590 - */ 1591 1591 - '200': Model_From_Zendesk; 1592 1592 - /** 1593 1593 - * Default success response 1594 1594 - */ 1595 1595 - default: ModelWithReadOnlyAndWriteOnly; 1596 1596 - }; 1597 1597 - }; 1598 1598 - }; 1599 1599 - '/api/v{api-version}/simple/$count': { 1600 1600 - get: { 1601 1601 - res: { 1602 1602 - /** 1603 1603 - * Success 1604 1604 - */ 1605 1605 - '200': Model_From_Zendesk; 1606 1606 - }; 1607 1607 - }; 1608 1608 - }; 1609 1609 - '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}': { 1610 1610 - delete: { 1611 1611 - req: DeleteFooData3; 1612 1612 - }; 1613 1613 - }; 1614 1614 - '/api/v{api-version}/descriptions/': { 1615 1615 - post: { 1616 1616 - req: CallWithDescriptionsData; 1617 1617 - }; 1618 1618 - }; 1619 1619 - '/api/v{api-version}/parameters/deprecated': { 1620 1620 - post: { 1621 1621 - req: DeprecatedCallData; 1622 1622 - }; 1623 1623 - }; 1624 1624 - '/api/v{api-version}/parameters/{parameterPath}': { 1625 1625 - post: { 1626 1626 - req: CallWithParametersData; 1627 1627 - }; 1628 1628 - }; 1629 1629 - '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}': { 1630 1630 - post: { 1631 1631 - req: CallWithWeirdParameterNamesData; 1632 1632 - }; 1633 1633 - }; 1634 1634 - '/api/v{api-version}/parameters/': { 1635 1635 - get: { 1636 1636 - req: GetCallWithOptionalParamData; 1637 1637 - }; 1638 1638 - post: { 1639 1639 - req: PostCallWithOptionalParamData; 1640 1640 - res: { 1641 1641 - /** 1642 1642 - * Response is a simple number 1643 1643 - */ 1644 1644 - '200': number; 1645 1645 - /** 1646 1646 - * Success 1647 1647 - */ 1648 1648 - '204': void; 1649 1649 - }; 1650 1650 - }; 1651 1651 - }; 1652 1652 - '/api/v{api-version}/requestBody/': { 1653 1653 - post: { 1654 1654 - req: PostApiVbyApiVersionRequestBodyData; 1655 1655 - }; 1656 1656 - }; 1657 1657 - '/api/v{api-version}/formData/': { 1658 1658 - post: { 1659 1659 - req: PostApiVbyApiVersionFormDataData; 1660 1660 - }; 1661 1661 - }; 1662 1662 - '/api/v{api-version}/defaults': { 1663 1663 - get: { 1664 1664 - req: CallWithDefaultParametersData; 1665 1665 - }; 1666 1666 - post: { 1667 1667 - req: CallWithDefaultOptionalParametersData; 1668 1668 - }; 1669 1669 - put: { 1670 1670 - req: CallToTestOrderOfParamsData; 1671 1671 - }; 1672 1672 - }; 1673 1673 - '/api/v{api-version}/no-content': { 1674 1674 - get: { 1675 1675 - res: { 1676 1676 - /** 1677 1677 - * Success 1678 1678 - */ 1679 1679 - '204': void; 1680 1680 - }; 1681 1681 - }; 1682 1682 - }; 1683 1683 - '/api/v{api-version}/multiple-tags/response-and-no-content': { 1684 1684 - get: { 1685 1685 - res: { 1686 1686 - /** 1687 1687 - * Response is a simple number 1688 1688 - */ 1689 1689 - '200': number; 1690 1690 - /** 1691 1691 - * Success 1692 1692 - */ 1693 1693 - '204': void; 1694 1694 - }; 1695 1695 - }; 1696 1696 - }; 1697 1697 - '/api/v{api-version}/multiple-tags/a': { 1698 1698 - get: { 1699 1699 - res: { 1700 1700 - '200': _400; 1701 1701 - }; 1702 1702 - }; 1703 1703 - }; 1704 1704 - '/api/v{api-version}/multiple-tags/b': { 1705 1705 - get: { 1706 1706 - res: { 1707 1707 - /** 1708 1708 - * Success 1709 1709 - */ 1710 1710 - '204': void; 1711 1711 - }; 1712 1712 - }; 1713 1713 - }; 1714 1714 - '/api/v{api-version}/response': { 1715 1715 - get: { 1716 1716 - res: { 1717 1717 - default: _import; 1718 1718 - }; 1719 1719 - }; 1720 1720 - post: { 1721 1721 - res: { 1722 1722 - /** 1723 1723 - * Message for 200 response 1724 1724 - */ 1725 1725 - '200': ModelWithBoolean & ModelWithInteger; 1726 1726 - /** 1727 1727 - * Message for 201 response 1728 1728 - */ 1729 1729 - '201': ModelWithString; 1730 1730 - /** 1731 1731 - * Message for 202 response 1732 1732 - */ 1733 1733 - '202': ModelWithString; 1734 1734 - /** 1735 1735 - * Message for 500 error 1736 1736 - */ 1737 1737 - '500': ModelWithStringError; 1738 1738 - /** 1739 1739 - * Message for 501 error 1740 1740 - */ 1741 1741 - '501': ModelWithStringError; 1742 1742 - /** 1743 1743 - * Message for 502 error 1744 1744 - */ 1745 1745 - '502': ModelWithStringError; 1746 1746 - /** 1747 1747 - * Message for 4XX errors 1748 1748 - */ 1749 1749 - '4XX': DictionaryWithArray; 1750 1750 - /** 1751 1751 - * Default error response 1752 1752 - */ 1753 1753 - default: ModelWithBoolean; 1754 1754 - }; 1755 1755 - }; 1756 1756 - put: { 1757 1757 - res: { 1758 1758 - /** 1759 1759 - * Message for 200 response 1760 1760 - */ 1761 1761 - '200': { 1762 1762 - readonly '@namespace.string'?: string; 1763 1763 - readonly '@namespace.integer'?: number; 1764 1764 - readonly value?: Array<ModelWithString>; 1765 1765 - }; 1766 1766 - /** 1767 1767 - * Message for 201 response 1768 1768 - */ 1769 1769 - '201': ModelThatExtends; 1770 1770 - /** 1771 1771 - * Message for 202 response 1772 1772 - */ 1773 1773 - '202': ModelThatExtendsExtends; 1774 1774 - /** 1775 1775 - * Message for 500 error 1776 1776 - */ 1777 1777 - '500': ModelWithStringError; 1778 1778 - /** 1779 1779 - * Message for 501 error 1780 1780 - */ 1781 1781 - '501': ModelWithStringError; 1782 1782 - /** 1783 1783 - * Message for 502 error 1784 1784 - */ 1785 1785 - '502': ModelWithStringError; 1786 1786 - /** 1787 1787 - * Message for default response 1788 1788 - */ 1789 1789 - default: ModelWithStringError; 1790 1790 - }; 1791 1791 - }; 1792 1792 - }; 1793 1793 - '/api/v{api-version}/collectionFormat': { 1794 1794 - get: { 1795 1795 - req: CollectionFormatData; 1796 1796 - }; 1797 1797 - }; 1798 1798 - '/api/v{api-version}/types': { 1799 1799 - get: { 1800 1800 - req: TypesData; 1801 1801 - res: { 1802 1802 - /** 1803 1803 - * Response is a simple number 1804 1804 - */ 1805 1805 - '200': number; 1806 1806 - /** 1807 1807 - * Response is a simple string 1808 1808 - */ 1809 1809 - '201': string; 1810 1810 - /** 1811 1811 - * Response is a simple boolean 1812 1812 - */ 1813 1813 - '202': boolean; 1814 1814 - /** 1815 1815 - * Response is a simple object 1816 1816 - */ 1817 1817 - '203': { 1818 1818 - [key: string]: unknown; 1819 1819 - }; 1820 1820 - }; 1821 1821 - }; 1822 1822 - }; 1823 1823 - '/api/v{api-version}/upload': { 1824 1824 - post: { 1825 1825 - req: UploadFileData; 1826 1826 - res: { 1827 1827 - '200': boolean; 1828 1828 - }; 1829 1829 - }; 1830 1830 - }; 1831 1831 - '/api/v{api-version}/file/{id}': { 1832 1832 - get: { 1833 1833 - req: FileResponseData; 1834 1834 - res: { 1835 1835 - /** 1836 1836 - * Success 1837 1837 - */ 1838 1838 - '200': (Blob | File); 1839 1839 - }; 1840 1840 - }; 1841 1841 - }; 1842 1842 - '/api/v{api-version}/complex': { 1843 1843 - get: { 1844 1844 - req: ComplexTypesData; 1845 1845 - res: { 1846 1846 - /** 1847 1847 - * Successful response 1848 1848 - */ 1849 1849 - '200': Array<ModelWithString>; 1850 1850 - /** 1851 1851 - * 400 `server` error 1852 1852 - */ 1853 1853 - '400': unknown; 1854 1854 - /** 1855 1855 - * 500 server error 1856 1856 - */ 1857 1857 - '500': unknown; 1858 1858 - }; 1859 1859 - }; 1860 1860 - }; 1861 1861 - '/api/v{api-version}/multipart': { 1862 1862 - post: { 1863 1863 - req: MultipartRequestData; 1864 1864 - }; 1865 1865 - get: { 1866 1866 - res: { 1867 1867 - /** 1868 1868 - * OK 1869 1869 - */ 1870 1870 - '200': { 1871 1871 - file?: (Blob | File); 1872 1872 - metadata?: { 1873 1873 - foo?: string; 1874 1874 - bar?: string; 1875 1875 - }; 1876 1876 - }; 1877 1877 - }; 1878 1878 - }; 1879 1879 - }; 1880 1880 - '/api/v{api-version}/complex/{id}': { 1881 1881 - put: { 1882 1882 - req: ComplexParamsData; 1883 1883 - res: { 1884 1884 - /** 1885 1885 - * Success 1886 1886 - */ 1887 1887 - '200': ModelWithString; 1888 1888 - }; 1889 1889 - }; 1890 1890 - }; 1891 1891 - '/api/v{api-version}/header': { 1892 1892 - post: { 1893 1893 - res: { 1894 1894 - /** 1895 1895 - * Successful response 1896 1896 - */ 1897 1897 - '200': string; 1898 1898 - /** 1899 1899 - * 400 server error 1900 1900 - */ 1901 1901 - '400': unknown; 1902 1902 - /** 1903 1903 - * 500 server error 1904 1904 - */ 1905 1905 - '500': unknown; 1906 1906 - }; 1907 1907 - }; 1908 1908 - }; 1909 1909 - '/api/v{api-version}/error': { 1910 1910 - post: { 1911 1911 - req: TestErrorCodeData; 1912 1912 - res: { 1913 1913 - /** 1914 1914 - * Custom message: Successful response 1915 1915 - */ 1916 1916 - '200': unknown; 1917 1917 - /** 1918 1918 - * Custom message: Internal Server Error 1919 1919 - */ 1920 1920 - '500': unknown; 1921 1921 - /** 1922 1922 - * Custom message: Not Implemented 1923 1923 - */ 1924 1924 - '501': unknown; 1925 1925 - /** 1926 1926 - * Custom message: Bad Gateway 1927 1927 - */ 1928 1928 - '502': unknown; 1929 1929 - /** 1930 1930 - * Custom message: Service Unavailable 1931 1931 - */ 1932 1932 - '503': unknown; 1933 1933 - }; 1934 1934 - }; 1935 1935 - }; 1936 1936 - '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串': { 1937 1937 - post: { 1938 1938 - req: NonAsciiæøåÆøÅöôêÊ字符串Data; 1939 1939 - res: { 1940 1940 - /** 1941 1941 - * Successful response 1942 1942 - */ 1943 1943 - '200': Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1944 1944 - }; 1945 1945 - }; 1946 1946 - put: { 1947 1947 - req: PutWithFormUrlEncodedData; 1948 1948 - }; 1949 1949 - }; 1950 1581 };

-69

packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-axios_transform/types.gen.ts.snap

··· 58 58 59 59 export type MultipleResponsesError = unknown; 60 60 61 61 - export type $OpenApiTs = { 62 62 - '/api/model-with-dates': { 63 63 - post: { 64 64 - res: { 65 65 - /** 66 66 - * Success 67 67 - */ 68 68 - '200': ParentModelWithDates; 69 69 - /** 70 70 - * Success 71 71 - */ 72 72 - '201': unknown; 73 73 - }; 74 74 - }; 75 75 - put: { 76 76 - res: { 77 77 - /** 78 78 - * Success 79 79 - */ 80 80 - '200': ModelWithDates; 81 81 - }; 82 82 - }; 83 83 - }; 84 84 - '/api/model-with-dates-array': { 85 85 - put: { 86 86 - res: { 87 87 - /** 88 88 - * Success 89 89 - */ 90 90 - '200': Array<ModelWithDates>; 91 91 - }; 92 92 - }; 93 93 - }; 94 94 - '/api/array-of-dates': { 95 95 - put: { 96 96 - res: { 97 97 - /** 98 98 - * Success 99 99 - */ 100 100 - '200': Array<(Date)>; 101 101 - }; 102 102 - }; 103 103 - }; 104 104 - '/api/date': { 105 105 - put: { 106 106 - res: { 107 107 - /** 108 108 - * Success 109 109 - */ 110 110 - '200': Date; 111 111 - }; 112 112 - }; 113 113 - }; 114 114 - '/api/multiple-responses': { 115 115 - put: { 116 116 - res: { 117 117 - /** 118 118 - * Updated 119 119 - */ 120 120 - '200': Array<ModelWithDates>; 121 121 - /** 122 122 - * Created 123 123 - */ 124 124 - '201': Array<SimpleModel>; 125 125 - }; 126 126 - }; 127 127 - }; 128 128 - }; 129 129 - 130 61 export type ParentModelWithDatesResponseTransformer = (data: any) => Promise<ParentModelWithDatesResponse>; 131 62 132 63 export type ParentModelWithDatesModelResponseTransformer = (data: any) => ParentModelWithDates;

-369

packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-fetch-bundle/types.gen.ts.snap

··· 1578 1578 1579 1579 export type PutWithFormUrlEncodedData = { 1580 1580 body: ArrayWithStrings; 1581 1581 - }; 1582 1582 - 1583 1583 - export type $OpenApiTs = { 1584 1584 - '/api/v{api-version}/no-tag': { 1585 1585 - post: { 1586 1586 - req: ImportData; 1587 1587 - res: { 1588 1588 - /** 1589 1589 - * Success 1590 1590 - */ 1591 1591 - '200': Model_From_Zendesk; 1592 1592 - /** 1593 1593 - * Default success response 1594 1594 - */ 1595 1595 - default: ModelWithReadOnlyAndWriteOnly; 1596 1596 - }; 1597 1597 - }; 1598 1598 - }; 1599 1599 - '/api/v{api-version}/simple/$count': { 1600 1600 - get: { 1601 1601 - res: { 1602 1602 - /** 1603 1603 - * Success 1604 1604 - */ 1605 1605 - '200': Model_From_Zendesk; 1606 1606 - }; 1607 1607 - }; 1608 1608 - }; 1609 1609 - '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}': { 1610 1610 - delete: { 1611 1611 - req: DeleteFooData3; 1612 1612 - }; 1613 1613 - }; 1614 1614 - '/api/v{api-version}/descriptions/': { 1615 1615 - post: { 1616 1616 - req: CallWithDescriptionsData; 1617 1617 - }; 1618 1618 - }; 1619 1619 - '/api/v{api-version}/parameters/deprecated': { 1620 1620 - post: { 1621 1621 - req: DeprecatedCallData; 1622 1622 - }; 1623 1623 - }; 1624 1624 - '/api/v{api-version}/parameters/{parameterPath}': { 1625 1625 - post: { 1626 1626 - req: CallWithParametersData; 1627 1627 - }; 1628 1628 - }; 1629 1629 - '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}': { 1630 1630 - post: { 1631 1631 - req: CallWithWeirdParameterNamesData; 1632 1632 - }; 1633 1633 - }; 1634 1634 - '/api/v{api-version}/parameters/': { 1635 1635 - get: { 1636 1636 - req: GetCallWithOptionalParamData; 1637 1637 - }; 1638 1638 - post: { 1639 1639 - req: PostCallWithOptionalParamData; 1640 1640 - res: { 1641 1641 - /** 1642 1642 - * Response is a simple number 1643 1643 - */ 1644 1644 - '200': number; 1645 1645 - /** 1646 1646 - * Success 1647 1647 - */ 1648 1648 - '204': void; 1649 1649 - }; 1650 1650 - }; 1651 1651 - }; 1652 1652 - '/api/v{api-version}/requestBody/': { 1653 1653 - post: { 1654 1654 - req: PostApiVbyApiVersionRequestBodyData; 1655 1655 - }; 1656 1656 - }; 1657 1657 - '/api/v{api-version}/formData/': { 1658 1658 - post: { 1659 1659 - req: PostApiVbyApiVersionFormDataData; 1660 1660 - }; 1661 1661 - }; 1662 1662 - '/api/v{api-version}/defaults': { 1663 1663 - get: { 1664 1664 - req: CallWithDefaultParametersData; 1665 1665 - }; 1666 1666 - post: { 1667 1667 - req: CallWithDefaultOptionalParametersData; 1668 1668 - }; 1669 1669 - put: { 1670 1670 - req: CallToTestOrderOfParamsData; 1671 1671 - }; 1672 1672 - }; 1673 1673 - '/api/v{api-version}/no-content': { 1674 1674 - get: { 1675 1675 - res: { 1676 1676 - /** 1677 1677 - * Success 1678 1678 - */ 1679 1679 - '204': void; 1680 1680 - }; 1681 1681 - }; 1682 1682 - }; 1683 1683 - '/api/v{api-version}/multiple-tags/response-and-no-content': { 1684 1684 - get: { 1685 1685 - res: { 1686 1686 - /** 1687 1687 - * Response is a simple number 1688 1688 - */ 1689 1689 - '200': number; 1690 1690 - /** 1691 1691 - * Success 1692 1692 - */ 1693 1693 - '204': void; 1694 1694 - }; 1695 1695 - }; 1696 1696 - }; 1697 1697 - '/api/v{api-version}/multiple-tags/a': { 1698 1698 - get: { 1699 1699 - res: { 1700 1700 - '200': _400; 1701 1701 - }; 1702 1702 - }; 1703 1703 - }; 1704 1704 - '/api/v{api-version}/multiple-tags/b': { 1705 1705 - get: { 1706 1706 - res: { 1707 1707 - /** 1708 1708 - * Success 1709 1709 - */ 1710 1710 - '204': void; 1711 1711 - }; 1712 1712 - }; 1713 1713 - }; 1714 1714 - '/api/v{api-version}/response': { 1715 1715 - get: { 1716 1716 - res: { 1717 1717 - default: _import; 1718 1718 - }; 1719 1719 - }; 1720 1720 - post: { 1721 1721 - res: { 1722 1722 - /** 1723 1723 - * Message for 200 response 1724 1724 - */ 1725 1725 - '200': ModelWithBoolean & ModelWithInteger; 1726 1726 - /** 1727 1727 - * Message for 201 response 1728 1728 - */ 1729 1729 - '201': ModelWithString; 1730 1730 - /** 1731 1731 - * Message for 202 response 1732 1732 - */ 1733 1733 - '202': ModelWithString; 1734 1734 - /** 1735 1735 - * Message for 500 error 1736 1736 - */ 1737 1737 - '500': ModelWithStringError; 1738 1738 - /** 1739 1739 - * Message for 501 error 1740 1740 - */ 1741 1741 - '501': ModelWithStringError; 1742 1742 - /** 1743 1743 - * Message for 502 error 1744 1744 - */ 1745 1745 - '502': ModelWithStringError; 1746 1746 - /** 1747 1747 - * Message for 4XX errors 1748 1748 - */ 1749 1749 - '4XX': DictionaryWithArray; 1750 1750 - /** 1751 1751 - * Default error response 1752 1752 - */ 1753 1753 - default: ModelWithBoolean; 1754 1754 - }; 1755 1755 - }; 1756 1756 - put: { 1757 1757 - res: { 1758 1758 - /** 1759 1759 - * Message for 200 response 1760 1760 - */ 1761 1761 - '200': { 1762 1762 - readonly '@namespace.string'?: string; 1763 1763 - readonly '@namespace.integer'?: number; 1764 1764 - readonly value?: Array<ModelWithString>; 1765 1765 - }; 1766 1766 - /** 1767 1767 - * Message for 201 response 1768 1768 - */ 1769 1769 - '201': ModelThatExtends; 1770 1770 - /** 1771 1771 - * Message for 202 response 1772 1772 - */ 1773 1773 - '202': ModelThatExtendsExtends; 1774 1774 - /** 1775 1775 - * Message for 500 error 1776 1776 - */ 1777 1777 - '500': ModelWithStringError; 1778 1778 - /** 1779 1779 - * Message for 501 error 1780 1780 - */ 1781 1781 - '501': ModelWithStringError; 1782 1782 - /** 1783 1783 - * Message for 502 error 1784 1784 - */ 1785 1785 - '502': ModelWithStringError; 1786 1786 - /** 1787 1787 - * Message for default response 1788 1788 - */ 1789 1789 - default: ModelWithStringError; 1790 1790 - }; 1791 1791 - }; 1792 1792 - }; 1793 1793 - '/api/v{api-version}/collectionFormat': { 1794 1794 - get: { 1795 1795 - req: CollectionFormatData; 1796 1796 - }; 1797 1797 - }; 1798 1798 - '/api/v{api-version}/types': { 1799 1799 - get: { 1800 1800 - req: TypesData; 1801 1801 - res: { 1802 1802 - /** 1803 1803 - * Response is a simple number 1804 1804 - */ 1805 1805 - '200': number; 1806 1806 - /** 1807 1807 - * Response is a simple string 1808 1808 - */ 1809 1809 - '201': string; 1810 1810 - /** 1811 1811 - * Response is a simple boolean 1812 1812 - */ 1813 1813 - '202': boolean; 1814 1814 - /** 1815 1815 - * Response is a simple object 1816 1816 - */ 1817 1817 - '203': { 1818 1818 - [key: string]: unknown; 1819 1819 - }; 1820 1820 - }; 1821 1821 - }; 1822 1822 - }; 1823 1823 - '/api/v{api-version}/upload': { 1824 1824 - post: { 1825 1825 - req: UploadFileData; 1826 1826 - res: { 1827 1827 - '200': boolean; 1828 1828 - }; 1829 1829 - }; 1830 1830 - }; 1831 1831 - '/api/v{api-version}/file/{id}': { 1832 1832 - get: { 1833 1833 - req: FileResponseData; 1834 1834 - res: { 1835 1835 - /** 1836 1836 - * Success 1837 1837 - */ 1838 1838 - '200': (Blob | File); 1839 1839 - }; 1840 1840 - }; 1841 1841 - }; 1842 1842 - '/api/v{api-version}/complex': { 1843 1843 - get: { 1844 1844 - req: ComplexTypesData; 1845 1845 - res: { 1846 1846 - /** 1847 1847 - * Successful response 1848 1848 - */ 1849 1849 - '200': Array<ModelWithString>; 1850 1850 - /** 1851 1851 - * 400 `server` error 1852 1852 - */ 1853 1853 - '400': unknown; 1854 1854 - /** 1855 1855 - * 500 server error 1856 1856 - */ 1857 1857 - '500': unknown; 1858 1858 - }; 1859 1859 - }; 1860 1860 - }; 1861 1861 - '/api/v{api-version}/multipart': { 1862 1862 - post: { 1863 1863 - req: MultipartRequestData; 1864 1864 - }; 1865 1865 - get: { 1866 1866 - res: { 1867 1867 - /** 1868 1868 - * OK 1869 1869 - */ 1870 1870 - '200': { 1871 1871 - file?: (Blob | File); 1872 1872 - metadata?: { 1873 1873 - foo?: string; 1874 1874 - bar?: string; 1875 1875 - }; 1876 1876 - }; 1877 1877 - }; 1878 1878 - }; 1879 1879 - }; 1880 1880 - '/api/v{api-version}/complex/{id}': { 1881 1881 - put: { 1882 1882 - req: ComplexParamsData; 1883 1883 - res: { 1884 1884 - /** 1885 1885 - * Success 1886 1886 - */ 1887 1887 - '200': ModelWithString; 1888 1888 - }; 1889 1889 - }; 1890 1890 - }; 1891 1891 - '/api/v{api-version}/header': { 1892 1892 - post: { 1893 1893 - res: { 1894 1894 - /** 1895 1895 - * Successful response 1896 1896 - */ 1897 1897 - '200': string; 1898 1898 - /** 1899 1899 - * 400 server error 1900 1900 - */ 1901 1901 - '400': unknown; 1902 1902 - /** 1903 1903 - * 500 server error 1904 1904 - */ 1905 1905 - '500': unknown; 1906 1906 - }; 1907 1907 - }; 1908 1908 - }; 1909 1909 - '/api/v{api-version}/error': { 1910 1910 - post: { 1911 1911 - req: TestErrorCodeData; 1912 1912 - res: { 1913 1913 - /** 1914 1914 - * Custom message: Successful response 1915 1915 - */ 1916 1916 - '200': unknown; 1917 1917 - /** 1918 1918 - * Custom message: Internal Server Error 1919 1919 - */ 1920 1920 - '500': unknown; 1921 1921 - /** 1922 1922 - * Custom message: Not Implemented 1923 1923 - */ 1924 1924 - '501': unknown; 1925 1925 - /** 1926 1926 - * Custom message: Bad Gateway 1927 1927 - */ 1928 1928 - '502': unknown; 1929 1929 - /** 1930 1930 - * Custom message: Service Unavailable 1931 1931 - */ 1932 1932 - '503': unknown; 1933 1933 - }; 1934 1934 - }; 1935 1935 - }; 1936 1936 - '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串': { 1937 1937 - post: { 1938 1938 - req: NonAsciiæøåÆøÅöôêÊ字符串Data; 1939 1939 - res: { 1940 1940 - /** 1941 1941 - * Successful response 1942 1942 - */ 1943 1943 - '200': Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1944 1944 - }; 1945 1945 - }; 1946 1946 - put: { 1947 1947 - req: PutWithFormUrlEncodedData; 1948 1948 - }; 1949 1949 - }; 1950 1581 };

-69

packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-fetch-bundle_transform/types.gen.ts.snap

··· 58 58 59 59 export type MultipleResponsesError = unknown; 60 60 61 61 - export type $OpenApiTs = { 62 62 - '/api/model-with-dates': { 63 63 - post: { 64 64 - res: { 65 65 - /** 66 66 - * Success 67 67 - */ 68 68 - '200': ParentModelWithDates; 69 69 - /** 70 70 - * Success 71 71 - */ 72 72 - '201': unknown; 73 73 - }; 74 74 - }; 75 75 - put: { 76 76 - res: { 77 77 - /** 78 78 - * Success 79 79 - */ 80 80 - '200': ModelWithDates; 81 81 - }; 82 82 - }; 83 83 - }; 84 84 - '/api/model-with-dates-array': { 85 85 - put: { 86 86 - res: { 87 87 - /** 88 88 - * Success 89 89 - */ 90 90 - '200': Array<ModelWithDates>; 91 91 - }; 92 92 - }; 93 93 - }; 94 94 - '/api/array-of-dates': { 95 95 - put: { 96 96 - res: { 97 97 - /** 98 98 - * Success 99 99 - */ 100 100 - '200': Array<(Date)>; 101 101 - }; 102 102 - }; 103 103 - }; 104 104 - '/api/date': { 105 105 - put: { 106 106 - res: { 107 107 - /** 108 108 - * Success 109 109 - */ 110 110 - '200': Date; 111 111 - }; 112 112 - }; 113 113 - }; 114 114 - '/api/multiple-responses': { 115 115 - put: { 116 116 - res: { 117 117 - /** 118 118 - * Updated 119 119 - */ 120 120 - '200': Array<ModelWithDates>; 121 121 - /** 122 122 - * Created 123 123 - */ 124 124 - '201': Array<SimpleModel>; 125 125 - }; 126 126 - }; 127 127 - }; 128 128 - }; 129 129 - 130 61 export type ParentModelWithDatesResponseTransformer = (data: any) => Promise<ParentModelWithDatesResponse>; 131 62 132 63 export type ParentModelWithDatesModelResponseTransformer = (data: any) => ParentModelWithDates;

-369

packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-fetch-class/types.gen.ts.snap

··· 1578 1578 1579 1579 export type PutWithFormUrlEncodedData = { 1580 1580 body: ArrayWithStrings; 1581 1581 - }; 1582 1582 - 1583 1583 - export type $OpenApiTs = { 1584 1584 - '/api/v{api-version}/no-tag': { 1585 1585 - post: { 1586 1586 - req: ImportData; 1587 1587 - res: { 1588 1588 - /** 1589 1589 - * Success 1590 1590 - */ 1591 1591 - '200': Model_From_Zendesk; 1592 1592 - /** 1593 1593 - * Default success response 1594 1594 - */ 1595 1595 - default: ModelWithReadOnlyAndWriteOnly; 1596 1596 - }; 1597 1597 - }; 1598 1598 - }; 1599 1599 - '/api/v{api-version}/simple/$count': { 1600 1600 - get: { 1601 1601 - res: { 1602 1602 - /** 1603 1603 - * Success 1604 1604 - */ 1605 1605 - '200': Model_From_Zendesk; 1606 1606 - }; 1607 1607 - }; 1608 1608 - }; 1609 1609 - '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}': { 1610 1610 - delete: { 1611 1611 - req: DeleteFooData3; 1612 1612 - }; 1613 1613 - }; 1614 1614 - '/api/v{api-version}/parameters/{parameterPath}': { 1615 1615 - post: { 1616 1616 - req: CallWithParametersData; 1617 1617 - }; 1618 1618 - }; 1619 1619 - '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}': { 1620 1620 - post: { 1621 1621 - req: CallWithWeirdParameterNamesData; 1622 1622 - }; 1623 1623 - }; 1624 1624 - '/api/v{api-version}/parameters/': { 1625 1625 - get: { 1626 1626 - req: GetCallWithOptionalParamData; 1627 1627 - }; 1628 1628 - post: { 1629 1629 - req: PostCallWithOptionalParamData; 1630 1630 - res: { 1631 1631 - /** 1632 1632 - * Response is a simple number 1633 1633 - */ 1634 1634 - '200': number; 1635 1635 - /** 1636 1636 - * Success 1637 1637 - */ 1638 1638 - '204': void; 1639 1639 - }; 1640 1640 - }; 1641 1641 - }; 1642 1642 - '/api/v{api-version}/descriptions/': { 1643 1643 - post: { 1644 1644 - req: CallWithDescriptionsData; 1645 1645 - }; 1646 1646 - }; 1647 1647 - '/api/v{api-version}/parameters/deprecated': { 1648 1648 - post: { 1649 1649 - req: DeprecatedCallData; 1650 1650 - }; 1651 1651 - }; 1652 1652 - '/api/v{api-version}/requestBody/': { 1653 1653 - post: { 1654 1654 - req: PostApiVbyApiVersionRequestBodyData; 1655 1655 - }; 1656 1656 - }; 1657 1657 - '/api/v{api-version}/formData/': { 1658 1658 - post: { 1659 1659 - req: PostApiVbyApiVersionFormDataData; 1660 1660 - }; 1661 1661 - }; 1662 1662 - '/api/v{api-version}/defaults': { 1663 1663 - get: { 1664 1664 - req: CallWithDefaultParametersData; 1665 1665 - }; 1666 1666 - post: { 1667 1667 - req: CallWithDefaultOptionalParametersData; 1668 1668 - }; 1669 1669 - put: { 1670 1670 - req: CallToTestOrderOfParamsData; 1671 1671 - }; 1672 1672 - }; 1673 1673 - '/api/v{api-version}/no-content': { 1674 1674 - get: { 1675 1675 - res: { 1676 1676 - /** 1677 1677 - * Success 1678 1678 - */ 1679 1679 - '204': void; 1680 1680 - }; 1681 1681 - }; 1682 1682 - }; 1683 1683 - '/api/v{api-version}/multiple-tags/response-and-no-content': { 1684 1684 - get: { 1685 1685 - res: { 1686 1686 - /** 1687 1687 - * Response is a simple number 1688 1688 - */ 1689 1689 - '200': number; 1690 1690 - /** 1691 1691 - * Success 1692 1692 - */ 1693 1693 - '204': void; 1694 1694 - }; 1695 1695 - }; 1696 1696 - }; 1697 1697 - '/api/v{api-version}/response': { 1698 1698 - get: { 1699 1699 - res: { 1700 1700 - default: _import; 1701 1701 - }; 1702 1702 - }; 1703 1703 - post: { 1704 1704 - res: { 1705 1705 - /** 1706 1706 - * Message for 200 response 1707 1707 - */ 1708 1708 - '200': ModelWithBoolean & ModelWithInteger; 1709 1709 - /** 1710 1710 - * Message for 201 response 1711 1711 - */ 1712 1712 - '201': ModelWithString; 1713 1713 - /** 1714 1714 - * Message for 202 response 1715 1715 - */ 1716 1716 - '202': ModelWithString; 1717 1717 - /** 1718 1718 - * Message for 500 error 1719 1719 - */ 1720 1720 - '500': ModelWithStringError; 1721 1721 - /** 1722 1722 - * Message for 501 error 1723 1723 - */ 1724 1724 - '501': ModelWithStringError; 1725 1725 - /** 1726 1726 - * Message for 502 error 1727 1727 - */ 1728 1728 - '502': ModelWithStringError; 1729 1729 - /** 1730 1730 - * Message for 4XX errors 1731 1731 - */ 1732 1732 - '4XX': DictionaryWithArray; 1733 1733 - /** 1734 1734 - * Default error response 1735 1735 - */ 1736 1736 - default: ModelWithBoolean; 1737 1737 - }; 1738 1738 - }; 1739 1739 - put: { 1740 1740 - res: { 1741 1741 - /** 1742 1742 - * Message for 200 response 1743 1743 - */ 1744 1744 - '200': { 1745 1745 - readonly '@namespace.string'?: string; 1746 1746 - readonly '@namespace.integer'?: number; 1747 1747 - readonly value?: Array<ModelWithString>; 1748 1748 - }; 1749 1749 - /** 1750 1750 - * Message for 201 response 1751 1751 - */ 1752 1752 - '201': ModelThatExtends; 1753 1753 - /** 1754 1754 - * Message for 202 response 1755 1755 - */ 1756 1756 - '202': ModelThatExtendsExtends; 1757 1757 - /** 1758 1758 - * Message for 500 error 1759 1759 - */ 1760 1760 - '500': ModelWithStringError; 1761 1761 - /** 1762 1762 - * Message for 501 error 1763 1763 - */ 1764 1764 - '501': ModelWithStringError; 1765 1765 - /** 1766 1766 - * Message for 502 error 1767 1767 - */ 1768 1768 - '502': ModelWithStringError; 1769 1769 - /** 1770 1770 - * Message for default response 1771 1771 - */ 1772 1772 - default: ModelWithStringError; 1773 1773 - }; 1774 1774 - }; 1775 1775 - }; 1776 1776 - '/api/v{api-version}/multiple-tags/a': { 1777 1777 - get: { 1778 1778 - res: { 1779 1779 - '200': _400; 1780 1780 - }; 1781 1781 - }; 1782 1782 - }; 1783 1783 - '/api/v{api-version}/multiple-tags/b': { 1784 1784 - get: { 1785 1785 - res: { 1786 1786 - /** 1787 1787 - * Success 1788 1788 - */ 1789 1789 - '204': void; 1790 1790 - }; 1791 1791 - }; 1792 1792 - }; 1793 1793 - '/api/v{api-version}/collectionFormat': { 1794 1794 - get: { 1795 1795 - req: CollectionFormatData; 1796 1796 - }; 1797 1797 - }; 1798 1798 - '/api/v{api-version}/types': { 1799 1799 - get: { 1800 1800 - req: TypesData; 1801 1801 - res: { 1802 1802 - /** 1803 1803 - * Response is a simple number 1804 1804 - */ 1805 1805 - '200': number; 1806 1806 - /** 1807 1807 - * Response is a simple string 1808 1808 - */ 1809 1809 - '201': string; 1810 1810 - /** 1811 1811 - * Response is a simple boolean 1812 1812 - */ 1813 1813 - '202': boolean; 1814 1814 - /** 1815 1815 - * Response is a simple object 1816 1816 - */ 1817 1817 - '203': { 1818 1818 - [key: string]: unknown; 1819 1819 - }; 1820 1820 - }; 1821 1821 - }; 1822 1822 - }; 1823 1823 - '/api/v{api-version}/upload': { 1824 1824 - post: { 1825 1825 - req: UploadFileData; 1826 1826 - res: { 1827 1827 - '200': boolean; 1828 1828 - }; 1829 1829 - }; 1830 1830 - }; 1831 1831 - '/api/v{api-version}/file/{id}': { 1832 1832 - get: { 1833 1833 - req: FileResponseData; 1834 1834 - res: { 1835 1835 - /** 1836 1836 - * Success 1837 1837 - */ 1838 1838 - '200': (Blob | File); 1839 1839 - }; 1840 1840 - }; 1841 1841 - }; 1842 1842 - '/api/v{api-version}/complex': { 1843 1843 - get: { 1844 1844 - req: ComplexTypesData; 1845 1845 - res: { 1846 1846 - /** 1847 1847 - * Successful response 1848 1848 - */ 1849 1849 - '200': Array<ModelWithString>; 1850 1850 - /** 1851 1851 - * 400 `server` error 1852 1852 - */ 1853 1853 - '400': unknown; 1854 1854 - /** 1855 1855 - * 500 server error 1856 1856 - */ 1857 1857 - '500': unknown; 1858 1858 - }; 1859 1859 - }; 1860 1860 - }; 1861 1861 - '/api/v{api-version}/complex/{id}': { 1862 1862 - put: { 1863 1863 - req: ComplexParamsData; 1864 1864 - res: { 1865 1865 - /** 1866 1866 - * Success 1867 1867 - */ 1868 1868 - '200': ModelWithString; 1869 1869 - }; 1870 1870 - }; 1871 1871 - }; 1872 1872 - '/api/v{api-version}/multipart': { 1873 1873 - post: { 1874 1874 - req: MultipartRequestData; 1875 1875 - }; 1876 1876 - get: { 1877 1877 - res: { 1878 1878 - /** 1879 1879 - * OK 1880 1880 - */ 1881 1881 - '200': { 1882 1882 - file?: (Blob | File); 1883 1883 - metadata?: { 1884 1884 - foo?: string; 1885 1885 - bar?: string; 1886 1886 - }; 1887 1887 - }; 1888 1888 - }; 1889 1889 - }; 1890 1890 - }; 1891 1891 - '/api/v{api-version}/header': { 1892 1892 - post: { 1893 1893 - res: { 1894 1894 - /** 1895 1895 - * Successful response 1896 1896 - */ 1897 1897 - '200': string; 1898 1898 - /** 1899 1899 - * 400 server error 1900 1900 - */ 1901 1901 - '400': unknown; 1902 1902 - /** 1903 1903 - * 500 server error 1904 1904 - */ 1905 1905 - '500': unknown; 1906 1906 - }; 1907 1907 - }; 1908 1908 - }; 1909 1909 - '/api/v{api-version}/error': { 1910 1910 - post: { 1911 1911 - req: TestErrorCodeData; 1912 1912 - res: { 1913 1913 - /** 1914 1914 - * Custom message: Successful response 1915 1915 - */ 1916 1916 - '200': unknown; 1917 1917 - /** 1918 1918 - * Custom message: Internal Server Error 1919 1919 - */ 1920 1920 - '500': unknown; 1921 1921 - /** 1922 1922 - * Custom message: Not Implemented 1923 1923 - */ 1924 1924 - '501': unknown; 1925 1925 - /** 1926 1926 - * Custom message: Bad Gateway 1927 1927 - */ 1928 1928 - '502': unknown; 1929 1929 - /** 1930 1930 - * Custom message: Service Unavailable 1931 1931 - */ 1932 1932 - '503': unknown; 1933 1933 - }; 1934 1934 - }; 1935 1935 - }; 1936 1936 - '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串': { 1937 1937 - post: { 1938 1938 - req: NonAsciiæøåÆøÅöôêÊ字符串Data; 1939 1939 - res: { 1940 1940 - /** 1941 1941 - * Successful response 1942 1942 - */ 1943 1943 - '200': Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1944 1944 - }; 1945 1945 - }; 1946 1946 - put: { 1947 1947 - req: PutWithFormUrlEncodedData; 1948 1948 - }; 1949 1949 - }; 1950 1581 };

-69

packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-fetch-class_transform/types.gen.ts.snap

··· 58 58 59 59 export type MultipleResponsesError = unknown; 60 60 61 61 - export type $OpenApiTs = { 62 62 - '/api/model-with-dates': { 63 63 - post: { 64 64 - res: { 65 65 - /** 66 66 - * Success 67 67 - */ 68 68 - '200': ParentModelWithDates; 69 69 - /** 70 70 - * Success 71 71 - */ 72 72 - '201': unknown; 73 73 - }; 74 74 - }; 75 75 - put: { 76 76 - res: { 77 77 - /** 78 78 - * Success 79 79 - */ 80 80 - '200': ModelWithDates; 81 81 - }; 82 82 - }; 83 83 - }; 84 84 - '/api/model-with-dates-array': { 85 85 - put: { 86 86 - res: { 87 87 - /** 88 88 - * Success 89 89 - */ 90 90 - '200': Array<ModelWithDates>; 91 91 - }; 92 92 - }; 93 93 - }; 94 94 - '/api/array-of-dates': { 95 95 - put: { 96 96 - res: { 97 97 - /** 98 98 - * Success 99 99 - */ 100 100 - '200': Array<(Date)>; 101 101 - }; 102 102 - }; 103 103 - }; 104 104 - '/api/date': { 105 105 - put: { 106 106 - res: { 107 107 - /** 108 108 - * Success 109 109 - */ 110 110 - '200': Date; 111 111 - }; 112 112 - }; 113 113 - }; 114 114 - '/api/multiple-responses': { 115 115 - put: { 116 116 - res: { 117 117 - /** 118 118 - * Updated 119 119 - */ 120 120 - '200': Array<ModelWithDates>; 121 121 - /** 122 122 - * Created 123 123 - */ 124 124 - '201': Array<SimpleModel>; 125 125 - }; 126 126 - }; 127 127 - }; 128 128 - }; 129 129 - 130 61 export type ParentModelWithDatesResponseTransformer = (data: any) => Promise<ParentModelWithDatesResponse>; 131 62 132 63 export type ParentModelWithDatesModelResponseTransformer = (data: any) => ParentModelWithDates;

-369

packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-fetch-plugin-tanstack-react-query/types.gen.ts.snap

··· 1578 1578 1579 1579 export type PutWithFormUrlEncodedData = { 1580 1580 body: ArrayWithStrings; 1581 1581 - }; 1582 1582 - 1583 1583 - export type $OpenApiTs = { 1584 1584 - '/api/v{api-version}/no-tag': { 1585 1585 - post: { 1586 1586 - req: ImportData; 1587 1587 - res: { 1588 1588 - /** 1589 1589 - * Success 1590 1590 - */ 1591 1591 - '200': Model_From_Zendesk; 1592 1592 - /** 1593 1593 - * Default success response 1594 1594 - */ 1595 1595 - default: ModelWithReadOnlyAndWriteOnly; 1596 1596 - }; 1597 1597 - }; 1598 1598 - }; 1599 1599 - '/api/v{api-version}/simple/$count': { 1600 1600 - get: { 1601 1601 - res: { 1602 1602 - /** 1603 1603 - * Success 1604 1604 - */ 1605 1605 - '200': Model_From_Zendesk; 1606 1606 - }; 1607 1607 - }; 1608 1608 - }; 1609 1609 - '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}': { 1610 1610 - delete: { 1611 1611 - req: DeleteFooData3; 1612 1612 - }; 1613 1613 - }; 1614 1614 - '/api/v{api-version}/descriptions/': { 1615 1615 - post: { 1616 1616 - req: CallWithDescriptionsData; 1617 1617 - }; 1618 1618 - }; 1619 1619 - '/api/v{api-version}/parameters/deprecated': { 1620 1620 - post: { 1621 1621 - req: DeprecatedCallData; 1622 1622 - }; 1623 1623 - }; 1624 1624 - '/api/v{api-version}/parameters/{parameterPath}': { 1625 1625 - post: { 1626 1626 - req: CallWithParametersData; 1627 1627 - }; 1628 1628 - }; 1629 1629 - '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}': { 1630 1630 - post: { 1631 1631 - req: CallWithWeirdParameterNamesData; 1632 1632 - }; 1633 1633 - }; 1634 1634 - '/api/v{api-version}/parameters/': { 1635 1635 - get: { 1636 1636 - req: GetCallWithOptionalParamData; 1637 1637 - }; 1638 1638 - post: { 1639 1639 - req: PostCallWithOptionalParamData; 1640 1640 - res: { 1641 1641 - /** 1642 1642 - * Response is a simple number 1643 1643 - */ 1644 1644 - '200': number; 1645 1645 - /** 1646 1646 - * Success 1647 1647 - */ 1648 1648 - '204': void; 1649 1649 - }; 1650 1650 - }; 1651 1651 - }; 1652 1652 - '/api/v{api-version}/requestBody/': { 1653 1653 - post: { 1654 1654 - req: PostApiVbyApiVersionRequestBodyData; 1655 1655 - }; 1656 1656 - }; 1657 1657 - '/api/v{api-version}/formData/': { 1658 1658 - post: { 1659 1659 - req: PostApiVbyApiVersionFormDataData; 1660 1660 - }; 1661 1661 - }; 1662 1662 - '/api/v{api-version}/defaults': { 1663 1663 - get: { 1664 1664 - req: CallWithDefaultParametersData; 1665 1665 - }; 1666 1666 - post: { 1667 1667 - req: CallWithDefaultOptionalParametersData; 1668 1668 - }; 1669 1669 - put: { 1670 1670 - req: CallToTestOrderOfParamsData; 1671 1671 - }; 1672 1672 - }; 1673 1673 - '/api/v{api-version}/no-content': { 1674 1674 - get: { 1675 1675 - res: { 1676 1676 - /** 1677 1677 - * Success 1678 1678 - */ 1679 1679 - '204': void; 1680 1680 - }; 1681 1681 - }; 1682 1682 - }; 1683 1683 - '/api/v{api-version}/multiple-tags/response-and-no-content': { 1684 1684 - get: { 1685 1685 - res: { 1686 1686 - /** 1687 1687 - * Response is a simple number 1688 1688 - */ 1689 1689 - '200': number; 1690 1690 - /** 1691 1691 - * Success 1692 1692 - */ 1693 1693 - '204': void; 1694 1694 - }; 1695 1695 - }; 1696 1696 - }; 1697 1697 - '/api/v{api-version}/multiple-tags/a': { 1698 1698 - get: { 1699 1699 - res: { 1700 1700 - '200': _400; 1701 1701 - }; 1702 1702 - }; 1703 1703 - }; 1704 1704 - '/api/v{api-version}/multiple-tags/b': { 1705 1705 - get: { 1706 1706 - res: { 1707 1707 - /** 1708 1708 - * Success 1709 1709 - */ 1710 1710 - '204': void; 1711 1711 - }; 1712 1712 - }; 1713 1713 - }; 1714 1714 - '/api/v{api-version}/response': { 1715 1715 - get: { 1716 1716 - res: { 1717 1717 - default: _import; 1718 1718 - }; 1719 1719 - }; 1720 1720 - post: { 1721 1721 - res: { 1722 1722 - /** 1723 1723 - * Message for 200 response 1724 1724 - */ 1725 1725 - '200': ModelWithBoolean & ModelWithInteger; 1726 1726 - /** 1727 1727 - * Message for 201 response 1728 1728 - */ 1729 1729 - '201': ModelWithString; 1730 1730 - /** 1731 1731 - * Message for 202 response 1732 1732 - */ 1733 1733 - '202': ModelWithString; 1734 1734 - /** 1735 1735 - * Message for 500 error 1736 1736 - */ 1737 1737 - '500': ModelWithStringError; 1738 1738 - /** 1739 1739 - * Message for 501 error 1740 1740 - */ 1741 1741 - '501': ModelWithStringError; 1742 1742 - /** 1743 1743 - * Message for 502 error 1744 1744 - */ 1745 1745 - '502': ModelWithStringError; 1746 1746 - /** 1747 1747 - * Message for 4XX errors 1748 1748 - */ 1749 1749 - '4XX': DictionaryWithArray; 1750 1750 - /** 1751 1751 - * Default error response 1752 1752 - */ 1753 1753 - default: ModelWithBoolean; 1754 1754 - }; 1755 1755 - }; 1756 1756 - put: { 1757 1757 - res: { 1758 1758 - /** 1759 1759 - * Message for 200 response 1760 1760 - */ 1761 1761 - '200': { 1762 1762 - readonly '@namespace.string'?: string; 1763 1763 - readonly '@namespace.integer'?: number; 1764 1764 - readonly value?: Array<ModelWithString>; 1765 1765 - }; 1766 1766 - /** 1767 1767 - * Message for 201 response 1768 1768 - */ 1769 1769 - '201': ModelThatExtends; 1770 1770 - /** 1771 1771 - * Message for 202 response 1772 1772 - */ 1773 1773 - '202': ModelThatExtendsExtends; 1774 1774 - /** 1775 1775 - * Message for 500 error 1776 1776 - */ 1777 1777 - '500': ModelWithStringError; 1778 1778 - /** 1779 1779 - * Message for 501 error 1780 1780 - */ 1781 1781 - '501': ModelWithStringError; 1782 1782 - /** 1783 1783 - * Message for 502 error 1784 1784 - */ 1785 1785 - '502': ModelWithStringError; 1786 1786 - /** 1787 1787 - * Message for default response 1788 1788 - */ 1789 1789 - default: ModelWithStringError; 1790 1790 - }; 1791 1791 - }; 1792 1792 - }; 1793 1793 - '/api/v{api-version}/collectionFormat': { 1794 1794 - get: { 1795 1795 - req: CollectionFormatData; 1796 1796 - }; 1797 1797 - }; 1798 1798 - '/api/v{api-version}/types': { 1799 1799 - get: { 1800 1800 - req: TypesData; 1801 1801 - res: { 1802 1802 - /** 1803 1803 - * Response is a simple number 1804 1804 - */ 1805 1805 - '200': number; 1806 1806 - /** 1807 1807 - * Response is a simple string 1808 1808 - */ 1809 1809 - '201': string; 1810 1810 - /** 1811 1811 - * Response is a simple boolean 1812 1812 - */ 1813 1813 - '202': boolean; 1814 1814 - /** 1815 1815 - * Response is a simple object 1816 1816 - */ 1817 1817 - '203': { 1818 1818 - [key: string]: unknown; 1819 1819 - }; 1820 1820 - }; 1821 1821 - }; 1822 1822 - }; 1823 1823 - '/api/v{api-version}/upload': { 1824 1824 - post: { 1825 1825 - req: UploadFileData; 1826 1826 - res: { 1827 1827 - '200': boolean; 1828 1828 - }; 1829 1829 - }; 1830 1830 - }; 1831 1831 - '/api/v{api-version}/file/{id}': { 1832 1832 - get: { 1833 1833 - req: FileResponseData; 1834 1834 - res: { 1835 1835 - /** 1836 1836 - * Success 1837 1837 - */ 1838 1838 - '200': (Blob | File); 1839 1839 - }; 1840 1840 - }; 1841 1841 - }; 1842 1842 - '/api/v{api-version}/complex': { 1843 1843 - get: { 1844 1844 - req: ComplexTypesData; 1845 1845 - res: { 1846 1846 - /** 1847 1847 - * Successful response 1848 1848 - */ 1849 1849 - '200': Array<ModelWithString>; 1850 1850 - /** 1851 1851 - * 400 `server` error 1852 1852 - */ 1853 1853 - '400': unknown; 1854 1854 - /** 1855 1855 - * 500 server error 1856 1856 - */ 1857 1857 - '500': unknown; 1858 1858 - }; 1859 1859 - }; 1860 1860 - }; 1861 1861 - '/api/v{api-version}/multipart': { 1862 1862 - post: { 1863 1863 - req: MultipartRequestData; 1864 1864 - }; 1865 1865 - get: { 1866 1866 - res: { 1867 1867 - /** 1868 1868 - * OK 1869 1869 - */ 1870 1870 - '200': { 1871 1871 - file?: (Blob | File); 1872 1872 - metadata?: { 1873 1873 - foo?: string; 1874 1874 - bar?: string; 1875 1875 - }; 1876 1876 - }; 1877 1877 - }; 1878 1878 - }; 1879 1879 - }; 1880 1880 - '/api/v{api-version}/complex/{id}': { 1881 1881 - put: { 1882 1882 - req: ComplexParamsData; 1883 1883 - res: { 1884 1884 - /** 1885 1885 - * Success 1886 1886 - */ 1887 1887 - '200': ModelWithString; 1888 1888 - }; 1889 1889 - }; 1890 1890 - }; 1891 1891 - '/api/v{api-version}/header': { 1892 1892 - post: { 1893 1893 - res: { 1894 1894 - /** 1895 1895 - * Successful response 1896 1896 - */ 1897 1897 - '200': string; 1898 1898 - /** 1899 1899 - * 400 server error 1900 1900 - */ 1901 1901 - '400': unknown; 1902 1902 - /** 1903 1903 - * 500 server error 1904 1904 - */ 1905 1905 - '500': unknown; 1906 1906 - }; 1907 1907 - }; 1908 1908 - }; 1909 1909 - '/api/v{api-version}/error': { 1910 1910 - post: { 1911 1911 - req: TestErrorCodeData; 1912 1912 - res: { 1913 1913 - /** 1914 1914 - * Custom message: Successful response 1915 1915 - */ 1916 1916 - '200': unknown; 1917 1917 - /** 1918 1918 - * Custom message: Internal Server Error 1919 1919 - */ 1920 1920 - '500': unknown; 1921 1921 - /** 1922 1922 - * Custom message: Not Implemented 1923 1923 - */ 1924 1924 - '501': unknown; 1925 1925 - /** 1926 1926 - * Custom message: Bad Gateway 1927 1927 - */ 1928 1928 - '502': unknown; 1929 1929 - /** 1930 1930 - * Custom message: Service Unavailable 1931 1931 - */ 1932 1932 - '503': unknown; 1933 1933 - }; 1934 1934 - }; 1935 1935 - }; 1936 1936 - '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串': { 1937 1937 - post: { 1938 1938 - req: NonAsciiæøåÆøÅöôêÊ字符串Data; 1939 1939 - res: { 1940 1940 - /** 1941 1941 - * Successful response 1942 1942 - */ 1943 1943 - '200': Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1944 1944 - }; 1945 1945 - }; 1946 1946 - put: { 1947 1947 - req: PutWithFormUrlEncodedData; 1948 1948 - }; 1949 1949 - }; 1950 1581 };

-69

packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-fetch-plugin-tanstack-react-query_transform/types.gen.ts.snap

··· 58 58 59 59 export type MultipleResponsesError = unknown; 60 60 61 61 - export type $OpenApiTs = { 62 62 - '/api/model-with-dates': { 63 63 - post: { 64 64 - res: { 65 65 - /** 66 66 - * Success 67 67 - */ 68 68 - '200': ParentModelWithDates; 69 69 - /** 70 70 - * Success 71 71 - */ 72 72 - '201': unknown; 73 73 - }; 74 74 - }; 75 75 - put: { 76 76 - res: { 77 77 - /** 78 78 - * Success 79 79 - */ 80 80 - '200': ModelWithDates; 81 81 - }; 82 82 - }; 83 83 - }; 84 84 - '/api/model-with-dates-array': { 85 85 - put: { 86 86 - res: { 87 87 - /** 88 88 - * Success 89 89 - */ 90 90 - '200': Array<ModelWithDates>; 91 91 - }; 92 92 - }; 93 93 - }; 94 94 - '/api/array-of-dates': { 95 95 - put: { 96 96 - res: { 97 97 - /** 98 98 - * Success 99 99 - */ 100 100 - '200': Array<(Date)>; 101 101 - }; 102 102 - }; 103 103 - }; 104 104 - '/api/date': { 105 105 - put: { 106 106 - res: { 107 107 - /** 108 108 - * Success 109 109 - */ 110 110 - '200': Date; 111 111 - }; 112 112 - }; 113 113 - }; 114 114 - '/api/multiple-responses': { 115 115 - put: { 116 116 - res: { 117 117 - /** 118 118 - * Updated 119 119 - */ 120 120 - '200': Array<ModelWithDates>; 121 121 - /** 122 122 - * Created 123 123 - */ 124 124 - '201': Array<SimpleModel>; 125 125 - }; 126 126 - }; 127 127 - }; 128 128 - }; 129 129 - 130 61 export type ParentModelWithDatesResponseTransformer = (data: any) => Promise<ParentModelWithDatesResponse>; 131 62 132 63 export type ParentModelWithDatesModelResponseTransformer = (data: any) => ParentModelWithDates;

-369

packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-fetch/types.gen.ts.snap

··· 1578 1578 1579 1579 export type PutWithFormUrlEncodedData = { 1580 1580 body: ArrayWithStrings; 1581 1581 - }; 1582 1582 - 1583 1583 - export type $OpenApiTs = { 1584 1584 - '/api/v{api-version}/no-tag': { 1585 1585 - post: { 1586 1586 - req: ImportData; 1587 1587 - res: { 1588 1588 - /** 1589 1589 - * Success 1590 1590 - */ 1591 1591 - '200': Model_From_Zendesk; 1592 1592 - /** 1593 1593 - * Default success response 1594 1594 - */ 1595 1595 - default: ModelWithReadOnlyAndWriteOnly; 1596 1596 - }; 1597 1597 - }; 1598 1598 - }; 1599 1599 - '/api/v{api-version}/simple/$count': { 1600 1600 - get: { 1601 1601 - res: { 1602 1602 - /** 1603 1603 - * Success 1604 1604 - */ 1605 1605 - '200': Model_From_Zendesk; 1606 1606 - }; 1607 1607 - }; 1608 1608 - }; 1609 1609 - '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}': { 1610 1610 - delete: { 1611 1611 - req: DeleteFooData3; 1612 1612 - }; 1613 1613 - }; 1614 1614 - '/api/v{api-version}/descriptions/': { 1615 1615 - post: { 1616 1616 - req: CallWithDescriptionsData; 1617 1617 - }; 1618 1618 - }; 1619 1619 - '/api/v{api-version}/parameters/deprecated': { 1620 1620 - post: { 1621 1621 - req: DeprecatedCallData; 1622 1622 - }; 1623 1623 - }; 1624 1624 - '/api/v{api-version}/parameters/{parameterPath}': { 1625 1625 - post: { 1626 1626 - req: CallWithParametersData; 1627 1627 - }; 1628 1628 - }; 1629 1629 - '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}': { 1630 1630 - post: { 1631 1631 - req: CallWithWeirdParameterNamesData; 1632 1632 - }; 1633 1633 - }; 1634 1634 - '/api/v{api-version}/parameters/': { 1635 1635 - get: { 1636 1636 - req: GetCallWithOptionalParamData; 1637 1637 - }; 1638 1638 - post: { 1639 1639 - req: PostCallWithOptionalParamData; 1640 1640 - res: { 1641 1641 - /** 1642 1642 - * Response is a simple number 1643 1643 - */ 1644 1644 - '200': number; 1645 1645 - /** 1646 1646 - * Success 1647 1647 - */ 1648 1648 - '204': void; 1649 1649 - }; 1650 1650 - }; 1651 1651 - }; 1652 1652 - '/api/v{api-version}/requestBody/': { 1653 1653 - post: { 1654 1654 - req: PostApiVbyApiVersionRequestBodyData; 1655 1655 - }; 1656 1656 - }; 1657 1657 - '/api/v{api-version}/formData/': { 1658 1658 - post: { 1659 1659 - req: PostApiVbyApiVersionFormDataData; 1660 1660 - }; 1661 1661 - }; 1662 1662 - '/api/v{api-version}/defaults': { 1663 1663 - get: { 1664 1664 - req: CallWithDefaultParametersData; 1665 1665 - }; 1666 1666 - post: { 1667 1667 - req: CallWithDefaultOptionalParametersData; 1668 1668 - }; 1669 1669 - put: { 1670 1670 - req: CallToTestOrderOfParamsData; 1671 1671 - }; 1672 1672 - }; 1673 1673 - '/api/v{api-version}/no-content': { 1674 1674 - get: { 1675 1675 - res: { 1676 1676 - /** 1677 1677 - * Success 1678 1678 - */ 1679 1679 - '204': void; 1680 1680 - }; 1681 1681 - }; 1682 1682 - }; 1683 1683 - '/api/v{api-version}/multiple-tags/response-and-no-content': { 1684 1684 - get: { 1685 1685 - res: { 1686 1686 - /** 1687 1687 - * Response is a simple number 1688 1688 - */ 1689 1689 - '200': number; 1690 1690 - /** 1691 1691 - * Success 1692 1692 - */ 1693 1693 - '204': void; 1694 1694 - }; 1695 1695 - }; 1696 1696 - }; 1697 1697 - '/api/v{api-version}/multiple-tags/a': { 1698 1698 - get: { 1699 1699 - res: { 1700 1700 - '200': _400; 1701 1701 - }; 1702 1702 - }; 1703 1703 - }; 1704 1704 - '/api/v{api-version}/multiple-tags/b': { 1705 1705 - get: { 1706 1706 - res: { 1707 1707 - /** 1708 1708 - * Success 1709 1709 - */ 1710 1710 - '204': void; 1711 1711 - }; 1712 1712 - }; 1713 1713 - }; 1714 1714 - '/api/v{api-version}/response': { 1715 1715 - get: { 1716 1716 - res: { 1717 1717 - default: _import; 1718 1718 - }; 1719 1719 - }; 1720 1720 - post: { 1721 1721 - res: { 1722 1722 - /** 1723 1723 - * Message for 200 response 1724 1724 - */ 1725 1725 - '200': ModelWithBoolean & ModelWithInteger; 1726 1726 - /** 1727 1727 - * Message for 201 response 1728 1728 - */ 1729 1729 - '201': ModelWithString; 1730 1730 - /** 1731 1731 - * Message for 202 response 1732 1732 - */ 1733 1733 - '202': ModelWithString; 1734 1734 - /** 1735 1735 - * Message for 500 error 1736 1736 - */ 1737 1737 - '500': ModelWithStringError; 1738 1738 - /** 1739 1739 - * Message for 501 error 1740 1740 - */ 1741 1741 - '501': ModelWithStringError; 1742 1742 - /** 1743 1743 - * Message for 502 error 1744 1744 - */ 1745 1745 - '502': ModelWithStringError; 1746 1746 - /** 1747 1747 - * Message for 4XX errors 1748 1748 - */ 1749 1749 - '4XX': DictionaryWithArray; 1750 1750 - /** 1751 1751 - * Default error response 1752 1752 - */ 1753 1753 - default: ModelWithBoolean; 1754 1754 - }; 1755 1755 - }; 1756 1756 - put: { 1757 1757 - res: { 1758 1758 - /** 1759 1759 - * Message for 200 response 1760 1760 - */ 1761 1761 - '200': { 1762 1762 - readonly '@namespace.string'?: string; 1763 1763 - readonly '@namespace.integer'?: number; 1764 1764 - readonly value?: Array<ModelWithString>; 1765 1765 - }; 1766 1766 - /** 1767 1767 - * Message for 201 response 1768 1768 - */ 1769 1769 - '201': ModelThatExtends; 1770 1770 - /** 1771 1771 - * Message for 202 response 1772 1772 - */ 1773 1773 - '202': ModelThatExtendsExtends; 1774 1774 - /** 1775 1775 - * Message for 500 error 1776 1776 - */ 1777 1777 - '500': ModelWithStringError; 1778 1778 - /** 1779 1779 - * Message for 501 error 1780 1780 - */ 1781 1781 - '501': ModelWithStringError; 1782 1782 - /** 1783 1783 - * Message for 502 error 1784 1784 - */ 1785 1785 - '502': ModelWithStringError; 1786 1786 - /** 1787 1787 - * Message for default response 1788 1788 - */ 1789 1789 - default: ModelWithStringError; 1790 1790 - }; 1791 1791 - }; 1792 1792 - }; 1793 1793 - '/api/v{api-version}/collectionFormat': { 1794 1794 - get: { 1795 1795 - req: CollectionFormatData; 1796 1796 - }; 1797 1797 - }; 1798 1798 - '/api/v{api-version}/types': { 1799 1799 - get: { 1800 1800 - req: TypesData; 1801 1801 - res: { 1802 1802 - /** 1803 1803 - * Response is a simple number 1804 1804 - */ 1805 1805 - '200': number; 1806 1806 - /** 1807 1807 - * Response is a simple string 1808 1808 - */ 1809 1809 - '201': string; 1810 1810 - /** 1811 1811 - * Response is a simple boolean 1812 1812 - */ 1813 1813 - '202': boolean; 1814 1814 - /** 1815 1815 - * Response is a simple object 1816 1816 - */ 1817 1817 - '203': { 1818 1818 - [key: string]: unknown; 1819 1819 - }; 1820 1820 - }; 1821 1821 - }; 1822 1822 - }; 1823 1823 - '/api/v{api-version}/upload': { 1824 1824 - post: { 1825 1825 - req: UploadFileData; 1826 1826 - res: { 1827 1827 - '200': boolean; 1828 1828 - }; 1829 1829 - }; 1830 1830 - }; 1831 1831 - '/api/v{api-version}/file/{id}': { 1832 1832 - get: { 1833 1833 - req: FileResponseData; 1834 1834 - res: { 1835 1835 - /** 1836 1836 - * Success 1837 1837 - */ 1838 1838 - '200': (Blob | File); 1839 1839 - }; 1840 1840 - }; 1841 1841 - }; 1842 1842 - '/api/v{api-version}/complex': { 1843 1843 - get: { 1844 1844 - req: ComplexTypesData; 1845 1845 - res: { 1846 1846 - /** 1847 1847 - * Successful response 1848 1848 - */ 1849 1849 - '200': Array<ModelWithString>; 1850 1850 - /** 1851 1851 - * 400 `server` error 1852 1852 - */ 1853 1853 - '400': unknown; 1854 1854 - /** 1855 1855 - * 500 server error 1856 1856 - */ 1857 1857 - '500': unknown; 1858 1858 - }; 1859 1859 - }; 1860 1860 - }; 1861 1861 - '/api/v{api-version}/multipart': { 1862 1862 - post: { 1863 1863 - req: MultipartRequestData; 1864 1864 - }; 1865 1865 - get: { 1866 1866 - res: { 1867 1867 - /** 1868 1868 - * OK 1869 1869 - */ 1870 1870 - '200': { 1871 1871 - file?: (Blob | File); 1872 1872 - metadata?: { 1873 1873 - foo?: string; 1874 1874 - bar?: string; 1875 1875 - }; 1876 1876 - }; 1877 1877 - }; 1878 1878 - }; 1879 1879 - }; 1880 1880 - '/api/v{api-version}/complex/{id}': { 1881 1881 - put: { 1882 1882 - req: ComplexParamsData; 1883 1883 - res: { 1884 1884 - /** 1885 1885 - * Success 1886 1886 - */ 1887 1887 - '200': ModelWithString; 1888 1888 - }; 1889 1889 - }; 1890 1890 - }; 1891 1891 - '/api/v{api-version}/header': { 1892 1892 - post: { 1893 1893 - res: { 1894 1894 - /** 1895 1895 - * Successful response 1896 1896 - */ 1897 1897 - '200': string; 1898 1898 - /** 1899 1899 - * 400 server error 1900 1900 - */ 1901 1901 - '400': unknown; 1902 1902 - /** 1903 1903 - * 500 server error 1904 1904 - */ 1905 1905 - '500': unknown; 1906 1906 - }; 1907 1907 - }; 1908 1908 - }; 1909 1909 - '/api/v{api-version}/error': { 1910 1910 - post: { 1911 1911 - req: TestErrorCodeData; 1912 1912 - res: { 1913 1913 - /** 1914 1914 - * Custom message: Successful response 1915 1915 - */ 1916 1916 - '200': unknown; 1917 1917 - /** 1918 1918 - * Custom message: Internal Server Error 1919 1919 - */ 1920 1920 - '500': unknown; 1921 1921 - /** 1922 1922 - * Custom message: Not Implemented 1923 1923 - */ 1924 1924 - '501': unknown; 1925 1925 - /** 1926 1926 - * Custom message: Bad Gateway 1927 1927 - */ 1928 1928 - '502': unknown; 1929 1929 - /** 1930 1930 - * Custom message: Service Unavailable 1931 1931 - */ 1932 1932 - '503': unknown; 1933 1933 - }; 1934 1934 - }; 1935 1935 - }; 1936 1936 - '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串': { 1937 1937 - post: { 1938 1938 - req: NonAsciiæøåÆøÅöôêÊ字符串Data; 1939 1939 - res: { 1940 1940 - /** 1941 1941 - * Successful response 1942 1942 - */ 1943 1943 - '200': Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1944 1944 - }; 1945 1945 - }; 1946 1946 - put: { 1947 1947 - req: PutWithFormUrlEncodedData; 1948 1948 - }; 1949 1949 - }; 1950 1581 };

-69

packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-fetch_transform/types.gen.ts.snap

··· 58 58 59 59 export type MultipleResponsesError = unknown; 60 60 61 61 - export type $OpenApiTs = { 62 62 - '/api/model-with-dates': { 63 63 - post: { 64 64 - res: { 65 65 - /** 66 66 - * Success 67 67 - */ 68 68 - '200': ParentModelWithDates; 69 69 - /** 70 70 - * Success 71 71 - */ 72 72 - '201': unknown; 73 73 - }; 74 74 - }; 75 75 - put: { 76 76 - res: { 77 77 - /** 78 78 - * Success 79 79 - */ 80 80 - '200': ModelWithDates; 81 81 - }; 82 82 - }; 83 83 - }; 84 84 - '/api/model-with-dates-array': { 85 85 - put: { 86 86 - res: { 87 87 - /** 88 88 - * Success 89 89 - */ 90 90 - '200': Array<ModelWithDates>; 91 91 - }; 92 92 - }; 93 93 - }; 94 94 - '/api/array-of-dates': { 95 95 - put: { 96 96 - res: { 97 97 - /** 98 98 - * Success 99 99 - */ 100 100 - '200': Array<(Date)>; 101 101 - }; 102 102 - }; 103 103 - }; 104 104 - '/api/date': { 105 105 - put: { 106 106 - res: { 107 107 - /** 108 108 - * Success 109 109 - */ 110 110 - '200': Date; 111 111 - }; 112 112 - }; 113 113 - }; 114 114 - '/api/multiple-responses': { 115 115 - put: { 116 116 - res: { 117 117 - /** 118 118 - * Updated 119 119 - */ 120 120 - '200': Array<ModelWithDates>; 121 121 - /** 122 122 - * Created 123 123 - */ 124 124 - '201': Array<SimpleModel>; 125 125 - }; 126 126 - }; 127 127 - }; 128 128 - }; 129 129 - 130 61 export type ParentModelWithDatesResponseTransformer = (data: any) => Promise<ParentModelWithDatesResponse>; 131 62 132 63 export type ParentModelWithDatesModelResponseTransformer = (data: any) => ParentModelWithDates;

-369

packages/openapi-ts/test/__snapshots__/test/generated/v3/types.gen.ts.snap

··· 1476 1476 1477 1477 export type PutWithFormUrlEncodedData = { 1478 1478 formData: ArrayWithStrings; 1479 1479 - }; 1480 1480 - 1481 1481 - export type $OpenApiTs = { 1482 1482 - '/api/v{api-version}/no-tag': { 1483 1483 - post: { 1484 1484 - req: ImportData; 1485 1485 - res: { 1486 1486 - /** 1487 1487 - * Success 1488 1488 - */ 1489 1489 - 200: Model_From_Zendesk; 1490 1490 - /** 1491 1491 - * Default success response 1492 1492 - */ 1493 1493 - default: ModelWithReadOnlyAndWriteOnly; 1494 1494 - }; 1495 1495 - }; 1496 1496 - }; 1497 1497 - '/api/v{api-version}/simple/$count': { 1498 1498 - get: { 1499 1499 - res: { 1500 1500 - /** 1501 1501 - * Success 1502 1502 - */ 1503 1503 - 200: Model_From_Zendesk; 1504 1504 - }; 1505 1505 - }; 1506 1506 - }; 1507 1507 - '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}': { 1508 1508 - delete: { 1509 1509 - req: DeleteFooData3; 1510 1510 - }; 1511 1511 - }; 1512 1512 - '/api/v{api-version}/parameters/{parameterPath}': { 1513 1513 - post: { 1514 1514 - req: CallWithParametersData; 1515 1515 - }; 1516 1516 - }; 1517 1517 - '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}': { 1518 1518 - post: { 1519 1519 - req: CallWithWeirdParameterNamesData; 1520 1520 - }; 1521 1521 - }; 1522 1522 - '/api/v{api-version}/parameters/': { 1523 1523 - get: { 1524 1524 - req: GetCallWithOptionalParamData; 1525 1525 - }; 1526 1526 - post: { 1527 1527 - req: PostCallWithOptionalParamData; 1528 1528 - res: { 1529 1529 - /** 1530 1530 - * Response is a simple number 1531 1531 - */ 1532 1532 - 200: number; 1533 1533 - /** 1534 1534 - * Success 1535 1535 - */ 1536 1536 - 204: void; 1537 1537 - }; 1538 1538 - }; 1539 1539 - }; 1540 1540 - '/api/v{api-version}/descriptions/': { 1541 1541 - post: { 1542 1542 - req: CallWithDescriptionsData; 1543 1543 - }; 1544 1544 - }; 1545 1545 - '/api/v{api-version}/parameters/deprecated': { 1546 1546 - post: { 1547 1547 - req: DeprecatedCallData; 1548 1548 - }; 1549 1549 - }; 1550 1550 - '/api/v{api-version}/requestBody/': { 1551 1551 - post: { 1552 1552 - req: PostApiRequestBodyData; 1553 1553 - }; 1554 1554 - }; 1555 1555 - '/api/v{api-version}/formData/': { 1556 1556 - post: { 1557 1557 - req: PostApiFormDataData; 1558 1558 - }; 1559 1559 - }; 1560 1560 - '/api/v{api-version}/defaults': { 1561 1561 - get: { 1562 1562 - req: CallWithDefaultParametersData; 1563 1563 - }; 1564 1564 - post: { 1565 1565 - req: CallWithDefaultOptionalParametersData; 1566 1566 - }; 1567 1567 - put: { 1568 1568 - req: CallToTestOrderOfParamsData; 1569 1569 - }; 1570 1570 - }; 1571 1571 - '/api/v{api-version}/no-content': { 1572 1572 - get: { 1573 1573 - res: { 1574 1574 - /** 1575 1575 - * Success 1576 1576 - */ 1577 1577 - 204: void; 1578 1578 - }; 1579 1579 - }; 1580 1580 - }; 1581 1581 - '/api/v{api-version}/multiple-tags/response-and-no-content': { 1582 1582 - get: { 1583 1583 - res: { 1584 1584 - /** 1585 1585 - * Response is a simple number 1586 1586 - */ 1587 1587 - 200: number; 1588 1588 - /** 1589 1589 - * Success 1590 1590 - */ 1591 1591 - 204: void; 1592 1592 - }; 1593 1593 - }; 1594 1594 - }; 1595 1595 - '/api/v{api-version}/response': { 1596 1596 - get: { 1597 1597 - res: { 1598 1598 - default: _import; 1599 1599 - }; 1600 1600 - }; 1601 1601 - post: { 1602 1602 - res: { 1603 1603 - /** 1604 1604 - * Message for 200 response 1605 1605 - */ 1606 1606 - 200: ModelWithBoolean & ModelWithInteger; 1607 1607 - /** 1608 1608 - * Message for 201 response 1609 1609 - */ 1610 1610 - 201: ModelWithString; 1611 1611 - /** 1612 1612 - * Message for 202 response 1613 1613 - */ 1614 1614 - 202: ModelWithString; 1615 1615 - /** 1616 1616 - * Message for 500 error 1617 1617 - */ 1618 1618 - 500: ModelWithStringError; 1619 1619 - /** 1620 1620 - * Message for 501 error 1621 1621 - */ 1622 1622 - 501: ModelWithStringError; 1623 1623 - /** 1624 1624 - * Message for 502 error 1625 1625 - */ 1626 1626 - 502: ModelWithStringError; 1627 1627 - /** 1628 1628 - * Message for 4XX errors 1629 1629 - */ 1630 1630 - '4XX': DictionaryWithArray; 1631 1631 - /** 1632 1632 - * Default error response 1633 1633 - */ 1634 1634 - default: ModelWithBoolean; 1635 1635 - }; 1636 1636 - }; 1637 1637 - put: { 1638 1638 - res: { 1639 1639 - /** 1640 1640 - * Message for 200 response 1641 1641 - */ 1642 1642 - 200: { 1643 1643 - readonly '@namespace.string'?: string; 1644 1644 - readonly '@namespace.integer'?: number; 1645 1645 - readonly value?: Array<ModelWithString>; 1646 1646 - }; 1647 1647 - /** 1648 1648 - * Message for 201 response 1649 1649 - */ 1650 1650 - 201: ModelThatExtends; 1651 1651 - /** 1652 1652 - * Message for 202 response 1653 1653 - */ 1654 1654 - 202: ModelThatExtendsExtends; 1655 1655 - /** 1656 1656 - * Message for 500 error 1657 1657 - */ 1658 1658 - 500: ModelWithStringError; 1659 1659 - /** 1660 1660 - * Message for 501 error 1661 1661 - */ 1662 1662 - 501: ModelWithStringError; 1663 1663 - /** 1664 1664 - * Message for 502 error 1665 1665 - */ 1666 1666 - 502: ModelWithStringError; 1667 1667 - /** 1668 1668 - * Message for default response 1669 1669 - */ 1670 1670 - default: ModelWithStringError; 1671 1671 - }; 1672 1672 - }; 1673 1673 - }; 1674 1674 - '/api/v{api-version}/multiple-tags/a': { 1675 1675 - get: { 1676 1676 - res: { 1677 1677 - 200: _400; 1678 1678 - }; 1679 1679 - }; 1680 1680 - }; 1681 1681 - '/api/v{api-version}/multiple-tags/b': { 1682 1682 - get: { 1683 1683 - res: { 1684 1684 - /** 1685 1685 - * Success 1686 1686 - */ 1687 1687 - 204: void; 1688 1688 - }; 1689 1689 - }; 1690 1690 - }; 1691 1691 - '/api/v{api-version}/collectionFormat': { 1692 1692 - get: { 1693 1693 - req: CollectionFormatData; 1694 1694 - }; 1695 1695 - }; 1696 1696 - '/api/v{api-version}/types': { 1697 1697 - get: { 1698 1698 - req: TypesData; 1699 1699 - res: { 1700 1700 - /** 1701 1701 - * Response is a simple number 1702 1702 - */ 1703 1703 - 200: number; 1704 1704 - /** 1705 1705 - * Response is a simple string 1706 1706 - */ 1707 1707 - 201: string; 1708 1708 - /** 1709 1709 - * Response is a simple boolean 1710 1710 - */ 1711 1711 - 202: boolean; 1712 1712 - /** 1713 1713 - * Response is a simple object 1714 1714 - */ 1715 1715 - 203: { 1716 1716 - [key: string]: unknown; 1717 1717 - }; 1718 1718 - }; 1719 1719 - }; 1720 1720 - }; 1721 1721 - '/api/v{api-version}/upload': { 1722 1722 - post: { 1723 1723 - req: UploadFileData; 1724 1724 - res: { 1725 1725 - 200: boolean; 1726 1726 - }; 1727 1727 - }; 1728 1728 - }; 1729 1729 - '/api/v{api-version}/file/{id}': { 1730 1730 - get: { 1731 1731 - req: FileResponseData; 1732 1732 - res: { 1733 1733 - /** 1734 1734 - * Success 1735 1735 - */ 1736 1736 - 200: (Blob | File); 1737 1737 - }; 1738 1738 - }; 1739 1739 - }; 1740 1740 - '/api/v{api-version}/complex': { 1741 1741 - get: { 1742 1742 - req: ComplexTypesData; 1743 1743 - res: { 1744 1744 - /** 1745 1745 - * Successful response 1746 1746 - */ 1747 1747 - 200: Array<ModelWithString>; 1748 1748 - /** 1749 1749 - * 400 `server` error 1750 1750 - */ 1751 1751 - 400: unknown; 1752 1752 - /** 1753 1753 - * 500 server error 1754 1754 - */ 1755 1755 - 500: unknown; 1756 1756 - }; 1757 1757 - }; 1758 1758 - }; 1759 1759 - '/api/v{api-version}/complex/{id}': { 1760 1760 - put: { 1761 1761 - req: ComplexParamsData; 1762 1762 - res: { 1763 1763 - /** 1764 1764 - * Success 1765 1765 - */ 1766 1766 - 200: ModelWithString; 1767 1767 - }; 1768 1768 - }; 1769 1769 - }; 1770 1770 - '/api/v{api-version}/multipart': { 1771 1771 - post: { 1772 1772 - req: MultipartRequestData; 1773 1773 - }; 1774 1774 - get: { 1775 1775 - res: { 1776 1776 - /** 1777 1777 - * OK 1778 1778 - */ 1779 1779 - 200: { 1780 1780 - file?: (Blob | File); 1781 1781 - metadata?: { 1782 1782 - foo?: string; 1783 1783 - bar?: string; 1784 1784 - }; 1785 1785 - }; 1786 1786 - }; 1787 1787 - }; 1788 1788 - }; 1789 1789 - '/api/v{api-version}/header': { 1790 1790 - post: { 1791 1791 - res: { 1792 1792 - /** 1793 1793 - * Successful response 1794 1794 - */ 1795 1795 - 200: string; 1796 1796 - /** 1797 1797 - * 400 server error 1798 1798 - */ 1799 1799 - 400: unknown; 1800 1800 - /** 1801 1801 - * 500 server error 1802 1802 - */ 1803 1803 - 500: unknown; 1804 1804 - }; 1805 1805 - }; 1806 1806 - }; 1807 1807 - '/api/v{api-version}/error': { 1808 1808 - post: { 1809 1809 - req: TestErrorCodeData; 1810 1810 - res: { 1811 1811 - /** 1812 1812 - * Custom message: Successful response 1813 1813 - */ 1814 1814 - 200: unknown; 1815 1815 - /** 1816 1816 - * Custom message: Internal Server Error 1817 1817 - */ 1818 1818 - 500: unknown; 1819 1819 - /** 1820 1820 - * Custom message: Not Implemented 1821 1821 - */ 1822 1822 - 501: unknown; 1823 1823 - /** 1824 1824 - * Custom message: Bad Gateway 1825 1825 - */ 1826 1826 - 502: unknown; 1827 1827 - /** 1828 1828 - * Custom message: Service Unavailable 1829 1829 - */ 1830 1830 - 503: unknown; 1831 1831 - }; 1832 1832 - }; 1833 1833 - }; 1834 1834 - '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串': { 1835 1835 - post: { 1836 1836 - req: NonAsciiæøåÆøÅöôêÊ字符串Data; 1837 1837 - res: { 1838 1838 - /** 1839 1839 - * Successful response 1840 1840 - */ 1841 1841 - 200: Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1842 1842 - }; 1843 1843 - }; 1844 1844 - put: { 1845 1845 - req: PutWithFormUrlEncodedData; 1846 1846 - }; 1847 1847 - }; 1848 1479 };

-369

packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/types.gen.ts.snap

··· 1353 1353 1354 1354 export type PutWithFormUrlEncodedData = { 1355 1355 formData: ArrayWithStrings; 1356 1356 - }; 1357 1357 - 1358 1358 - export type $OpenApiTs = { 1359 1359 - '/api/v{api-version}/no-tag': { 1360 1360 - post: { 1361 1361 - req: ImportData; 1362 1362 - res: { 1363 1363 - /** 1364 1364 - * Success 1365 1365 - */ 1366 1366 - 200: Model_From_Zendesk; 1367 1367 - /** 1368 1368 - * Default success response 1369 1369 - */ 1370 1370 - default: ModelWithReadOnlyAndWriteOnly; 1371 1371 - }; 1372 1372 - }; 1373 1373 - }; 1374 1374 - '/api/v{api-version}/simple/$count': { 1375 1375 - get: { 1376 1376 - res: { 1377 1377 - /** 1378 1378 - * Success 1379 1379 - */ 1380 1380 - 200: Model_From_Zendesk; 1381 1381 - }; 1382 1382 - }; 1383 1383 - }; 1384 1384 - '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}': { 1385 1385 - delete: { 1386 1386 - req: DeleteFooData3; 1387 1387 - }; 1388 1388 - }; 1389 1389 - '/api/v{api-version}/parameters/{parameterPath}': { 1390 1390 - post: { 1391 1391 - req: CallWithParametersData; 1392 1392 - }; 1393 1393 - }; 1394 1394 - '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}': { 1395 1395 - post: { 1396 1396 - req: CallWithWeirdParameterNamesData; 1397 1397 - }; 1398 1398 - }; 1399 1399 - '/api/v{api-version}/parameters/': { 1400 1400 - get: { 1401 1401 - req: GetCallWithOptionalParamData; 1402 1402 - }; 1403 1403 - post: { 1404 1404 - req: PostCallWithOptionalParamData; 1405 1405 - res: { 1406 1406 - /** 1407 1407 - * Response is a simple number 1408 1408 - */ 1409 1409 - 200: number; 1410 1410 - /** 1411 1411 - * Success 1412 1412 - */ 1413 1413 - 204: void; 1414 1414 - }; 1415 1415 - }; 1416 1416 - }; 1417 1417 - '/api/v{api-version}/descriptions/': { 1418 1418 - post: { 1419 1419 - req: CallWithDescriptionsData; 1420 1420 - }; 1421 1421 - }; 1422 1422 - '/api/v{api-version}/parameters/deprecated': { 1423 1423 - post: { 1424 1424 - req: DeprecatedCallData; 1425 1425 - }; 1426 1426 - }; 1427 1427 - '/api/v{api-version}/requestBody/': { 1428 1428 - post: { 1429 1429 - req: PostApiRequestBodyData; 1430 1430 - }; 1431 1431 - }; 1432 1432 - '/api/v{api-version}/formData/': { 1433 1433 - post: { 1434 1434 - req: PostApiFormDataData; 1435 1435 - }; 1436 1436 - }; 1437 1437 - '/api/v{api-version}/defaults': { 1438 1438 - get: { 1439 1439 - req: CallWithDefaultParametersData; 1440 1440 - }; 1441 1441 - post: { 1442 1442 - req: CallWithDefaultOptionalParametersData; 1443 1443 - }; 1444 1444 - put: { 1445 1445 - req: CallToTestOrderOfParamsData; 1446 1446 - }; 1447 1447 - }; 1448 1448 - '/api/v{api-version}/no-content': { 1449 1449 - get: { 1450 1450 - res: { 1451 1451 - /** 1452 1452 - * Success 1453 1453 - */ 1454 1454 - 204: void; 1455 1455 - }; 1456 1456 - }; 1457 1457 - }; 1458 1458 - '/api/v{api-version}/multiple-tags/response-and-no-content': { 1459 1459 - get: { 1460 1460 - res: { 1461 1461 - /** 1462 1462 - * Response is a simple number 1463 1463 - */ 1464 1464 - 200: number; 1465 1465 - /** 1466 1466 - * Success 1467 1467 - */ 1468 1468 - 204: void; 1469 1469 - }; 1470 1470 - }; 1471 1471 - }; 1472 1472 - '/api/v{api-version}/response': { 1473 1473 - get: { 1474 1474 - res: { 1475 1475 - default: _import; 1476 1476 - }; 1477 1477 - }; 1478 1478 - post: { 1479 1479 - res: { 1480 1480 - /** 1481 1481 - * Message for 200 response 1482 1482 - */ 1483 1483 - 200: ModelWithBoolean & ModelWithInteger; 1484 1484 - /** 1485 1485 - * Message for 201 response 1486 1486 - */ 1487 1487 - 201: ModelWithString; 1488 1488 - /** 1489 1489 - * Message for 202 response 1490 1490 - */ 1491 1491 - 202: ModelWithString; 1492 1492 - /** 1493 1493 - * Message for 500 error 1494 1494 - */ 1495 1495 - 500: ModelWithStringError; 1496 1496 - /** 1497 1497 - * Message for 501 error 1498 1498 - */ 1499 1499 - 501: ModelWithStringError; 1500 1500 - /** 1501 1501 - * Message for 502 error 1502 1502 - */ 1503 1503 - 502: ModelWithStringError; 1504 1504 - /** 1505 1505 - * Message for 4XX errors 1506 1506 - */ 1507 1507 - '4XX': DictionaryWithArray; 1508 1508 - /** 1509 1509 - * Default error response 1510 1510 - */ 1511 1511 - default: ModelWithBoolean; 1512 1512 - }; 1513 1513 - }; 1514 1514 - put: { 1515 1515 - res: { 1516 1516 - /** 1517 1517 - * Message for 200 response 1518 1518 - */ 1519 1519 - 200: { 1520 1520 - readonly '@namespace.string'?: string; 1521 1521 - readonly '@namespace.integer'?: number; 1522 1522 - readonly value?: Array<ModelWithString>; 1523 1523 - }; 1524 1524 - /** 1525 1525 - * Message for 201 response 1526 1526 - */ 1527 1527 - 201: ModelThatExtends; 1528 1528 - /** 1529 1529 - * Message for 202 response 1530 1530 - */ 1531 1531 - 202: ModelThatExtendsExtends; 1532 1532 - /** 1533 1533 - * Message for 500 error 1534 1534 - */ 1535 1535 - 500: ModelWithStringError; 1536 1536 - /** 1537 1537 - * Message for 501 error 1538 1538 - */ 1539 1539 - 501: ModelWithStringError; 1540 1540 - /** 1541 1541 - * Message for 502 error 1542 1542 - */ 1543 1543 - 502: ModelWithStringError; 1544 1544 - /** 1545 1545 - * Message for default response 1546 1546 - */ 1547 1547 - default: ModelWithStringError; 1548 1548 - }; 1549 1549 - }; 1550 1550 - }; 1551 1551 - '/api/v{api-version}/multiple-tags/a': { 1552 1552 - get: { 1553 1553 - res: { 1554 1554 - 200: _400; 1555 1555 - }; 1556 1556 - }; 1557 1557 - }; 1558 1558 - '/api/v{api-version}/multiple-tags/b': { 1559 1559 - get: { 1560 1560 - res: { 1561 1561 - /** 1562 1562 - * Success 1563 1563 - */ 1564 1564 - 204: void; 1565 1565 - }; 1566 1566 - }; 1567 1567 - }; 1568 1568 - '/api/v{api-version}/collectionFormat': { 1569 1569 - get: { 1570 1570 - req: CollectionFormatData; 1571 1571 - }; 1572 1572 - }; 1573 1573 - '/api/v{api-version}/types': { 1574 1574 - get: { 1575 1575 - req: TypesData; 1576 1576 - res: { 1577 1577 - /** 1578 1578 - * Response is a simple number 1579 1579 - */ 1580 1580 - 200: number; 1581 1581 - /** 1582 1582 - * Response is a simple string 1583 1583 - */ 1584 1584 - 201: string; 1585 1585 - /** 1586 1586 - * Response is a simple boolean 1587 1587 - */ 1588 1588 - 202: boolean; 1589 1589 - /** 1590 1590 - * Response is a simple object 1591 1591 - */ 1592 1592 - 203: { 1593 1593 - [key: string]: unknown; 1594 1594 - }; 1595 1595 - }; 1596 1596 - }; 1597 1597 - }; 1598 1598 - '/api/v{api-version}/upload': { 1599 1599 - post: { 1600 1600 - req: UploadFileData; 1601 1601 - res: { 1602 1602 - 200: boolean; 1603 1603 - }; 1604 1604 - }; 1605 1605 - }; 1606 1606 - '/api/v{api-version}/file/{id}': { 1607 1607 - get: { 1608 1608 - req: FileResponseData; 1609 1609 - res: { 1610 1610 - /** 1611 1611 - * Success 1612 1612 - */ 1613 1613 - 200: (Blob | File); 1614 1614 - }; 1615 1615 - }; 1616 1616 - }; 1617 1617 - '/api/v{api-version}/complex': { 1618 1618 - get: { 1619 1619 - req: ComplexTypesData; 1620 1620 - res: { 1621 1621 - /** 1622 1622 - * Successful response 1623 1623 - */ 1624 1624 - 200: Array<ModelWithString>; 1625 1625 - /** 1626 1626 - * 400 `server` error 1627 1627 - */ 1628 1628 - 400: unknown; 1629 1629 - /** 1630 1630 - * 500 server error 1631 1631 - */ 1632 1632 - 500: unknown; 1633 1633 - }; 1634 1634 - }; 1635 1635 - }; 1636 1636 - '/api/v{api-version}/complex/{id}': { 1637 1637 - put: { 1638 1638 - req: ComplexParamsData; 1639 1639 - res: { 1640 1640 - /** 1641 1641 - * Success 1642 1642 - */ 1643 1643 - 200: ModelWithString; 1644 1644 - }; 1645 1645 - }; 1646 1646 - }; 1647 1647 - '/api/v{api-version}/multipart': { 1648 1648 - post: { 1649 1649 - req: MultipartRequestData; 1650 1650 - }; 1651 1651 - get: { 1652 1652 - res: { 1653 1653 - /** 1654 1654 - * OK 1655 1655 - */ 1656 1656 - 200: { 1657 1657 - file?: (Blob | File); 1658 1658 - metadata?: { 1659 1659 - foo?: string; 1660 1660 - bar?: string; 1661 1661 - }; 1662 1662 - }; 1663 1663 - }; 1664 1664 - }; 1665 1665 - }; 1666 1666 - '/api/v{api-version}/header': { 1667 1667 - post: { 1668 1668 - res: { 1669 1669 - /** 1670 1670 - * Successful response 1671 1671 - */ 1672 1672 - 200: string; 1673 1673 - /** 1674 1674 - * 400 server error 1675 1675 - */ 1676 1676 - 400: unknown; 1677 1677 - /** 1678 1678 - * 500 server error 1679 1679 - */ 1680 1680 - 500: unknown; 1681 1681 - }; 1682 1682 - }; 1683 1683 - }; 1684 1684 - '/api/v{api-version}/error': { 1685 1685 - post: { 1686 1686 - req: TestErrorCodeData; 1687 1687 - res: { 1688 1688 - /** 1689 1689 - * Custom message: Successful response 1690 1690 - */ 1691 1691 - 200: unknown; 1692 1692 - /** 1693 1693 - * Custom message: Internal Server Error 1694 1694 - */ 1695 1695 - 500: unknown; 1696 1696 - /** 1697 1697 - * Custom message: Not Implemented 1698 1698 - */ 1699 1699 - 501: unknown; 1700 1700 - /** 1701 1701 - * Custom message: Bad Gateway 1702 1702 - */ 1703 1703 - 502: unknown; 1704 1704 - /** 1705 1705 - * Custom message: Service Unavailable 1706 1706 - */ 1707 1707 - 503: unknown; 1708 1708 - }; 1709 1709 - }; 1710 1710 - }; 1711 1711 - '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串': { 1712 1712 - post: { 1713 1713 - req: NonAsciiæøåÆøÅöôêÊ字符串Data; 1714 1714 - res: { 1715 1715 - /** 1716 1716 - * Successful response 1717 1717 - */ 1718 1718 - 200: Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1719 1719 - }; 1720 1720 - }; 1721 1721 - put: { 1722 1722 - req: PutWithFormUrlEncodedData; 1723 1723 - }; 1724 1724 - }; 1725 1356 };

-69

packages/openapi-ts/test/__snapshots__/test/generated/v3_angular_transform/types.gen.ts.snap

··· 46 46 47 47 export type MultipleResponsesResponse = Array<ModelWithDates> | Array<SimpleModel>; 48 48 49 49 - export type $OpenApiTs = { 50 50 - '/api/model-with-dates': { 51 51 - post: { 52 52 - res: { 53 53 - /** 54 54 - * Success 55 55 - */ 56 56 - 200: ParentModelWithDates; 57 57 - /** 58 58 - * Success 59 59 - */ 60 60 - 201: unknown; 61 61 - }; 62 62 - }; 63 63 - put: { 64 64 - res: { 65 65 - /** 66 66 - * Success 67 67 - */ 68 68 - 200: ModelWithDates; 69 69 - }; 70 70 - }; 71 71 - }; 72 72 - '/api/model-with-dates-array': { 73 73 - put: { 74 74 - res: { 75 75 - /** 76 76 - * Success 77 77 - */ 78 78 - 200: Array<ModelWithDates>; 79 79 - }; 80 80 - }; 81 81 - }; 82 82 - '/api/array-of-dates': { 83 83 - put: { 84 84 - res: { 85 85 - /** 86 86 - * Success 87 87 - */ 88 88 - 200: Array<(Date)>; 89 89 - }; 90 90 - }; 91 91 - }; 92 92 - '/api/date': { 93 93 - put: { 94 94 - res: { 95 95 - /** 96 96 - * Success 97 97 - */ 98 98 - 200: Date; 99 99 - }; 100 100 - }; 101 101 - }; 102 102 - '/api/multiple-responses': { 103 103 - put: { 104 104 - res: { 105 105 - /** 106 106 - * Updated 107 107 - */ 108 108 - 200: Array<ModelWithDates>; 109 109 - /** 110 110 - * Created 111 111 - */ 112 112 - 201: Array<SimpleModel>; 113 113 - }; 114 114 - }; 115 115 - }; 116 116 - }; 117 117 - 118 49 export type ParentModelWithDatesResponseTransformer = (data: any) => Promise<ParentModelWithDatesResponse>; 119 50 120 51 export type ParentModelWithDatesModelResponseTransformer = (data: any) => ParentModelWithDates;

-369

packages/openapi-ts/test/__snapshots__/test/generated/v3_axios/types.gen.ts.snap

··· 1476 1476 1477 1477 export type PutWithFormUrlEncodedData = { 1478 1478 formData: ArrayWithStrings; 1479 1479 - }; 1480 1480 - 1481 1481 - export type $OpenApiTs = { 1482 1482 - '/api/v{api-version}/no-tag': { 1483 1483 - post: { 1484 1484 - req: ImportData; 1485 1485 - res: { 1486 1486 - /** 1487 1487 - * Success 1488 1488 - */ 1489 1489 - 200: Model_From_Zendesk; 1490 1490 - /** 1491 1491 - * Default success response 1492 1492 - */ 1493 1493 - default: ModelWithReadOnlyAndWriteOnly; 1494 1494 - }; 1495 1495 - }; 1496 1496 - }; 1497 1497 - '/api/v{api-version}/simple/$count': { 1498 1498 - get: { 1499 1499 - res: { 1500 1500 - /** 1501 1501 - * Success 1502 1502 - */ 1503 1503 - 200: Model_From_Zendesk; 1504 1504 - }; 1505 1505 - }; 1506 1506 - }; 1507 1507 - '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}': { 1508 1508 - delete: { 1509 1509 - req: DeleteFooData3; 1510 1510 - }; 1511 1511 - }; 1512 1512 - '/api/v{api-version}/parameters/{parameterPath}': { 1513 1513 - post: { 1514 1514 - req: CallWithParametersData; 1515 1515 - }; 1516 1516 - }; 1517 1517 - '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}': { 1518 1518 - post: { 1519 1519 - req: CallWithWeirdParameterNamesData; 1520 1520 - }; 1521 1521 - }; 1522 1522 - '/api/v{api-version}/parameters/': { 1523 1523 - get: { 1524 1524 - req: GetCallWithOptionalParamData; 1525 1525 - }; 1526 1526 - post: { 1527 1527 - req: PostCallWithOptionalParamData; 1528 1528 - res: { 1529 1529 - /** 1530 1530 - * Response is a simple number 1531 1531 - */ 1532 1532 - 200: number; 1533 1533 - /** 1534 1534 - * Success 1535 1535 - */ 1536 1536 - 204: void; 1537 1537 - }; 1538 1538 - }; 1539 1539 - }; 1540 1540 - '/api/v{api-version}/descriptions/': { 1541 1541 - post: { 1542 1542 - req: CallWithDescriptionsData; 1543 1543 - }; 1544 1544 - }; 1545 1545 - '/api/v{api-version}/parameters/deprecated': { 1546 1546 - post: { 1547 1547 - req: DeprecatedCallData; 1548 1548 - }; 1549 1549 - }; 1550 1550 - '/api/v{api-version}/requestBody/': { 1551 1551 - post: { 1552 1552 - req: PostApiRequestBodyData; 1553 1553 - }; 1554 1554 - }; 1555 1555 - '/api/v{api-version}/formData/': { 1556 1556 - post: { 1557 1557 - req: PostApiFormDataData; 1558 1558 - }; 1559 1559 - }; 1560 1560 - '/api/v{api-version}/defaults': { 1561 1561 - get: { 1562 1562 - req: CallWithDefaultParametersData; 1563 1563 - }; 1564 1564 - post: { 1565 1565 - req: CallWithDefaultOptionalParametersData; 1566 1566 - }; 1567 1567 - put: { 1568 1568 - req: CallToTestOrderOfParamsData; 1569 1569 - }; 1570 1570 - }; 1571 1571 - '/api/v{api-version}/no-content': { 1572 1572 - get: { 1573 1573 - res: { 1574 1574 - /** 1575 1575 - * Success 1576 1576 - */ 1577 1577 - 204: void; 1578 1578 - }; 1579 1579 - }; 1580 1580 - }; 1581 1581 - '/api/v{api-version}/multiple-tags/response-and-no-content': { 1582 1582 - get: { 1583 1583 - res: { 1584 1584 - /** 1585 1585 - * Response is a simple number 1586 1586 - */ 1587 1587 - 200: number; 1588 1588 - /** 1589 1589 - * Success 1590 1590 - */ 1591 1591 - 204: void; 1592 1592 - }; 1593 1593 - }; 1594 1594 - }; 1595 1595 - '/api/v{api-version}/response': { 1596 1596 - get: { 1597 1597 - res: { 1598 1598 - default: _import; 1599 1599 - }; 1600 1600 - }; 1601 1601 - post: { 1602 1602 - res: { 1603 1603 - /** 1604 1604 - * Message for 200 response 1605 1605 - */ 1606 1606 - 200: ModelWithBoolean & ModelWithInteger; 1607 1607 - /** 1608 1608 - * Message for 201 response 1609 1609 - */ 1610 1610 - 201: ModelWithString; 1611 1611 - /** 1612 1612 - * Message for 202 response 1613 1613 - */ 1614 1614 - 202: ModelWithString; 1615 1615 - /** 1616 1616 - * Message for 500 error 1617 1617 - */ 1618 1618 - 500: ModelWithStringError; 1619 1619 - /** 1620 1620 - * Message for 501 error 1621 1621 - */ 1622 1622 - 501: ModelWithStringError; 1623 1623 - /** 1624 1624 - * Message for 502 error 1625 1625 - */ 1626 1626 - 502: ModelWithStringError; 1627 1627 - /** 1628 1628 - * Message for 4XX errors 1629 1629 - */ 1630 1630 - '4XX': DictionaryWithArray; 1631 1631 - /** 1632 1632 - * Default error response 1633 1633 - */ 1634 1634 - default: ModelWithBoolean; 1635 1635 - }; 1636 1636 - }; 1637 1637 - put: { 1638 1638 - res: { 1639 1639 - /** 1640 1640 - * Message for 200 response 1641 1641 - */ 1642 1642 - 200: { 1643 1643 - readonly '@namespace.string'?: string; 1644 1644 - readonly '@namespace.integer'?: number; 1645 1645 - readonly value?: Array<ModelWithString>; 1646 1646 - }; 1647 1647 - /** 1648 1648 - * Message for 201 response 1649 1649 - */ 1650 1650 - 201: ModelThatExtends; 1651 1651 - /** 1652 1652 - * Message for 202 response 1653 1653 - */ 1654 1654 - 202: ModelThatExtendsExtends; 1655 1655 - /** 1656 1656 - * Message for 500 error 1657 1657 - */ 1658 1658 - 500: ModelWithStringError; 1659 1659 - /** 1660 1660 - * Message for 501 error 1661 1661 - */ 1662 1662 - 501: ModelWithStringError; 1663 1663 - /** 1664 1664 - * Message for 502 error 1665 1665 - */ 1666 1666 - 502: ModelWithStringError; 1667 1667 - /** 1668 1668 - * Message for default response 1669 1669 - */ 1670 1670 - default: ModelWithStringError; 1671 1671 - }; 1672 1672 - }; 1673 1673 - }; 1674 1674 - '/api/v{api-version}/multiple-tags/a': { 1675 1675 - get: { 1676 1676 - res: { 1677 1677 - 200: _400; 1678 1678 - }; 1679 1679 - }; 1680 1680 - }; 1681 1681 - '/api/v{api-version}/multiple-tags/b': { 1682 1682 - get: { 1683 1683 - res: { 1684 1684 - /** 1685 1685 - * Success 1686 1686 - */ 1687 1687 - 204: void; 1688 1688 - }; 1689 1689 - }; 1690 1690 - }; 1691 1691 - '/api/v{api-version}/collectionFormat': { 1692 1692 - get: { 1693 1693 - req: CollectionFormatData; 1694 1694 - }; 1695 1695 - }; 1696 1696 - '/api/v{api-version}/types': { 1697 1697 - get: { 1698 1698 - req: TypesData; 1699 1699 - res: { 1700 1700 - /** 1701 1701 - * Response is a simple number 1702 1702 - */ 1703 1703 - 200: number; 1704 1704 - /** 1705 1705 - * Response is a simple string 1706 1706 - */ 1707 1707 - 201: string; 1708 1708 - /** 1709 1709 - * Response is a simple boolean 1710 1710 - */ 1711 1711 - 202: boolean; 1712 1712 - /** 1713 1713 - * Response is a simple object 1714 1714 - */ 1715 1715 - 203: { 1716 1716 - [key: string]: unknown; 1717 1717 - }; 1718 1718 - }; 1719 1719 - }; 1720 1720 - }; 1721 1721 - '/api/v{api-version}/upload': { 1722 1722 - post: { 1723 1723 - req: UploadFileData; 1724 1724 - res: { 1725 1725 - 200: boolean; 1726 1726 - }; 1727 1727 - }; 1728 1728 - }; 1729 1729 - '/api/v{api-version}/file/{id}': { 1730 1730 - get: { 1731 1731 - req: FileResponseData; 1732 1732 - res: { 1733 1733 - /** 1734 1734 - * Success 1735 1735 - */ 1736 1736 - 200: (Blob | File); 1737 1737 - }; 1738 1738 - }; 1739 1739 - }; 1740 1740 - '/api/v{api-version}/complex': { 1741 1741 - get: { 1742 1742 - req: ComplexTypesData; 1743 1743 - res: { 1744 1744 - /** 1745 1745 - * Successful response 1746 1746 - */ 1747 1747 - 200: Array<ModelWithString>; 1748 1748 - /** 1749 1749 - * 400 `server` error 1750 1750 - */ 1751 1751 - 400: unknown; 1752 1752 - /** 1753 1753 - * 500 server error 1754 1754 - */ 1755 1755 - 500: unknown; 1756 1756 - }; 1757 1757 - }; 1758 1758 - }; 1759 1759 - '/api/v{api-version}/complex/{id}': { 1760 1760 - put: { 1761 1761 - req: ComplexParamsData; 1762 1762 - res: { 1763 1763 - /** 1764 1764 - * Success 1765 1765 - */ 1766 1766 - 200: ModelWithString; 1767 1767 - }; 1768 1768 - }; 1769 1769 - }; 1770 1770 - '/api/v{api-version}/multipart': { 1771 1771 - post: { 1772 1772 - req: MultipartRequestData; 1773 1773 - }; 1774 1774 - get: { 1775 1775 - res: { 1776 1776 - /** 1777 1777 - * OK 1778 1778 - */ 1779 1779 - 200: { 1780 1780 - file?: (Blob | File); 1781 1781 - metadata?: { 1782 1782 - foo?: string; 1783 1783 - bar?: string; 1784 1784 - }; 1785 1785 - }; 1786 1786 - }; 1787 1787 - }; 1788 1788 - }; 1789 1789 - '/api/v{api-version}/header': { 1790 1790 - post: { 1791 1791 - res: { 1792 1792 - /** 1793 1793 - * Successful response 1794 1794 - */ 1795 1795 - 200: string; 1796 1796 - /** 1797 1797 - * 400 server error 1798 1798 - */ 1799 1799 - 400: unknown; 1800 1800 - /** 1801 1801 - * 500 server error 1802 1802 - */ 1803 1803 - 500: unknown; 1804 1804 - }; 1805 1805 - }; 1806 1806 - }; 1807 1807 - '/api/v{api-version}/error': { 1808 1808 - post: { 1809 1809 - req: TestErrorCodeData; 1810 1810 - res: { 1811 1811 - /** 1812 1812 - * Custom message: Successful response 1813 1813 - */ 1814 1814 - 200: unknown; 1815 1815 - /** 1816 1816 - * Custom message: Internal Server Error 1817 1817 - */ 1818 1818 - 500: unknown; 1819 1819 - /** 1820 1820 - * Custom message: Not Implemented 1821 1821 - */ 1822 1822 - 501: unknown; 1823 1823 - /** 1824 1824 - * Custom message: Bad Gateway 1825 1825 - */ 1826 1826 - 502: unknown; 1827 1827 - /** 1828 1828 - * Custom message: Service Unavailable 1829 1829 - */ 1830 1830 - 503: unknown; 1831 1831 - }; 1832 1832 - }; 1833 1833 - }; 1834 1834 - '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串': { 1835 1835 - post: { 1836 1836 - req: NonAsciiæøåÆøÅöôêÊ字符串Data; 1837 1837 - res: { 1838 1838 - /** 1839 1839 - * Successful response 1840 1840 - */ 1841 1841 - 200: Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1842 1842 - }; 1843 1843 - }; 1844 1844 - put: { 1845 1845 - req: PutWithFormUrlEncodedData; 1846 1846 - }; 1847 1847 - }; 1848 1479 };

-69

packages/openapi-ts/test/__snapshots__/test/generated/v3_axios_transform/types.gen.ts.snap

··· 46 46 47 47 export type MultipleResponsesResponse = Array<ModelWithDates> | Array<SimpleModel>; 48 48 49 49 - export type $OpenApiTs = { 50 50 - '/api/model-with-dates': { 51 51 - post: { 52 52 - res: { 53 53 - /** 54 54 - * Success 55 55 - */ 56 56 - 200: ParentModelWithDates; 57 57 - /** 58 58 - * Success 59 59 - */ 60 60 - 201: unknown; 61 61 - }; 62 62 - }; 63 63 - put: { 64 64 - res: { 65 65 - /** 66 66 - * Success 67 67 - */ 68 68 - 200: ModelWithDates; 69 69 - }; 70 70 - }; 71 71 - }; 72 72 - '/api/model-with-dates-array': { 73 73 - put: { 74 74 - res: { 75 75 - /** 76 76 - * Success 77 77 - */ 78 78 - 200: Array<ModelWithDates>; 79 79 - }; 80 80 - }; 81 81 - }; 82 82 - '/api/array-of-dates': { 83 83 - put: { 84 84 - res: { 85 85 - /** 86 86 - * Success 87 87 - */ 88 88 - 200: Array<(Date)>; 89 89 - }; 90 90 - }; 91 91 - }; 92 92 - '/api/date': { 93 93 - put: { 94 94 - res: { 95 95 - /** 96 96 - * Success 97 97 - */ 98 98 - 200: Date; 99 99 - }; 100 100 - }; 101 101 - }; 102 102 - '/api/multiple-responses': { 103 103 - put: { 104 104 - res: { 105 105 - /** 106 106 - * Updated 107 107 - */ 108 108 - 200: Array<ModelWithDates>; 109 109 - /** 110 110 - * Created 111 111 - */ 112 112 - 201: Array<SimpleModel>; 113 113 - }; 114 114 - }; 115 115 - }; 116 116 - }; 117 117 - 118 49 export type ParentModelWithDatesResponseTransformer = (data: any) => Promise<ParentModelWithDatesResponse>; 119 50 120 51 export type ParentModelWithDatesModelResponseTransformer = (data: any) => ParentModelWithDates;

-369

packages/openapi-ts/test/__snapshots__/test/generated/v3_client/types.gen.ts.snap

··· 1353 1353 1354 1354 export type PutWithFormUrlEncodedData = { 1355 1355 formData: ArrayWithStrings; 1356 1356 - }; 1357 1357 - 1358 1358 - export type $OpenApiTs = { 1359 1359 - '/api/v{api-version}/no-tag': { 1360 1360 - post: { 1361 1361 - req: ImportData; 1362 1362 - res: { 1363 1363 - /** 1364 1364 - * Success 1365 1365 - */ 1366 1366 - 200: Model_From_Zendesk; 1367 1367 - /** 1368 1368 - * Default success response 1369 1369 - */ 1370 1370 - default: ModelWithReadOnlyAndWriteOnly; 1371 1371 - }; 1372 1372 - }; 1373 1373 - }; 1374 1374 - '/api/v{api-version}/simple/$count': { 1375 1375 - get: { 1376 1376 - res: { 1377 1377 - /** 1378 1378 - * Success 1379 1379 - */ 1380 1380 - 200: Model_From_Zendesk; 1381 1381 - }; 1382 1382 - }; 1383 1383 - }; 1384 1384 - '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}': { 1385 1385 - delete: { 1386 1386 - req: DeleteFooData3; 1387 1387 - }; 1388 1388 - }; 1389 1389 - '/api/v{api-version}/parameters/{parameterPath}': { 1390 1390 - post: { 1391 1391 - req: CallWithParametersData; 1392 1392 - }; 1393 1393 - }; 1394 1394 - '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}': { 1395 1395 - post: { 1396 1396 - req: CallWithWeirdParameterNamesData; 1397 1397 - }; 1398 1398 - }; 1399 1399 - '/api/v{api-version}/parameters/': { 1400 1400 - get: { 1401 1401 - req: GetCallWithOptionalParamData; 1402 1402 - }; 1403 1403 - post: { 1404 1404 - req: PostCallWithOptionalParamData; 1405 1405 - res: { 1406 1406 - /** 1407 1407 - * Response is a simple number 1408 1408 - */ 1409 1409 - 200: number; 1410 1410 - /** 1411 1411 - * Success 1412 1412 - */ 1413 1413 - 204: void; 1414 1414 - }; 1415 1415 - }; 1416 1416 - }; 1417 1417 - '/api/v{api-version}/descriptions/': { 1418 1418 - post: { 1419 1419 - req: CallWithDescriptionsData; 1420 1420 - }; 1421 1421 - }; 1422 1422 - '/api/v{api-version}/parameters/deprecated': { 1423 1423 - post: { 1424 1424 - req: DeprecatedCallData; 1425 1425 - }; 1426 1426 - }; 1427 1427 - '/api/v{api-version}/requestBody/': { 1428 1428 - post: { 1429 1429 - req: PostApiRequestBodyData; 1430 1430 - }; 1431 1431 - }; 1432 1432 - '/api/v{api-version}/formData/': { 1433 1433 - post: { 1434 1434 - req: PostApiFormDataData; 1435 1435 - }; 1436 1436 - }; 1437 1437 - '/api/v{api-version}/defaults': { 1438 1438 - get: { 1439 1439 - req: CallWithDefaultParametersData; 1440 1440 - }; 1441 1441 - post: { 1442 1442 - req: CallWithDefaultOptionalParametersData; 1443 1443 - }; 1444 1444 - put: { 1445 1445 - req: CallToTestOrderOfParamsData; 1446 1446 - }; 1447 1447 - }; 1448 1448 - '/api/v{api-version}/no-content': { 1449 1449 - get: { 1450 1450 - res: { 1451 1451 - /** 1452 1452 - * Success 1453 1453 - */ 1454 1454 - 204: void; 1455 1455 - }; 1456 1456 - }; 1457 1457 - }; 1458 1458 - '/api/v{api-version}/multiple-tags/response-and-no-content': { 1459 1459 - get: { 1460 1460 - res: { 1461 1461 - /** 1462 1462 - * Response is a simple number 1463 1463 - */ 1464 1464 - 200: number; 1465 1465 - /** 1466 1466 - * Success 1467 1467 - */ 1468 1468 - 204: void; 1469 1469 - }; 1470 1470 - }; 1471 1471 - }; 1472 1472 - '/api/v{api-version}/response': { 1473 1473 - get: { 1474 1474 - res: { 1475 1475 - default: _import; 1476 1476 - }; 1477 1477 - }; 1478 1478 - post: { 1479 1479 - res: { 1480 1480 - /** 1481 1481 - * Message for 200 response 1482 1482 - */ 1483 1483 - 200: ModelWithBoolean & ModelWithInteger; 1484 1484 - /** 1485 1485 - * Message for 201 response 1486 1486 - */ 1487 1487 - 201: ModelWithString; 1488 1488 - /** 1489 1489 - * Message for 202 response 1490 1490 - */ 1491 1491 - 202: ModelWithString; 1492 1492 - /** 1493 1493 - * Message for 500 error 1494 1494 - */ 1495 1495 - 500: ModelWithStringError; 1496 1496 - /** 1497 1497 - * Message for 501 error 1498 1498 - */ 1499 1499 - 501: ModelWithStringError; 1500 1500 - /** 1501 1501 - * Message for 502 error 1502 1502 - */ 1503 1503 - 502: ModelWithStringError; 1504 1504 - /** 1505 1505 - * Message for 4XX errors 1506 1506 - */ 1507 1507 - '4XX': DictionaryWithArray; 1508 1508 - /** 1509 1509 - * Default error response 1510 1510 - */ 1511 1511 - default: ModelWithBoolean; 1512 1512 - }; 1513 1513 - }; 1514 1514 - put: { 1515 1515 - res: { 1516 1516 - /** 1517 1517 - * Message for 200 response 1518 1518 - */ 1519 1519 - 200: { 1520 1520 - readonly '@namespace.string'?: string; 1521 1521 - readonly '@namespace.integer'?: number; 1522 1522 - readonly value?: Array<ModelWithString>; 1523 1523 - }; 1524 1524 - /** 1525 1525 - * Message for 201 response 1526 1526 - */ 1527 1527 - 201: ModelThatExtends; 1528 1528 - /** 1529 1529 - * Message for 202 response 1530 1530 - */ 1531 1531 - 202: ModelThatExtendsExtends; 1532 1532 - /** 1533 1533 - * Message for 500 error 1534 1534 - */ 1535 1535 - 500: ModelWithStringError; 1536 1536 - /** 1537 1537 - * Message for 501 error 1538 1538 - */ 1539 1539 - 501: ModelWithStringError; 1540 1540 - /** 1541 1541 - * Message for 502 error 1542 1542 - */ 1543 1543 - 502: ModelWithStringError; 1544 1544 - /** 1545 1545 - * Message for default response 1546 1546 - */ 1547 1547 - default: ModelWithStringError; 1548 1548 - }; 1549 1549 - }; 1550 1550 - }; 1551 1551 - '/api/v{api-version}/multiple-tags/a': { 1552 1552 - get: { 1553 1553 - res: { 1554 1554 - 200: _400; 1555 1555 - }; 1556 1556 - }; 1557 1557 - }; 1558 1558 - '/api/v{api-version}/multiple-tags/b': { 1559 1559 - get: { 1560 1560 - res: { 1561 1561 - /** 1562 1562 - * Success 1563 1563 - */ 1564 1564 - 204: void; 1565 1565 - }; 1566 1566 - }; 1567 1567 - }; 1568 1568 - '/api/v{api-version}/collectionFormat': { 1569 1569 - get: { 1570 1570 - req: CollectionFormatData; 1571 1571 - }; 1572 1572 - }; 1573 1573 - '/api/v{api-version}/types': { 1574 1574 - get: { 1575 1575 - req: TypesData; 1576 1576 - res: { 1577 1577 - /** 1578 1578 - * Response is a simple number 1579 1579 - */ 1580 1580 - 200: number; 1581 1581 - /** 1582 1582 - * Response is a simple string 1583 1583 - */ 1584 1584 - 201: string; 1585 1585 - /** 1586 1586 - * Response is a simple boolean 1587 1587 - */ 1588 1588 - 202: boolean; 1589 1589 - /** 1590 1590 - * Response is a simple object 1591 1591 - */ 1592 1592 - 203: { 1593 1593 - [key: string]: unknown; 1594 1594 - }; 1595 1595 - }; 1596 1596 - }; 1597 1597 - }; 1598 1598 - '/api/v{api-version}/upload': { 1599 1599 - post: { 1600 1600 - req: UploadFileData; 1601 1601 - res: { 1602 1602 - 200: boolean; 1603 1603 - }; 1604 1604 - }; 1605 1605 - }; 1606 1606 - '/api/v{api-version}/file/{id}': { 1607 1607 - get: { 1608 1608 - req: FileResponseData; 1609 1609 - res: { 1610 1610 - /** 1611 1611 - * Success 1612 1612 - */ 1613 1613 - 200: (Blob | File); 1614 1614 - }; 1615 1615 - }; 1616 1616 - }; 1617 1617 - '/api/v{api-version}/complex': { 1618 1618 - get: { 1619 1619 - req: ComplexTypesData; 1620 1620 - res: { 1621 1621 - /** 1622 1622 - * Successful response 1623 1623 - */ 1624 1624 - 200: Array<ModelWithString>; 1625 1625 - /** 1626 1626 - * 400 `server` error 1627 1627 - */ 1628 1628 - 400: unknown; 1629 1629 - /** 1630 1630 - * 500 server error 1631 1631 - */ 1632 1632 - 500: unknown; 1633 1633 - }; 1634 1634 - }; 1635 1635 - }; 1636 1636 - '/api/v{api-version}/complex/{id}': { 1637 1637 - put: { 1638 1638 - req: ComplexParamsData; 1639 1639 - res: { 1640 1640 - /** 1641 1641 - * Success 1642 1642 - */ 1643 1643 - 200: ModelWithString; 1644 1644 - }; 1645 1645 - }; 1646 1646 - }; 1647 1647 - '/api/v{api-version}/multipart': { 1648 1648 - post: { 1649 1649 - req: MultipartRequestData; 1650 1650 - }; 1651 1651 - get: { 1652 1652 - res: { 1653 1653 - /** 1654 1654 - * OK 1655 1655 - */ 1656 1656 - 200: { 1657 1657 - file?: (Blob | File); 1658 1658 - metadata?: { 1659 1659 - foo?: string; 1660 1660 - bar?: string; 1661 1661 - }; 1662 1662 - }; 1663 1663 - }; 1664 1664 - }; 1665 1665 - }; 1666 1666 - '/api/v{api-version}/header': { 1667 1667 - post: { 1668 1668 - res: { 1669 1669 - /** 1670 1670 - * Successful response 1671 1671 - */ 1672 1672 - 200: string; 1673 1673 - /** 1674 1674 - * 400 server error 1675 1675 - */ 1676 1676 - 400: unknown; 1677 1677 - /** 1678 1678 - * 500 server error 1679 1679 - */ 1680 1680 - 500: unknown; 1681 1681 - }; 1682 1682 - }; 1683 1683 - }; 1684 1684 - '/api/v{api-version}/error': { 1685 1685 - post: { 1686 1686 - req: TestErrorCodeData; 1687 1687 - res: { 1688 1688 - /** 1689 1689 - * Custom message: Successful response 1690 1690 - */ 1691 1691 - 200: unknown; 1692 1692 - /** 1693 1693 - * Custom message: Internal Server Error 1694 1694 - */ 1695 1695 - 500: unknown; 1696 1696 - /** 1697 1697 - * Custom message: Not Implemented 1698 1698 - */ 1699 1699 - 501: unknown; 1700 1700 - /** 1701 1701 - * Custom message: Bad Gateway 1702 1702 - */ 1703 1703 - 502: unknown; 1704 1704 - /** 1705 1705 - * Custom message: Service Unavailable 1706 1706 - */ 1707 1707 - 503: unknown; 1708 1708 - }; 1709 1709 - }; 1710 1710 - }; 1711 1711 - '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串': { 1712 1712 - post: { 1713 1713 - req: NonAsciiæøåÆøÅöôêÊ字符串Data; 1714 1714 - res: { 1715 1715 - /** 1716 1716 - * Successful response 1717 1717 - */ 1718 1718 - 200: Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1719 1719 - }; 1720 1720 - }; 1721 1721 - put: { 1722 1722 - req: PutWithFormUrlEncodedData; 1723 1723 - }; 1724 1724 - }; 1725 1356 };

-69

packages/openapi-ts/test/__snapshots__/test/generated/v3_client_transform/types.gen.ts.snap

··· 46 46 47 47 export type MultipleResponsesResponse = Array<ModelWithDates> | Array<SimpleModel>; 48 48 49 49 - export type $OpenApiTs = { 50 50 - '/api/model-with-dates': { 51 51 - post: { 52 52 - res: { 53 53 - /** 54 54 - * Success 55 55 - */ 56 56 - 200: ParentModelWithDates; 57 57 - /** 58 58 - * Success 59 59 - */ 60 60 - 201: unknown; 61 61 - }; 62 62 - }; 63 63 - put: { 64 64 - res: { 65 65 - /** 66 66 - * Success 67 67 - */ 68 68 - 200: ModelWithDates; 69 69 - }; 70 70 - }; 71 71 - }; 72 72 - '/api/model-with-dates-array': { 73 73 - put: { 74 74 - res: { 75 75 - /** 76 76 - * Success 77 77 - */ 78 78 - 200: Array<ModelWithDates>; 79 79 - }; 80 80 - }; 81 81 - }; 82 82 - '/api/array-of-dates': { 83 83 - put: { 84 84 - res: { 85 85 - /** 86 86 - * Success 87 87 - */ 88 88 - 200: Array<(Date)>; 89 89 - }; 90 90 - }; 91 91 - }; 92 92 - '/api/date': { 93 93 - put: { 94 94 - res: { 95 95 - /** 96 96 - * Success 97 97 - */ 98 98 - 200: Date; 99 99 - }; 100 100 - }; 101 101 - }; 102 102 - '/api/multiple-responses': { 103 103 - put: { 104 104 - res: { 105 105 - /** 106 106 - * Updated 107 107 - */ 108 108 - 200: Array<ModelWithDates>; 109 109 - /** 110 110 - * Created 111 111 - */ 112 112 - 201: Array<SimpleModel>; 113 113 - }; 114 114 - }; 115 115 - }; 116 116 - }; 117 117 - 118 49 export type ParentModelWithDatesResponseTransformer = (data: any) => Promise<ParentModelWithDatesResponse>; 119 50 120 51 export type ParentModelWithDatesModelResponseTransformer = (data: any) => ParentModelWithDates;

-369

packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/types.gen.ts.snap

··· 1432 1432 1433 1433 export type PutWithFormUrlEncodedData = { 1434 1434 formData: ArrayWithStrings; 1435 1435 - }; 1436 1436 - 1437 1437 - export type $OpenApiTs = { 1438 1438 - '/api/v{api-version}/no-tag': { 1439 1439 - post: { 1440 1440 - req: ImportData; 1441 1441 - res: { 1442 1442 - /** 1443 1443 - * Success 1444 1444 - */ 1445 1445 - 200: Model_From_Zendesk; 1446 1446 - /** 1447 1447 - * Default success response 1448 1448 - */ 1449 1449 - default: ModelWithReadOnlyAndWriteOnly; 1450 1450 - }; 1451 1451 - }; 1452 1452 - }; 1453 1453 - '/api/v{api-version}/simple/$count': { 1454 1454 - get: { 1455 1455 - res: { 1456 1456 - /** 1457 1457 - * Success 1458 1458 - */ 1459 1459 - 200: Model_From_Zendesk; 1460 1460 - }; 1461 1461 - }; 1462 1462 - }; 1463 1463 - '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}': { 1464 1464 - delete: { 1465 1465 - req: DeleteFooData3; 1466 1466 - }; 1467 1467 - }; 1468 1468 - '/api/v{api-version}/parameters/{parameterPath}': { 1469 1469 - post: { 1470 1470 - req: CallWithParametersData; 1471 1471 - }; 1472 1472 - }; 1473 1473 - '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}': { 1474 1474 - post: { 1475 1475 - req: CallWithWeirdParameterNamesData; 1476 1476 - }; 1477 1477 - }; 1478 1478 - '/api/v{api-version}/parameters/': { 1479 1479 - get: { 1480 1480 - req: GetCallWithOptionalParamData; 1481 1481 - }; 1482 1482 - post: { 1483 1483 - req: PostCallWithOptionalParamData; 1484 1484 - res: { 1485 1485 - /** 1486 1486 - * Response is a simple number 1487 1487 - */ 1488 1488 - 200: number; 1489 1489 - /** 1490 1490 - * Success 1491 1491 - */ 1492 1492 - 204: void; 1493 1493 - }; 1494 1494 - }; 1495 1495 - }; 1496 1496 - '/api/v{api-version}/descriptions/': { 1497 1497 - post: { 1498 1498 - req: CallWithDescriptionsData; 1499 1499 - }; 1500 1500 - }; 1501 1501 - '/api/v{api-version}/parameters/deprecated': { 1502 1502 - post: { 1503 1503 - req: DeprecatedCallData; 1504 1504 - }; 1505 1505 - }; 1506 1506 - '/api/v{api-version}/requestBody/': { 1507 1507 - post: { 1508 1508 - req: PostApiRequestBodyData; 1509 1509 - }; 1510 1510 - }; 1511 1511 - '/api/v{api-version}/formData/': { 1512 1512 - post: { 1513 1513 - req: PostApiFormDataData; 1514 1514 - }; 1515 1515 - }; 1516 1516 - '/api/v{api-version}/defaults': { 1517 1517 - get: { 1518 1518 - req: CallWithDefaultParametersData; 1519 1519 - }; 1520 1520 - post: { 1521 1521 - req: CallWithDefaultOptionalParametersData; 1522 1522 - }; 1523 1523 - put: { 1524 1524 - req: CallToTestOrderOfParamsData; 1525 1525 - }; 1526 1526 - }; 1527 1527 - '/api/v{api-version}/no-content': { 1528 1528 - get: { 1529 1529 - res: { 1530 1530 - /** 1531 1531 - * Success 1532 1532 - */ 1533 1533 - 204: void; 1534 1534 - }; 1535 1535 - }; 1536 1536 - }; 1537 1537 - '/api/v{api-version}/multiple-tags/response-and-no-content': { 1538 1538 - get: { 1539 1539 - res: { 1540 1540 - /** 1541 1541 - * Response is a simple number 1542 1542 - */ 1543 1543 - 200: number; 1544 1544 - /** 1545 1545 - * Success 1546 1546 - */ 1547 1547 - 204: void; 1548 1548 - }; 1549 1549 - }; 1550 1550 - }; 1551 1551 - '/api/v{api-version}/response': { 1552 1552 - get: { 1553 1553 - res: { 1554 1554 - default: _import; 1555 1555 - }; 1556 1556 - }; 1557 1557 - post: { 1558 1558 - res: { 1559 1559 - /** 1560 1560 - * Message for 200 response 1561 1561 - */ 1562 1562 - 200: ModelWithBoolean & ModelWithInteger; 1563 1563 - /** 1564 1564 - * Message for 201 response 1565 1565 - */ 1566 1566 - 201: ModelWithString; 1567 1567 - /** 1568 1568 - * Message for 202 response 1569 1569 - */ 1570 1570 - 202: ModelWithString; 1571 1571 - /** 1572 1572 - * Message for 500 error 1573 1573 - */ 1574 1574 - 500: ModelWithStringError; 1575 1575 - /** 1576 1576 - * Message for 501 error 1577 1577 - */ 1578 1578 - 501: ModelWithStringError; 1579 1579 - /** 1580 1580 - * Message for 502 error 1581 1581 - */ 1582 1582 - 502: ModelWithStringError; 1583 1583 - /** 1584 1584 - * Message for 4XX errors 1585 1585 - */ 1586 1586 - '4XX': DictionaryWithArray; 1587 1587 - /** 1588 1588 - * Default error response 1589 1589 - */ 1590 1590 - default: ModelWithBoolean; 1591 1591 - }; 1592 1592 - }; 1593 1593 - put: { 1594 1594 - res: { 1595 1595 - /** 1596 1596 - * Message for 200 response 1597 1597 - */ 1598 1598 - 200: { 1599 1599 - readonly '@namespace.string'?: string; 1600 1600 - readonly '@namespace.integer'?: number; 1601 1601 - readonly value?: Array<ModelWithString>; 1602 1602 - }; 1603 1603 - /** 1604 1604 - * Message for 201 response 1605 1605 - */ 1606 1606 - 201: ModelThatExtends; 1607 1607 - /** 1608 1608 - * Message for 202 response 1609 1609 - */ 1610 1610 - 202: ModelThatExtendsExtends; 1611 1611 - /** 1612 1612 - * Message for 500 error 1613 1613 - */ 1614 1614 - 500: ModelWithStringError; 1615 1615 - /** 1616 1616 - * Message for 501 error 1617 1617 - */ 1618 1618 - 501: ModelWithStringError; 1619 1619 - /** 1620 1620 - * Message for 502 error 1621 1621 - */ 1622 1622 - 502: ModelWithStringError; 1623 1623 - /** 1624 1624 - * Message for default response 1625 1625 - */ 1626 1626 - default: ModelWithStringError; 1627 1627 - }; 1628 1628 - }; 1629 1629 - }; 1630 1630 - '/api/v{api-version}/multiple-tags/a': { 1631 1631 - get: { 1632 1632 - res: { 1633 1633 - 200: _400; 1634 1634 - }; 1635 1635 - }; 1636 1636 - }; 1637 1637 - '/api/v{api-version}/multiple-tags/b': { 1638 1638 - get: { 1639 1639 - res: { 1640 1640 - /** 1641 1641 - * Success 1642 1642 - */ 1643 1643 - 204: void; 1644 1644 - }; 1645 1645 - }; 1646 1646 - }; 1647 1647 - '/api/v{api-version}/collectionFormat': { 1648 1648 - get: { 1649 1649 - req: CollectionFormatData; 1650 1650 - }; 1651 1651 - }; 1652 1652 - '/api/v{api-version}/types': { 1653 1653 - get: { 1654 1654 - req: TypesData; 1655 1655 - res: { 1656 1656 - /** 1657 1657 - * Response is a simple number 1658 1658 - */ 1659 1659 - 200: number; 1660 1660 - /** 1661 1661 - * Response is a simple string 1662 1662 - */ 1663 1663 - 201: string; 1664 1664 - /** 1665 1665 - * Response is a simple boolean 1666 1666 - */ 1667 1667 - 202: boolean; 1668 1668 - /** 1669 1669 - * Response is a simple object 1670 1670 - */ 1671 1671 - 203: { 1672 1672 - [key: string]: unknown; 1673 1673 - }; 1674 1674 - }; 1675 1675 - }; 1676 1676 - }; 1677 1677 - '/api/v{api-version}/upload': { 1678 1678 - post: { 1679 1679 - req: UploadFileData; 1680 1680 - res: { 1681 1681 - 200: boolean; 1682 1682 - }; 1683 1683 - }; 1684 1684 - }; 1685 1685 - '/api/v{api-version}/file/{id}': { 1686 1686 - get: { 1687 1687 - req: FileResponseData; 1688 1688 - res: { 1689 1689 - /** 1690 1690 - * Success 1691 1691 - */ 1692 1692 - 200: (Blob | File); 1693 1693 - }; 1694 1694 - }; 1695 1695 - }; 1696 1696 - '/api/v{api-version}/complex': { 1697 1697 - get: { 1698 1698 - req: ComplexTypesData; 1699 1699 - res: { 1700 1700 - /** 1701 1701 - * Successful response 1702 1702 - */ 1703 1703 - 200: Array<ModelWithString>; 1704 1704 - /** 1705 1705 - * 400 `server` error 1706 1706 - */ 1707 1707 - 400: unknown; 1708 1708 - /** 1709 1709 - * 500 server error 1710 1710 - */ 1711 1711 - 500: unknown; 1712 1712 - }; 1713 1713 - }; 1714 1714 - }; 1715 1715 - '/api/v{api-version}/complex/{id}': { 1716 1716 - put: { 1717 1717 - req: ComplexParamsData; 1718 1718 - res: { 1719 1719 - /** 1720 1720 - * Success 1721 1721 - */ 1722 1722 - 200: ModelWithString; 1723 1723 - }; 1724 1724 - }; 1725 1725 - }; 1726 1726 - '/api/v{api-version}/multipart': { 1727 1727 - post: { 1728 1728 - req: MultipartRequestData; 1729 1729 - }; 1730 1730 - get: { 1731 1731 - res: { 1732 1732 - /** 1733 1733 - * OK 1734 1734 - */ 1735 1735 - 200: { 1736 1736 - file?: (Blob | File); 1737 1737 - metadata?: { 1738 1738 - foo?: string; 1739 1739 - bar?: string; 1740 1740 - }; 1741 1741 - }; 1742 1742 - }; 1743 1743 - }; 1744 1744 - }; 1745 1745 - '/api/v{api-version}/header': { 1746 1746 - post: { 1747 1747 - res: { 1748 1748 - /** 1749 1749 - * Successful response 1750 1750 - */ 1751 1751 - 200: string; 1752 1752 - /** 1753 1753 - * 400 server error 1754 1754 - */ 1755 1755 - 400: unknown; 1756 1756 - /** 1757 1757 - * 500 server error 1758 1758 - */ 1759 1759 - 500: unknown; 1760 1760 - }; 1761 1761 - }; 1762 1762 - }; 1763 1763 - '/api/v{api-version}/error': { 1764 1764 - post: { 1765 1765 - req: TestErrorCodeData; 1766 1766 - res: { 1767 1767 - /** 1768 1768 - * Custom message: Successful response 1769 1769 - */ 1770 1770 - 200: unknown; 1771 1771 - /** 1772 1772 - * Custom message: Internal Server Error 1773 1773 - */ 1774 1774 - 500: unknown; 1775 1775 - /** 1776 1776 - * Custom message: Not Implemented 1777 1777 - */ 1778 1778 - 501: unknown; 1779 1779 - /** 1780 1780 - * Custom message: Bad Gateway 1781 1781 - */ 1782 1782 - 502: unknown; 1783 1783 - /** 1784 1784 - * Custom message: Service Unavailable 1785 1785 - */ 1786 1786 - 503: unknown; 1787 1787 - }; 1788 1788 - }; 1789 1789 - }; 1790 1790 - '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串': { 1791 1791 - post: { 1792 1792 - req: NonAsciiæøåÆøÅöôêÊ字符串Data; 1793 1793 - res: { 1794 1794 - /** 1795 1795 - * Successful response 1796 1796 - */ 1797 1797 - 200: Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1798 1798 - }; 1799 1799 - }; 1800 1800 - put: { 1801 1801 - req: PutWithFormUrlEncodedData; 1802 1802 - }; 1803 1803 - }; 1804 1435 };

-369

packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript_namespace/types.gen.ts.snap

··· 1463 1463 1464 1464 export type PutWithFormUrlEncodedData = { 1465 1465 formData: ArrayWithStrings; 1466 1466 - }; 1467 1467 - 1468 1468 - export type $OpenApiTs = { 1469 1469 - '/api/v{api-version}/no-tag': { 1470 1470 - post: { 1471 1471 - req: ImportData; 1472 1472 - res: { 1473 1473 - /** 1474 1474 - * Success 1475 1475 - */ 1476 1476 - 200: Model_From_Zendesk; 1477 1477 - /** 1478 1478 - * Default success response 1479 1479 - */ 1480 1480 - default: ModelWithReadOnlyAndWriteOnly; 1481 1481 - }; 1482 1482 - }; 1483 1483 - }; 1484 1484 - '/api/v{api-version}/simple/$count': { 1485 1485 - get: { 1486 1486 - res: { 1487 1487 - /** 1488 1488 - * Success 1489 1489 - */ 1490 1490 - 200: Model_From_Zendesk; 1491 1491 - }; 1492 1492 - }; 1493 1493 - }; 1494 1494 - '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}': { 1495 1495 - delete: { 1496 1496 - req: DeleteFooData3; 1497 1497 - }; 1498 1498 - }; 1499 1499 - '/api/v{api-version}/parameters/{parameterPath}': { 1500 1500 - post: { 1501 1501 - req: CallWithParametersData; 1502 1502 - }; 1503 1503 - }; 1504 1504 - '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}': { 1505 1505 - post: { 1506 1506 - req: CallWithWeirdParameterNamesData; 1507 1507 - }; 1508 1508 - }; 1509 1509 - '/api/v{api-version}/parameters/': { 1510 1510 - get: { 1511 1511 - req: GetCallWithOptionalParamData; 1512 1512 - }; 1513 1513 - post: { 1514 1514 - req: PostCallWithOptionalParamData; 1515 1515 - res: { 1516 1516 - /** 1517 1517 - * Response is a simple number 1518 1518 - */ 1519 1519 - 200: number; 1520 1520 - /** 1521 1521 - * Success 1522 1522 - */ 1523 1523 - 204: void; 1524 1524 - }; 1525 1525 - }; 1526 1526 - }; 1527 1527 - '/api/v{api-version}/descriptions/': { 1528 1528 - post: { 1529 1529 - req: CallWithDescriptionsData; 1530 1530 - }; 1531 1531 - }; 1532 1532 - '/api/v{api-version}/parameters/deprecated': { 1533 1533 - post: { 1534 1534 - req: DeprecatedCallData; 1535 1535 - }; 1536 1536 - }; 1537 1537 - '/api/v{api-version}/requestBody/': { 1538 1538 - post: { 1539 1539 - req: PostApiRequestBodyData; 1540 1540 - }; 1541 1541 - }; 1542 1542 - '/api/v{api-version}/formData/': { 1543 1543 - post: { 1544 1544 - req: PostApiFormDataData; 1545 1545 - }; 1546 1546 - }; 1547 1547 - '/api/v{api-version}/defaults': { 1548 1548 - get: { 1549 1549 - req: CallWithDefaultParametersData; 1550 1550 - }; 1551 1551 - post: { 1552 1552 - req: CallWithDefaultOptionalParametersData; 1553 1553 - }; 1554 1554 - put: { 1555 1555 - req: CallToTestOrderOfParamsData; 1556 1556 - }; 1557 1557 - }; 1558 1558 - '/api/v{api-version}/no-content': { 1559 1559 - get: { 1560 1560 - res: { 1561 1561 - /** 1562 1562 - * Success 1563 1563 - */ 1564 1564 - 204: void; 1565 1565 - }; 1566 1566 - }; 1567 1567 - }; 1568 1568 - '/api/v{api-version}/multiple-tags/response-and-no-content': { 1569 1569 - get: { 1570 1570 - res: { 1571 1571 - /** 1572 1572 - * Response is a simple number 1573 1573 - */ 1574 1574 - 200: number; 1575 1575 - /** 1576 1576 - * Success 1577 1577 - */ 1578 1578 - 204: void; 1579 1579 - }; 1580 1580 - }; 1581 1581 - }; 1582 1582 - '/api/v{api-version}/response': { 1583 1583 - get: { 1584 1584 - res: { 1585 1585 - default: _import; 1586 1586 - }; 1587 1587 - }; 1588 1588 - post: { 1589 1589 - res: { 1590 1590 - /** 1591 1591 - * Message for 200 response 1592 1592 - */ 1593 1593 - 200: ModelWithBoolean & ModelWithInteger; 1594 1594 - /** 1595 1595 - * Message for 201 response 1596 1596 - */ 1597 1597 - 201: ModelWithString; 1598 1598 - /** 1599 1599 - * Message for 202 response 1600 1600 - */ 1601 1601 - 202: ModelWithString; 1602 1602 - /** 1603 1603 - * Message for 500 error 1604 1604 - */ 1605 1605 - 500: ModelWithStringError; 1606 1606 - /** 1607 1607 - * Message for 501 error 1608 1608 - */ 1609 1609 - 501: ModelWithStringError; 1610 1610 - /** 1611 1611 - * Message for 502 error 1612 1612 - */ 1613 1613 - 502: ModelWithStringError; 1614 1614 - /** 1615 1615 - * Message for 4XX errors 1616 1616 - */ 1617 1617 - '4XX': DictionaryWithArray; 1618 1618 - /** 1619 1619 - * Default error response 1620 1620 - */ 1621 1621 - default: ModelWithBoolean; 1622 1622 - }; 1623 1623 - }; 1624 1624 - put: { 1625 1625 - res: { 1626 1626 - /** 1627 1627 - * Message for 200 response 1628 1628 - */ 1629 1629 - 200: { 1630 1630 - readonly '@namespace.string'?: string; 1631 1631 - readonly '@namespace.integer'?: number; 1632 1632 - readonly value?: Array<ModelWithString>; 1633 1633 - }; 1634 1634 - /** 1635 1635 - * Message for 201 response 1636 1636 - */ 1637 1637 - 201: ModelThatExtends; 1638 1638 - /** 1639 1639 - * Message for 202 response 1640 1640 - */ 1641 1641 - 202: ModelThatExtendsExtends; 1642 1642 - /** 1643 1643 - * Message for 500 error 1644 1644 - */ 1645 1645 - 500: ModelWithStringError; 1646 1646 - /** 1647 1647 - * Message for 501 error 1648 1648 - */ 1649 1649 - 501: ModelWithStringError; 1650 1650 - /** 1651 1651 - * Message for 502 error 1652 1652 - */ 1653 1653 - 502: ModelWithStringError; 1654 1654 - /** 1655 1655 - * Message for default response 1656 1656 - */ 1657 1657 - default: ModelWithStringError; 1658 1658 - }; 1659 1659 - }; 1660 1660 - }; 1661 1661 - '/api/v{api-version}/multiple-tags/a': { 1662 1662 - get: { 1663 1663 - res: { 1664 1664 - 200: _400; 1665 1665 - }; 1666 1666 - }; 1667 1667 - }; 1668 1668 - '/api/v{api-version}/multiple-tags/b': { 1669 1669 - get: { 1670 1670 - res: { 1671 1671 - /** 1672 1672 - * Success 1673 1673 - */ 1674 1674 - 204: void; 1675 1675 - }; 1676 1676 - }; 1677 1677 - }; 1678 1678 - '/api/v{api-version}/collectionFormat': { 1679 1679 - get: { 1680 1680 - req: CollectionFormatData; 1681 1681 - }; 1682 1682 - }; 1683 1683 - '/api/v{api-version}/types': { 1684 1684 - get: { 1685 1685 - req: TypesData; 1686 1686 - res: { 1687 1687 - /** 1688 1688 - * Response is a simple number 1689 1689 - */ 1690 1690 - 200: number; 1691 1691 - /** 1692 1692 - * Response is a simple string 1693 1693 - */ 1694 1694 - 201: string; 1695 1695 - /** 1696 1696 - * Response is a simple boolean 1697 1697 - */ 1698 1698 - 202: boolean; 1699 1699 - /** 1700 1700 - * Response is a simple object 1701 1701 - */ 1702 1702 - 203: { 1703 1703 - [key: string]: unknown; 1704 1704 - }; 1705 1705 - }; 1706 1706 - }; 1707 1707 - }; 1708 1708 - '/api/v{api-version}/upload': { 1709 1709 - post: { 1710 1710 - req: UploadFileData; 1711 1711 - res: { 1712 1712 - 200: boolean; 1713 1713 - }; 1714 1714 - }; 1715 1715 - }; 1716 1716 - '/api/v{api-version}/file/{id}': { 1717 1717 - get: { 1718 1718 - req: FileResponseData; 1719 1719 - res: { 1720 1720 - /** 1721 1721 - * Success 1722 1722 - */ 1723 1723 - 200: (Blob | File); 1724 1724 - }; 1725 1725 - }; 1726 1726 - }; 1727 1727 - '/api/v{api-version}/complex': { 1728 1728 - get: { 1729 1729 - req: ComplexTypesData; 1730 1730 - res: { 1731 1731 - /** 1732 1732 - * Successful response 1733 1733 - */ 1734 1734 - 200: Array<ModelWithString>; 1735 1735 - /** 1736 1736 - * 400 `server` error 1737 1737 - */ 1738 1738 - 400: unknown; 1739 1739 - /** 1740 1740 - * 500 server error 1741 1741 - */ 1742 1742 - 500: unknown; 1743 1743 - }; 1744 1744 - }; 1745 1745 - }; 1746 1746 - '/api/v{api-version}/complex/{id}': { 1747 1747 - put: { 1748 1748 - req: ComplexParamsData; 1749 1749 - res: { 1750 1750 - /** 1751 1751 - * Success 1752 1752 - */ 1753 1753 - 200: ModelWithString; 1754 1754 - }; 1755 1755 - }; 1756 1756 - }; 1757 1757 - '/api/v{api-version}/multipart': { 1758 1758 - post: { 1759 1759 - req: MultipartRequestData; 1760 1760 - }; 1761 1761 - get: { 1762 1762 - res: { 1763 1763 - /** 1764 1764 - * OK 1765 1765 - */ 1766 1766 - 200: { 1767 1767 - file?: (Blob | File); 1768 1768 - metadata?: { 1769 1769 - foo?: string; 1770 1770 - bar?: string; 1771 1771 - }; 1772 1772 - }; 1773 1773 - }; 1774 1774 - }; 1775 1775 - }; 1776 1776 - '/api/v{api-version}/header': { 1777 1777 - post: { 1778 1778 - res: { 1779 1779 - /** 1780 1780 - * Successful response 1781 1781 - */ 1782 1782 - 200: string; 1783 1783 - /** 1784 1784 - * 400 server error 1785 1785 - */ 1786 1786 - 400: unknown; 1787 1787 - /** 1788 1788 - * 500 server error 1789 1789 - */ 1790 1790 - 500: unknown; 1791 1791 - }; 1792 1792 - }; 1793 1793 - }; 1794 1794 - '/api/v{api-version}/error': { 1795 1795 - post: { 1796 1796 - req: TestErrorCodeData; 1797 1797 - res: { 1798 1798 - /** 1799 1799 - * Custom message: Successful response 1800 1800 - */ 1801 1801 - 200: unknown; 1802 1802 - /** 1803 1803 - * Custom message: Internal Server Error 1804 1804 - */ 1805 1805 - 500: unknown; 1806 1806 - /** 1807 1807 - * Custom message: Not Implemented 1808 1808 - */ 1809 1809 - 501: unknown; 1810 1810 - /** 1811 1811 - * Custom message: Bad Gateway 1812 1812 - */ 1813 1813 - 502: unknown; 1814 1814 - /** 1815 1815 - * Custom message: Service Unavailable 1816 1816 - */ 1817 1817 - 503: unknown; 1818 1818 - }; 1819 1819 - }; 1820 1820 - }; 1821 1821 - '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串': { 1822 1822 - post: { 1823 1823 - req: NonAsciiæøåÆøÅöôêÊ字符串Data; 1824 1824 - res: { 1825 1825 - /** 1826 1826 - * Successful response 1827 1827 - */ 1828 1828 - 200: Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1829 1829 - }; 1830 1830 - }; 1831 1831 - put: { 1832 1832 - req: PutWithFormUrlEncodedData; 1833 1833 - }; 1834 1834 - }; 1835 1466 };

-14

packages/openapi-ts/test/__snapshots__/test/generated/v3_legacy_positional_args/types.gen.ts.snap

··· 99 99 * This is a string with no default 100 100 */ 101 101 parameterStringWithNoDefault: string; 102 102 - }; 103 103 - 104 104 - export type $OpenApiTs = { 105 105 - '/api/v{api-version}/defaults': { 106 106 - get: { 107 107 - req: CallWithDefaultParametersData; 108 108 - }; 109 109 - post: { 110 110 - req: CallWithDefaultOptionalParametersData; 111 111 - }; 112 112 - put: { 113 113 - req: CallToTestOrderOfParamsData; 114 114 - }; 115 115 - }; 116 102 };

-369

packages/openapi-ts/test/__snapshots__/test/generated/v3_node/types.gen.ts.snap

··· 1476 1476 1477 1477 export type PutWithFormUrlEncodedData = { 1478 1478 formData: ArrayWithStrings; 1479 1479 - }; 1480 1480 - 1481 1481 - export type $OpenApiTs = { 1482 1482 - '/api/v{api-version}/no-tag': { 1483 1483 - post: { 1484 1484 - req: ImportData; 1485 1485 - res: { 1486 1486 - /** 1487 1487 - * Success 1488 1488 - */ 1489 1489 - 200: Model_From_Zendesk; 1490 1490 - /** 1491 1491 - * Default success response 1492 1492 - */ 1493 1493 - default: ModelWithReadOnlyAndWriteOnly; 1494 1494 - }; 1495 1495 - }; 1496 1496 - }; 1497 1497 - '/api/v{api-version}/simple/$count': { 1498 1498 - get: { 1499 1499 - res: { 1500 1500 - /** 1501 1501 - * Success 1502 1502 - */ 1503 1503 - 200: Model_From_Zendesk; 1504 1504 - }; 1505 1505 - }; 1506 1506 - }; 1507 1507 - '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}': { 1508 1508 - delete: { 1509 1509 - req: DeleteFooData3; 1510 1510 - }; 1511 1511 - }; 1512 1512 - '/api/v{api-version}/parameters/{parameterPath}': { 1513 1513 - post: { 1514 1514 - req: CallWithParametersData; 1515 1515 - }; 1516 1516 - }; 1517 1517 - '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}': { 1518 1518 - post: { 1519 1519 - req: CallWithWeirdParameterNamesData; 1520 1520 - }; 1521 1521 - }; 1522 1522 - '/api/v{api-version}/parameters/': { 1523 1523 - get: { 1524 1524 - req: GetCallWithOptionalParamData; 1525 1525 - }; 1526 1526 - post: { 1527 1527 - req: PostCallWithOptionalParamData; 1528 1528 - res: { 1529 1529 - /** 1530 1530 - * Response is a simple number 1531 1531 - */ 1532 1532 - 200: number; 1533 1533 - /** 1534 1534 - * Success 1535 1535 - */ 1536 1536 - 204: void; 1537 1537 - }; 1538 1538 - }; 1539 1539 - }; 1540 1540 - '/api/v{api-version}/descriptions/': { 1541 1541 - post: { 1542 1542 - req: CallWithDescriptionsData; 1543 1543 - }; 1544 1544 - }; 1545 1545 - '/api/v{api-version}/parameters/deprecated': { 1546 1546 - post: { 1547 1547 - req: DeprecatedCallData; 1548 1548 - }; 1549 1549 - }; 1550 1550 - '/api/v{api-version}/requestBody/': { 1551 1551 - post: { 1552 1552 - req: PostApiRequestBodyData; 1553 1553 - }; 1554 1554 - }; 1555 1555 - '/api/v{api-version}/formData/': { 1556 1556 - post: { 1557 1557 - req: PostApiFormDataData; 1558 1558 - }; 1559 1559 - }; 1560 1560 - '/api/v{api-version}/defaults': { 1561 1561 - get: { 1562 1562 - req: CallWithDefaultParametersData; 1563 1563 - }; 1564 1564 - post: { 1565 1565 - req: CallWithDefaultOptionalParametersData; 1566 1566 - }; 1567 1567 - put: { 1568 1568 - req: CallToTestOrderOfParamsData; 1569 1569 - }; 1570 1570 - }; 1571 1571 - '/api/v{api-version}/no-content': { 1572 1572 - get: { 1573 1573 - res: { 1574 1574 - /** 1575 1575 - * Success 1576 1576 - */ 1577 1577 - 204: void; 1578 1578 - }; 1579 1579 - }; 1580 1580 - }; 1581 1581 - '/api/v{api-version}/multiple-tags/response-and-no-content': { 1582 1582 - get: { 1583 1583 - res: { 1584 1584 - /** 1585 1585 - * Response is a simple number 1586 1586 - */ 1587 1587 - 200: number; 1588 1588 - /** 1589 1589 - * Success 1590 1590 - */ 1591 1591 - 204: void; 1592 1592 - }; 1593 1593 - }; 1594 1594 - }; 1595 1595 - '/api/v{api-version}/response': { 1596 1596 - get: { 1597 1597 - res: { 1598 1598 - default: _import; 1599 1599 - }; 1600 1600 - }; 1601 1601 - post: { 1602 1602 - res: { 1603 1603 - /** 1604 1604 - * Message for 200 response 1605 1605 - */ 1606 1606 - 200: ModelWithBoolean & ModelWithInteger; 1607 1607 - /** 1608 1608 - * Message for 201 response 1609 1609 - */ 1610 1610 - 201: ModelWithString; 1611 1611 - /** 1612 1612 - * Message for 202 response 1613 1613 - */ 1614 1614 - 202: ModelWithString; 1615 1615 - /** 1616 1616 - * Message for 500 error 1617 1617 - */ 1618 1618 - 500: ModelWithStringError; 1619 1619 - /** 1620 1620 - * Message for 501 error 1621 1621 - */ 1622 1622 - 501: ModelWithStringError; 1623 1623 - /** 1624 1624 - * Message for 502 error 1625 1625 - */ 1626 1626 - 502: ModelWithStringError; 1627 1627 - /** 1628 1628 - * Message for 4XX errors 1629 1629 - */ 1630 1630 - '4XX': DictionaryWithArray; 1631 1631 - /** 1632 1632 - * Default error response 1633 1633 - */ 1634 1634 - default: ModelWithBoolean; 1635 1635 - }; 1636 1636 - }; 1637 1637 - put: { 1638 1638 - res: { 1639 1639 - /** 1640 1640 - * Message for 200 response 1641 1641 - */ 1642 1642 - 200: { 1643 1643 - readonly '@namespace.string'?: string; 1644 1644 - readonly '@namespace.integer'?: number; 1645 1645 - readonly value?: Array<ModelWithString>; 1646 1646 - }; 1647 1647 - /** 1648 1648 - * Message for 201 response 1649 1649 - */ 1650 1650 - 201: ModelThatExtends; 1651 1651 - /** 1652 1652 - * Message for 202 response 1653 1653 - */ 1654 1654 - 202: ModelThatExtendsExtends; 1655 1655 - /** 1656 1656 - * Message for 500 error 1657 1657 - */ 1658 1658 - 500: ModelWithStringError; 1659 1659 - /** 1660 1660 - * Message for 501 error 1661 1661 - */ 1662 1662 - 501: ModelWithStringError; 1663 1663 - /** 1664 1664 - * Message for 502 error 1665 1665 - */ 1666 1666 - 502: ModelWithStringError; 1667 1667 - /** 1668 1668 - * Message for default response 1669 1669 - */ 1670 1670 - default: ModelWithStringError; 1671 1671 - }; 1672 1672 - }; 1673 1673 - }; 1674 1674 - '/api/v{api-version}/multiple-tags/a': { 1675 1675 - get: { 1676 1676 - res: { 1677 1677 - 200: _400; 1678 1678 - }; 1679 1679 - }; 1680 1680 - }; 1681 1681 - '/api/v{api-version}/multiple-tags/b': { 1682 1682 - get: { 1683 1683 - res: { 1684 1684 - /** 1685 1685 - * Success 1686 1686 - */ 1687 1687 - 204: void; 1688 1688 - }; 1689 1689 - }; 1690 1690 - }; 1691 1691 - '/api/v{api-version}/collectionFormat': { 1692 1692 - get: { 1693 1693 - req: CollectionFormatData; 1694 1694 - }; 1695 1695 - }; 1696 1696 - '/api/v{api-version}/types': { 1697 1697 - get: { 1698 1698 - req: TypesData; 1699 1699 - res: { 1700 1700 - /** 1701 1701 - * Response is a simple number 1702 1702 - */ 1703 1703 - 200: number; 1704 1704 - /** 1705 1705 - * Response is a simple string 1706 1706 - */ 1707 1707 - 201: string; 1708 1708 - /** 1709 1709 - * Response is a simple boolean 1710 1710 - */ 1711 1711 - 202: boolean; 1712 1712 - /** 1713 1713 - * Response is a simple object 1714 1714 - */ 1715 1715 - 203: { 1716 1716 - [key: string]: unknown; 1717 1717 - }; 1718 1718 - }; 1719 1719 - }; 1720 1720 - }; 1721 1721 - '/api/v{api-version}/upload': { 1722 1722 - post: { 1723 1723 - req: UploadFileData; 1724 1724 - res: { 1725 1725 - 200: boolean; 1726 1726 - }; 1727 1727 - }; 1728 1728 - }; 1729 1729 - '/api/v{api-version}/file/{id}': { 1730 1730 - get: { 1731 1731 - req: FileResponseData; 1732 1732 - res: { 1733 1733 - /** 1734 1734 - * Success 1735 1735 - */ 1736 1736 - 200: (Blob | File); 1737 1737 - }; 1738 1738 - }; 1739 1739 - }; 1740 1740 - '/api/v{api-version}/complex': { 1741 1741 - get: { 1742 1742 - req: ComplexTypesData; 1743 1743 - res: { 1744 1744 - /** 1745 1745 - * Successful response 1746 1746 - */ 1747 1747 - 200: Array<ModelWithString>; 1748 1748 - /** 1749 1749 - * 400 `server` error 1750 1750 - */ 1751 1751 - 400: unknown; 1752 1752 - /** 1753 1753 - * 500 server error 1754 1754 - */ 1755 1755 - 500: unknown; 1756 1756 - }; 1757 1757 - }; 1758 1758 - }; 1759 1759 - '/api/v{api-version}/complex/{id}': { 1760 1760 - put: { 1761 1761 - req: ComplexParamsData; 1762 1762 - res: { 1763 1763 - /** 1764 1764 - * Success 1765 1765 - */ 1766 1766 - 200: ModelWithString; 1767 1767 - }; 1768 1768 - }; 1769 1769 - }; 1770 1770 - '/api/v{api-version}/multipart': { 1771 1771 - post: { 1772 1772 - req: MultipartRequestData; 1773 1773 - }; 1774 1774 - get: { 1775 1775 - res: { 1776 1776 - /** 1777 1777 - * OK 1778 1778 - */ 1779 1779 - 200: { 1780 1780 - file?: (Blob | File); 1781 1781 - metadata?: { 1782 1782 - foo?: string; 1783 1783 - bar?: string; 1784 1784 - }; 1785 1785 - }; 1786 1786 - }; 1787 1787 - }; 1788 1788 - }; 1789 1789 - '/api/v{api-version}/header': { 1790 1790 - post: { 1791 1791 - res: { 1792 1792 - /** 1793 1793 - * Successful response 1794 1794 - */ 1795 1795 - 200: string; 1796 1796 - /** 1797 1797 - * 400 server error 1798 1798 - */ 1799 1799 - 400: unknown; 1800 1800 - /** 1801 1801 - * 500 server error 1802 1802 - */ 1803 1803 - 500: unknown; 1804 1804 - }; 1805 1805 - }; 1806 1806 - }; 1807 1807 - '/api/v{api-version}/error': { 1808 1808 - post: { 1809 1809 - req: TestErrorCodeData; 1810 1810 - res: { 1811 1811 - /** 1812 1812 - * Custom message: Successful response 1813 1813 - */ 1814 1814 - 200: unknown; 1815 1815 - /** 1816 1816 - * Custom message: Internal Server Error 1817 1817 - */ 1818 1818 - 500: unknown; 1819 1819 - /** 1820 1820 - * Custom message: Not Implemented 1821 1821 - */ 1822 1822 - 501: unknown; 1823 1823 - /** 1824 1824 - * Custom message: Bad Gateway 1825 1825 - */ 1826 1826 - 502: unknown; 1827 1827 - /** 1828 1828 - * Custom message: Service Unavailable 1829 1829 - */ 1830 1830 - 503: unknown; 1831 1831 - }; 1832 1832 - }; 1833 1833 - }; 1834 1834 - '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串': { 1835 1835 - post: { 1836 1836 - req: NonAsciiæøåÆøÅöôêÊ字符串Data; 1837 1837 - res: { 1838 1838 - /** 1839 1839 - * Successful response 1840 1840 - */ 1841 1841 - 200: Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1842 1842 - }; 1843 1843 - }; 1844 1844 - put: { 1845 1845 - req: PutWithFormUrlEncodedData; 1846 1846 - }; 1847 1847 - }; 1848 1479 };

-69

packages/openapi-ts/test/__snapshots__/test/generated/v3_node_transform/types.gen.ts.snap

··· 46 46 47 47 export type MultipleResponsesResponse = Array<ModelWithDates> | Array<SimpleModel>; 48 48 49 49 - export type $OpenApiTs = { 50 50 - '/api/model-with-dates': { 51 51 - post: { 52 52 - res: { 53 53 - /** 54 54 - * Success 55 55 - */ 56 56 - 200: ParentModelWithDates; 57 57 - /** 58 58 - * Success 59 59 - */ 60 60 - 201: unknown; 61 61 - }; 62 62 - }; 63 63 - put: { 64 64 - res: { 65 65 - /** 66 66 - * Success 67 67 - */ 68 68 - 200: ModelWithDates; 69 69 - }; 70 70 - }; 71 71 - }; 72 72 - '/api/model-with-dates-array': { 73 73 - put: { 74 74 - res: { 75 75 - /** 76 76 - * Success 77 77 - */ 78 78 - 200: Array<ModelWithDates>; 79 79 - }; 80 80 - }; 81 81 - }; 82 82 - '/api/array-of-dates': { 83 83 - put: { 84 84 - res: { 85 85 - /** 86 86 - * Success 87 87 - */ 88 88 - 200: Array<(Date)>; 89 89 - }; 90 90 - }; 91 91 - }; 92 92 - '/api/date': { 93 93 - put: { 94 94 - res: { 95 95 - /** 96 96 - * Success 97 97 - */ 98 98 - 200: Date; 99 99 - }; 100 100 - }; 101 101 - }; 102 102 - '/api/multiple-responses': { 103 103 - put: { 104 104 - res: { 105 105 - /** 106 106 - * Updated 107 107 - */ 108 108 - 200: Array<ModelWithDates>; 109 109 - /** 110 110 - * Created 111 111 - */ 112 112 - 201: Array<SimpleModel>; 113 113 - }; 114 114 - }; 115 115 - }; 116 116 - }; 117 117 - 118 49 export type ParentModelWithDatesResponseTransformer = (data: any) => Promise<ParentModelWithDatesResponse>; 119 50 120 51 export type ParentModelWithDatesModelResponseTransformer = (data: any) => ParentModelWithDates;

-14

packages/openapi-ts/test/__snapshots__/test/generated/v3_options/types.gen.ts.snap

··· 99 99 * This is a string with no default 100 100 */ 101 101 parameterStringWithNoDefault: string; 102 102 - }; 103 103 - 104 104 - export type $OpenApiTs = { 105 105 - '/api/v{api-version}/defaults': { 106 106 - get: { 107 107 - req: CallWithDefaultParametersData; 108 108 - }; 109 109 - post: { 110 110 - req: CallWithDefaultOptionalParametersData; 111 111 - }; 112 112 - put: { 113 113 - req: CallToTestOrderOfParamsData; 114 114 - }; 115 115 - }; 116 102 };

+1 -47

packages/openapi-ts/test/__snapshots__/test/generated/v3_services_name/types.gen.ts.snap

··· 1156 1156 }; 1157 1157 }; 1158 1158 1159 1159 - export type PostCallWithOptionalParamResponse = number | void; 1160 1160 - 1161 1161 - export type $OpenApiTs = { 1162 1162 - '/api/v{api-version}/simple/$count': { 1163 1163 - get: { 1164 1164 - res: { 1165 1165 - /** 1166 1166 - * Success 1167 1167 - */ 1168 1168 - 200: Model_From_Zendesk; 1169 1169 - }; 1170 1170 - }; 1171 1171 - }; 1172 1172 - '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}': { 1173 1173 - delete: { 1174 1174 - req: DeleteFooData3; 1175 1175 - }; 1176 1176 - }; 1177 1177 - '/api/v{api-version}/parameters/{parameterPath}': { 1178 1178 - post: { 1179 1179 - req: CallWithParametersData; 1180 1180 - }; 1181 1181 - }; 1182 1182 - '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}': { 1183 1183 - post: { 1184 1184 - req: CallWithWeirdParameterNamesData; 1185 1185 - }; 1186 1186 - }; 1187 1187 - '/api/v{api-version}/parameters/': { 1188 1188 - get: { 1189 1189 - req: GetCallWithOptionalParamData; 1190 1190 - }; 1191 1191 - post: { 1192 1192 - req: PostCallWithOptionalParamData; 1193 1193 - res: { 1194 1194 - /** 1195 1195 - * Response is a simple number 1196 1196 - */ 1197 1197 - 200: number; 1198 1198 - /** 1199 1199 - * Success 1200 1200 - */ 1201 1201 - 204: void; 1202 1202 - }; 1203 1203 - }; 1204 1204 - }; 1205 1205 - }; 1159 1159 + export type PostCallWithOptionalParamResponse = number | void;

-69

packages/openapi-ts/test/__snapshots__/test/generated/v3_transform/types.gen.ts.snap

··· 46 46 47 47 export type MultipleResponsesResponse = Array<ModelWithDates> | Array<SimpleModel>; 48 48 49 49 - export type $OpenApiTs = { 50 50 - '/api/model-with-dates': { 51 51 - post: { 52 52 - res: { 53 53 - /** 54 54 - * Success 55 55 - */ 56 56 - 200: ParentModelWithDates; 57 57 - /** 58 58 - * Success 59 59 - */ 60 60 - 201: unknown; 61 61 - }; 62 62 - }; 63 63 - put: { 64 64 - res: { 65 65 - /** 66 66 - * Success 67 67 - */ 68 68 - 200: ModelWithDates; 69 69 - }; 70 70 - }; 71 71 - }; 72 72 - '/api/model-with-dates-array': { 73 73 - put: { 74 74 - res: { 75 75 - /** 76 76 - * Success 77 77 - */ 78 78 - 200: Array<ModelWithDates>; 79 79 - }; 80 80 - }; 81 81 - }; 82 82 - '/api/array-of-dates': { 83 83 - put: { 84 84 - res: { 85 85 - /** 86 86 - * Success 87 87 - */ 88 88 - 200: Array<(Date)>; 89 89 - }; 90 90 - }; 91 91 - }; 92 92 - '/api/date': { 93 93 - put: { 94 94 - res: { 95 95 - /** 96 96 - * Success 97 97 - */ 98 98 - 200: Date; 99 99 - }; 100 100 - }; 101 101 - }; 102 102 - '/api/multiple-responses': { 103 103 - put: { 104 104 - res: { 105 105 - /** 106 106 - * Updated 107 107 - */ 108 108 - 200: Array<ModelWithDates>; 109 109 - /** 110 110 - * Created 111 111 - */ 112 112 - 201: Array<SimpleModel>; 113 113 - }; 114 114 - }; 115 115 - }; 116 116 - }; 117 117 - 118 49 export type ParentModelWithDatesResponseTransformer = (data: any) => Promise<ParentModelWithDatesResponse>; 119 50 120 51 export type ParentModelWithDatesModelResponseTransformer = (data: any) => ParentModelWithDates;

-369

packages/openapi-ts/test/__snapshots__/test/generated/v3_tree_shakeable/types.gen.ts.snap

··· 1476 1476 1477 1477 export type PutWithFormUrlEncodedData = { 1478 1478 formData: ArrayWithStrings; 1479 1479 - }; 1480 1480 - 1481 1481 - export type $OpenApiTs = { 1482 1482 - '/api/v{api-version}/no-tag': { 1483 1483 - post: { 1484 1484 - req: ImportData; 1485 1485 - res: { 1486 1486 - /** 1487 1487 - * Success 1488 1488 - */ 1489 1489 - 200: Model_From_Zendesk; 1490 1490 - /** 1491 1491 - * Default success response 1492 1492 - */ 1493 1493 - default: ModelWithReadOnlyAndWriteOnly; 1494 1494 - }; 1495 1495 - }; 1496 1496 - }; 1497 1497 - '/api/v{api-version}/simple/$count': { 1498 1498 - get: { 1499 1499 - res: { 1500 1500 - /** 1501 1501 - * Success 1502 1502 - */ 1503 1503 - 200: Model_From_Zendesk; 1504 1504 - }; 1505 1505 - }; 1506 1506 - }; 1507 1507 - '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}': { 1508 1508 - delete: { 1509 1509 - req: DeleteFooData3; 1510 1510 - }; 1511 1511 - }; 1512 1512 - '/api/v{api-version}/descriptions/': { 1513 1513 - post: { 1514 1514 - req: CallWithDescriptionsData; 1515 1515 - }; 1516 1516 - }; 1517 1517 - '/api/v{api-version}/parameters/deprecated': { 1518 1518 - post: { 1519 1519 - req: DeprecatedCallData; 1520 1520 - }; 1521 1521 - }; 1522 1522 - '/api/v{api-version}/parameters/{parameterPath}': { 1523 1523 - post: { 1524 1524 - req: CallWithParametersData; 1525 1525 - }; 1526 1526 - }; 1527 1527 - '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}': { 1528 1528 - post: { 1529 1529 - req: CallWithWeirdParameterNamesData; 1530 1530 - }; 1531 1531 - }; 1532 1532 - '/api/v{api-version}/parameters/': { 1533 1533 - get: { 1534 1534 - req: GetCallWithOptionalParamData; 1535 1535 - }; 1536 1536 - post: { 1537 1537 - req: PostCallWithOptionalParamData; 1538 1538 - res: { 1539 1539 - /** 1540 1540 - * Response is a simple number 1541 1541 - */ 1542 1542 - 200: number; 1543 1543 - /** 1544 1544 - * Success 1545 1545 - */ 1546 1546 - 204: void; 1547 1547 - }; 1548 1548 - }; 1549 1549 - }; 1550 1550 - '/api/v{api-version}/requestBody/': { 1551 1551 - post: { 1552 1552 - req: PostApiRequestBodyData; 1553 1553 - }; 1554 1554 - }; 1555 1555 - '/api/v{api-version}/formData/': { 1556 1556 - post: { 1557 1557 - req: PostApiFormDataData; 1558 1558 - }; 1559 1559 - }; 1560 1560 - '/api/v{api-version}/defaults': { 1561 1561 - get: { 1562 1562 - req: CallWithDefaultParametersData; 1563 1563 - }; 1564 1564 - post: { 1565 1565 - req: CallWithDefaultOptionalParametersData; 1566 1566 - }; 1567 1567 - put: { 1568 1568 - req: CallToTestOrderOfParamsData; 1569 1569 - }; 1570 1570 - }; 1571 1571 - '/api/v{api-version}/no-content': { 1572 1572 - get: { 1573 1573 - res: { 1574 1574 - /** 1575 1575 - * Success 1576 1576 - */ 1577 1577 - 204: void; 1578 1578 - }; 1579 1579 - }; 1580 1580 - }; 1581 1581 - '/api/v{api-version}/multiple-tags/response-and-no-content': { 1582 1582 - get: { 1583 1583 - res: { 1584 1584 - /** 1585 1585 - * Response is a simple number 1586 1586 - */ 1587 1587 - 200: number; 1588 1588 - /** 1589 1589 - * Success 1590 1590 - */ 1591 1591 - 204: void; 1592 1592 - }; 1593 1593 - }; 1594 1594 - }; 1595 1595 - '/api/v{api-version}/multiple-tags/a': { 1596 1596 - get: { 1597 1597 - res: { 1598 1598 - 200: _400; 1599 1599 - }; 1600 1600 - }; 1601 1601 - }; 1602 1602 - '/api/v{api-version}/multiple-tags/b': { 1603 1603 - get: { 1604 1604 - res: { 1605 1605 - /** 1606 1606 - * Success 1607 1607 - */ 1608 1608 - 204: void; 1609 1609 - }; 1610 1610 - }; 1611 1611 - }; 1612 1612 - '/api/v{api-version}/response': { 1613 1613 - get: { 1614 1614 - res: { 1615 1615 - default: _import; 1616 1616 - }; 1617 1617 - }; 1618 1618 - post: { 1619 1619 - res: { 1620 1620 - /** 1621 1621 - * Message for 200 response 1622 1622 - */ 1623 1623 - 200: ModelWithBoolean & ModelWithInteger; 1624 1624 - /** 1625 1625 - * Message for 201 response 1626 1626 - */ 1627 1627 - 201: ModelWithString; 1628 1628 - /** 1629 1629 - * Message for 202 response 1630 1630 - */ 1631 1631 - 202: ModelWithString; 1632 1632 - /** 1633 1633 - * Message for 500 error 1634 1634 - */ 1635 1635 - 500: ModelWithStringError; 1636 1636 - /** 1637 1637 - * Message for 501 error 1638 1638 - */ 1639 1639 - 501: ModelWithStringError; 1640 1640 - /** 1641 1641 - * Message for 502 error 1642 1642 - */ 1643 1643 - 502: ModelWithStringError; 1644 1644 - /** 1645 1645 - * Message for 4XX errors 1646 1646 - */ 1647 1647 - '4XX': DictionaryWithArray; 1648 1648 - /** 1649 1649 - * Default error response 1650 1650 - */ 1651 1651 - default: ModelWithBoolean; 1652 1652 - }; 1653 1653 - }; 1654 1654 - put: { 1655 1655 - res: { 1656 1656 - /** 1657 1657 - * Message for 200 response 1658 1658 - */ 1659 1659 - 200: { 1660 1660 - readonly '@namespace.string'?: string; 1661 1661 - readonly '@namespace.integer'?: number; 1662 1662 - readonly value?: Array<ModelWithString>; 1663 1663 - }; 1664 1664 - /** 1665 1665 - * Message for 201 response 1666 1666 - */ 1667 1667 - 201: ModelThatExtends; 1668 1668 - /** 1669 1669 - * Message for 202 response 1670 1670 - */ 1671 1671 - 202: ModelThatExtendsExtends; 1672 1672 - /** 1673 1673 - * Message for 500 error 1674 1674 - */ 1675 1675 - 500: ModelWithStringError; 1676 1676 - /** 1677 1677 - * Message for 501 error 1678 1678 - */ 1679 1679 - 501: ModelWithStringError; 1680 1680 - /** 1681 1681 - * Message for 502 error 1682 1682 - */ 1683 1683 - 502: ModelWithStringError; 1684 1684 - /** 1685 1685 - * Message for default response 1686 1686 - */ 1687 1687 - default: ModelWithStringError; 1688 1688 - }; 1689 1689 - }; 1690 1690 - }; 1691 1691 - '/api/v{api-version}/collectionFormat': { 1692 1692 - get: { 1693 1693 - req: CollectionFormatData; 1694 1694 - }; 1695 1695 - }; 1696 1696 - '/api/v{api-version}/types': { 1697 1697 - get: { 1698 1698 - req: TypesData; 1699 1699 - res: { 1700 1700 - /** 1701 1701 - * Response is a simple number 1702 1702 - */ 1703 1703 - 200: number; 1704 1704 - /** 1705 1705 - * Response is a simple string 1706 1706 - */ 1707 1707 - 201: string; 1708 1708 - /** 1709 1709 - * Response is a simple boolean 1710 1710 - */ 1711 1711 - 202: boolean; 1712 1712 - /** 1713 1713 - * Response is a simple object 1714 1714 - */ 1715 1715 - 203: { 1716 1716 - [key: string]: unknown; 1717 1717 - }; 1718 1718 - }; 1719 1719 - }; 1720 1720 - }; 1721 1721 - '/api/v{api-version}/upload': { 1722 1722 - post: { 1723 1723 - req: UploadFileData; 1724 1724 - res: { 1725 1725 - 200: boolean; 1726 1726 - }; 1727 1727 - }; 1728 1728 - }; 1729 1729 - '/api/v{api-version}/file/{id}': { 1730 1730 - get: { 1731 1731 - req: FileResponseData; 1732 1732 - res: { 1733 1733 - /** 1734 1734 - * Success 1735 1735 - */ 1736 1736 - 200: (Blob | File); 1737 1737 - }; 1738 1738 - }; 1739 1739 - }; 1740 1740 - '/api/v{api-version}/complex': { 1741 1741 - get: { 1742 1742 - req: ComplexTypesData; 1743 1743 - res: { 1744 1744 - /** 1745 1745 - * Successful response 1746 1746 - */ 1747 1747 - 200: Array<ModelWithString>; 1748 1748 - /** 1749 1749 - * 400 `server` error 1750 1750 - */ 1751 1751 - 400: unknown; 1752 1752 - /** 1753 1753 - * 500 server error 1754 1754 - */ 1755 1755 - 500: unknown; 1756 1756 - }; 1757 1757 - }; 1758 1758 - }; 1759 1759 - '/api/v{api-version}/multipart': { 1760 1760 - post: { 1761 1761 - req: MultipartRequestData; 1762 1762 - }; 1763 1763 - get: { 1764 1764 - res: { 1765 1765 - /** 1766 1766 - * OK 1767 1767 - */ 1768 1768 - 200: { 1769 1769 - file?: (Blob | File); 1770 1770 - metadata?: { 1771 1771 - foo?: string; 1772 1772 - bar?: string; 1773 1773 - }; 1774 1774 - }; 1775 1775 - }; 1776 1776 - }; 1777 1777 - }; 1778 1778 - '/api/v{api-version}/complex/{id}': { 1779 1779 - put: { 1780 1780 - req: ComplexParamsData; 1781 1781 - res: { 1782 1782 - /** 1783 1783 - * Success 1784 1784 - */ 1785 1785 - 200: ModelWithString; 1786 1786 - }; 1787 1787 - }; 1788 1788 - }; 1789 1789 - '/api/v{api-version}/header': { 1790 1790 - post: { 1791 1791 - res: { 1792 1792 - /** 1793 1793 - * Successful response 1794 1794 - */ 1795 1795 - 200: string; 1796 1796 - /** 1797 1797 - * 400 server error 1798 1798 - */ 1799 1799 - 400: unknown; 1800 1800 - /** 1801 1801 - * 500 server error 1802 1802 - */ 1803 1803 - 500: unknown; 1804 1804 - }; 1805 1805 - }; 1806 1806 - }; 1807 1807 - '/api/v{api-version}/error': { 1808 1808 - post: { 1809 1809 - req: TestErrorCodeData; 1810 1810 - res: { 1811 1811 - /** 1812 1812 - * Custom message: Successful response 1813 1813 - */ 1814 1814 - 200: unknown; 1815 1815 - /** 1816 1816 - * Custom message: Internal Server Error 1817 1817 - */ 1818 1818 - 500: unknown; 1819 1819 - /** 1820 1820 - * Custom message: Not Implemented 1821 1821 - */ 1822 1822 - 501: unknown; 1823 1823 - /** 1824 1824 - * Custom message: Bad Gateway 1825 1825 - */ 1826 1826 - 502: unknown; 1827 1827 - /** 1828 1828 - * Custom message: Service Unavailable 1829 1829 - */ 1830 1830 - 503: unknown; 1831 1831 - }; 1832 1832 - }; 1833 1833 - }; 1834 1834 - '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串': { 1835 1835 - post: { 1836 1836 - req: NonAsciiæøåÆøÅöôêÊ字符串Data; 1837 1837 - res: { 1838 1838 - /** 1839 1839 - * Successful response 1840 1840 - */ 1841 1841 - 200: Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1842 1842 - }; 1843 1843 - }; 1844 1844 - put: { 1845 1845 - req: PutWithFormUrlEncodedData; 1846 1846 - }; 1847 1847 - }; 1848 1479 };

-369

packages/openapi-ts/test/__snapshots__/test/generated/v3_xhr/types.gen.ts.snap

··· 1476 1476 1477 1477 export type PutWithFormUrlEncodedData = { 1478 1478 formData: ArrayWithStrings; 1479 1479 - }; 1480 1480 - 1481 1481 - export type $OpenApiTs = { 1482 1482 - '/api/v{api-version}/no-tag': { 1483 1483 - post: { 1484 1484 - req: ImportData; 1485 1485 - res: { 1486 1486 - /** 1487 1487 - * Success 1488 1488 - */ 1489 1489 - 200: Model_From_Zendesk; 1490 1490 - /** 1491 1491 - * Default success response 1492 1492 - */ 1493 1493 - default: ModelWithReadOnlyAndWriteOnly; 1494 1494 - }; 1495 1495 - }; 1496 1496 - }; 1497 1497 - '/api/v{api-version}/simple/$count': { 1498 1498 - get: { 1499 1499 - res: { 1500 1500 - /** 1501 1501 - * Success 1502 1502 - */ 1503 1503 - 200: Model_From_Zendesk; 1504 1504 - }; 1505 1505 - }; 1506 1506 - }; 1507 1507 - '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}': { 1508 1508 - delete: { 1509 1509 - req: DeleteFooData3; 1510 1510 - }; 1511 1511 - }; 1512 1512 - '/api/v{api-version}/parameters/{parameterPath}': { 1513 1513 - post: { 1514 1514 - req: CallWithParametersData; 1515 1515 - }; 1516 1516 - }; 1517 1517 - '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}': { 1518 1518 - post: { 1519 1519 - req: CallWithWeirdParameterNamesData; 1520 1520 - }; 1521 1521 - }; 1522 1522 - '/api/v{api-version}/parameters/': { 1523 1523 - get: { 1524 1524 - req: GetCallWithOptionalParamData; 1525 1525 - }; 1526 1526 - post: { 1527 1527 - req: PostCallWithOptionalParamData; 1528 1528 - res: { 1529 1529 - /** 1530 1530 - * Response is a simple number 1531 1531 - */ 1532 1532 - 200: number; 1533 1533 - /** 1534 1534 - * Success 1535 1535 - */ 1536 1536 - 204: void; 1537 1537 - }; 1538 1538 - }; 1539 1539 - }; 1540 1540 - '/api/v{api-version}/descriptions/': { 1541 1541 - post: { 1542 1542 - req: CallWithDescriptionsData; 1543 1543 - }; 1544 1544 - }; 1545 1545 - '/api/v{api-version}/parameters/deprecated': { 1546 1546 - post: { 1547 1547 - req: DeprecatedCallData; 1548 1548 - }; 1549 1549 - }; 1550 1550 - '/api/v{api-version}/requestBody/': { 1551 1551 - post: { 1552 1552 - req: PostApiRequestBodyData; 1553 1553 - }; 1554 1554 - }; 1555 1555 - '/api/v{api-version}/formData/': { 1556 1556 - post: { 1557 1557 - req: PostApiFormDataData; 1558 1558 - }; 1559 1559 - }; 1560 1560 - '/api/v{api-version}/defaults': { 1561 1561 - get: { 1562 1562 - req: CallWithDefaultParametersData; 1563 1563 - }; 1564 1564 - post: { 1565 1565 - req: CallWithDefaultOptionalParametersData; 1566 1566 - }; 1567 1567 - put: { 1568 1568 - req: CallToTestOrderOfParamsData; 1569 1569 - }; 1570 1570 - }; 1571 1571 - '/api/v{api-version}/no-content': { 1572 1572 - get: { 1573 1573 - res: { 1574 1574 - /** 1575 1575 - * Success 1576 1576 - */ 1577 1577 - 204: void; 1578 1578 - }; 1579 1579 - }; 1580 1580 - }; 1581 1581 - '/api/v{api-version}/multiple-tags/response-and-no-content': { 1582 1582 - get: { 1583 1583 - res: { 1584 1584 - /** 1585 1585 - * Response is a simple number 1586 1586 - */ 1587 1587 - 200: number; 1588 1588 - /** 1589 1589 - * Success 1590 1590 - */ 1591 1591 - 204: void; 1592 1592 - }; 1593 1593 - }; 1594 1594 - }; 1595 1595 - '/api/v{api-version}/response': { 1596 1596 - get: { 1597 1597 - res: { 1598 1598 - default: _import; 1599 1599 - }; 1600 1600 - }; 1601 1601 - post: { 1602 1602 - res: { 1603 1603 - /** 1604 1604 - * Message for 200 response 1605 1605 - */ 1606 1606 - 200: ModelWithBoolean & ModelWithInteger; 1607 1607 - /** 1608 1608 - * Message for 201 response 1609 1609 - */ 1610 1610 - 201: ModelWithString; 1611 1611 - /** 1612 1612 - * Message for 202 response 1613 1613 - */ 1614 1614 - 202: ModelWithString; 1615 1615 - /** 1616 1616 - * Message for 500 error 1617 1617 - */ 1618 1618 - 500: ModelWithStringError; 1619 1619 - /** 1620 1620 - * Message for 501 error 1621 1621 - */ 1622 1622 - 501: ModelWithStringError; 1623 1623 - /** 1624 1624 - * Message for 502 error 1625 1625 - */ 1626 1626 - 502: ModelWithStringError; 1627 1627 - /** 1628 1628 - * Message for 4XX errors 1629 1629 - */ 1630 1630 - '4XX': DictionaryWithArray; 1631 1631 - /** 1632 1632 - * Default error response 1633 1633 - */ 1634 1634 - default: ModelWithBoolean; 1635 1635 - }; 1636 1636 - }; 1637 1637 - put: { 1638 1638 - res: { 1639 1639 - /** 1640 1640 - * Message for 200 response 1641 1641 - */ 1642 1642 - 200: { 1643 1643 - readonly '@namespace.string'?: string; 1644 1644 - readonly '@namespace.integer'?: number; 1645 1645 - readonly value?: Array<ModelWithString>; 1646 1646 - }; 1647 1647 - /** 1648 1648 - * Message for 201 response 1649 1649 - */ 1650 1650 - 201: ModelThatExtends; 1651 1651 - /** 1652 1652 - * Message for 202 response 1653 1653 - */ 1654 1654 - 202: ModelThatExtendsExtends; 1655 1655 - /** 1656 1656 - * Message for 500 error 1657 1657 - */ 1658 1658 - 500: ModelWithStringError; 1659 1659 - /** 1660 1660 - * Message for 501 error 1661 1661 - */ 1662 1662 - 501: ModelWithStringError; 1663 1663 - /** 1664 1664 - * Message for 502 error 1665 1665 - */ 1666 1666 - 502: ModelWithStringError; 1667 1667 - /** 1668 1668 - * Message for default response 1669 1669 - */ 1670 1670 - default: ModelWithStringError; 1671 1671 - }; 1672 1672 - }; 1673 1673 - }; 1674 1674 - '/api/v{api-version}/multiple-tags/a': { 1675 1675 - get: { 1676 1676 - res: { 1677 1677 - 200: _400; 1678 1678 - }; 1679 1679 - }; 1680 1680 - }; 1681 1681 - '/api/v{api-version}/multiple-tags/b': { 1682 1682 - get: { 1683 1683 - res: { 1684 1684 - /** 1685 1685 - * Success 1686 1686 - */ 1687 1687 - 204: void; 1688 1688 - }; 1689 1689 - }; 1690 1690 - }; 1691 1691 - '/api/v{api-version}/collectionFormat': { 1692 1692 - get: { 1693 1693 - req: CollectionFormatData; 1694 1694 - }; 1695 1695 - }; 1696 1696 - '/api/v{api-version}/types': { 1697 1697 - get: { 1698 1698 - req: TypesData; 1699 1699 - res: { 1700 1700 - /** 1701 1701 - * Response is a simple number 1702 1702 - */ 1703 1703 - 200: number; 1704 1704 - /** 1705 1705 - * Response is a simple string 1706 1706 - */ 1707 1707 - 201: string; 1708 1708 - /** 1709 1709 - * Response is a simple boolean 1710 1710 - */ 1711 1711 - 202: boolean; 1712 1712 - /** 1713 1713 - * Response is a simple object 1714 1714 - */ 1715 1715 - 203: { 1716 1716 - [key: string]: unknown; 1717 1717 - }; 1718 1718 - }; 1719 1719 - }; 1720 1720 - }; 1721 1721 - '/api/v{api-version}/upload': { 1722 1722 - post: { 1723 1723 - req: UploadFileData; 1724 1724 - res: { 1725 1725 - 200: boolean; 1726 1726 - }; 1727 1727 - }; 1728 1728 - }; 1729 1729 - '/api/v{api-version}/file/{id}': { 1730 1730 - get: { 1731 1731 - req: FileResponseData; 1732 1732 - res: { 1733 1733 - /** 1734 1734 - * Success 1735 1735 - */ 1736 1736 - 200: (Blob | File); 1737 1737 - }; 1738 1738 - }; 1739 1739 - }; 1740 1740 - '/api/v{api-version}/complex': { 1741 1741 - get: { 1742 1742 - req: ComplexTypesData; 1743 1743 - res: { 1744 1744 - /** 1745 1745 - * Successful response 1746 1746 - */ 1747 1747 - 200: Array<ModelWithString>; 1748 1748 - /** 1749 1749 - * 400 `server` error 1750 1750 - */ 1751 1751 - 400: unknown; 1752 1752 - /** 1753 1753 - * 500 server error 1754 1754 - */ 1755 1755 - 500: unknown; 1756 1756 - }; 1757 1757 - }; 1758 1758 - }; 1759 1759 - '/api/v{api-version}/complex/{id}': { 1760 1760 - put: { 1761 1761 - req: ComplexParamsData; 1762 1762 - res: { 1763 1763 - /** 1764 1764 - * Success 1765 1765 - */ 1766 1766 - 200: ModelWithString; 1767 1767 - }; 1768 1768 - }; 1769 1769 - }; 1770 1770 - '/api/v{api-version}/multipart': { 1771 1771 - post: { 1772 1772 - req: MultipartRequestData; 1773 1773 - }; 1774 1774 - get: { 1775 1775 - res: { 1776 1776 - /** 1777 1777 - * OK 1778 1778 - */ 1779 1779 - 200: { 1780 1780 - file?: (Blob | File); 1781 1781 - metadata?: { 1782 1782 - foo?: string; 1783 1783 - bar?: string; 1784 1784 - }; 1785 1785 - }; 1786 1786 - }; 1787 1787 - }; 1788 1788 - }; 1789 1789 - '/api/v{api-version}/header': { 1790 1790 - post: { 1791 1791 - res: { 1792 1792 - /** 1793 1793 - * Successful response 1794 1794 - */ 1795 1795 - 200: string; 1796 1796 - /** 1797 1797 - * 400 server error 1798 1798 - */ 1799 1799 - 400: unknown; 1800 1800 - /** 1801 1801 - * 500 server error 1802 1802 - */ 1803 1803 - 500: unknown; 1804 1804 - }; 1805 1805 - }; 1806 1806 - }; 1807 1807 - '/api/v{api-version}/error': { 1808 1808 - post: { 1809 1809 - req: TestErrorCodeData; 1810 1810 - res: { 1811 1811 - /** 1812 1812 - * Custom message: Successful response 1813 1813 - */ 1814 1814 - 200: unknown; 1815 1815 - /** 1816 1816 - * Custom message: Internal Server Error 1817 1817 - */ 1818 1818 - 500: unknown; 1819 1819 - /** 1820 1820 - * Custom message: Not Implemented 1821 1821 - */ 1822 1822 - 501: unknown; 1823 1823 - /** 1824 1824 - * Custom message: Bad Gateway 1825 1825 - */ 1826 1826 - 502: unknown; 1827 1827 - /** 1828 1828 - * Custom message: Service Unavailable 1829 1829 - */ 1830 1830 - 503: unknown; 1831 1831 - }; 1832 1832 - }; 1833 1833 - }; 1834 1834 - '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串': { 1835 1835 - post: { 1836 1836 - req: NonAsciiæøåÆøÅöôêÊ字符串Data; 1837 1837 - res: { 1838 1838 - /** 1839 1839 - * Successful response 1840 1840 - */ 1841 1841 - 200: Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1842 1842 - }; 1843 1843 - }; 1844 1844 - put: { 1845 1845 - req: PutWithFormUrlEncodedData; 1846 1846 - }; 1847 1847 - }; 1848 1479 };

-69

packages/openapi-ts/test/__snapshots__/test/generated/v3_xhr_transform/types.gen.ts.snap

··· 46 46 47 47 export type MultipleResponsesResponse = Array<ModelWithDates> | Array<SimpleModel>; 48 48 49 49 - export type $OpenApiTs = { 50 50 - '/api/model-with-dates': { 51 51 - post: { 52 52 - res: { 53 53 - /** 54 54 - * Success 55 55 - */ 56 56 - 200: ParentModelWithDates; 57 57 - /** 58 58 - * Success 59 59 - */ 60 60 - 201: unknown; 61 61 - }; 62 62 - }; 63 63 - put: { 64 64 - res: { 65 65 - /** 66 66 - * Success 67 67 - */ 68 68 - 200: ModelWithDates; 69 69 - }; 70 70 - }; 71 71 - }; 72 72 - '/api/model-with-dates-array': { 73 73 - put: { 74 74 - res: { 75 75 - /** 76 76 - * Success 77 77 - */ 78 78 - 200: Array<ModelWithDates>; 79 79 - }; 80 80 - }; 81 81 - }; 82 82 - '/api/array-of-dates': { 83 83 - put: { 84 84 - res: { 85 85 - /** 86 86 - * Success 87 87 - */ 88 88 - 200: Array<(Date)>; 89 89 - }; 90 90 - }; 91 91 - }; 92 92 - '/api/date': { 93 93 - put: { 94 94 - res: { 95 95 - /** 96 96 - * Success 97 97 - */ 98 98 - 200: Date; 99 99 - }; 100 100 - }; 101 101 - }; 102 102 - '/api/multiple-responses': { 103 103 - put: { 104 104 - res: { 105 105 - /** 106 106 - * Updated 107 107 - */ 108 108 - 200: Array<ModelWithDates>; 109 109 - /** 110 110 - * Created 111 111 - */ 112 112 - 201: Array<SimpleModel>; 113 113 - }; 114 114 - }; 115 115 - }; 116 116 - }; 117 117 - 118 49 export type ParentModelWithDatesResponseTransformer = (data: any) => Promise<ParentModelWithDatesResponse>; 119 50 120 51 export type ParentModelWithDatesModelResponseTransformer = (data: any) => ParentModelWithDates;

+3 -2

packages/openapi-ts/test/sample.cjs

··· 29 29 export: false, 30 30 }, 31 31 services: { 32 32 + export: false, 32 33 // asClass: true, 33 34 // filter: '^POST /api/v{api-version}/upload$', 34 35 // export: false, ··· 40 41 // export: false, 41 42 // include: 42 43 // '^(_400|CompositionWithOneOfAndProperties)', 43 43 - name: 'PascalCase', 44 44 - // tree: false, 44 44 + // name: 'PascalCase', 45 45 + tree: false, 45 46 }, 46 47 // useOptions: false, 47 48 };