Class: ElastomerClient::Client::RestApiSpec::ApiSpecV8_7
- Defined in:
- lib/elastomer_client/client/rest_api_spec/api_spec_v8_7.rb
Instance Attribute Summary
Attributes inherited from ApiSpec
Instance Method Summary collapse
-
#initialize ⇒ ApiSpecV8_7
constructor
A new instance of ApiSpecV8_7.
Methods inherited from ApiSpec
#get, #select_common_params, #select_params, #select_parts, #valid_common_param?, #valid_param?, #valid_part?, #validate_params!
Constructor Details
#initialize ⇒ ApiSpecV8_7
Returns a new instance of ApiSpecV8_7.
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 |
# File 'lib/elastomer_client/client/rest_api_spec/api_spec_v8_7.rb', line 7 def initialize @rest_apis = { "_internal.delete_desired_nodes" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-desired-nodes.html", methods: ["DELETE"], body: nil, url: { path: "/_internal/desired_nodes", paths: ["/_internal/desired_nodes"], } ), "_internal.get_desired_balance" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-desired-balance.html", methods: ["GET"], body: nil, url: { path: "/_internal/desired_balance", paths: ["/_internal/desired_balance"], } ), "_internal.get_desired_nodes" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-desired-nodes.html", methods: ["GET"], body: nil, url: { path: "/_internal/desired_nodes/_latest", paths: ["/_internal/desired_nodes/_latest"], } ), "_internal.prevalidate_node_removal" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/prevalidate-node-removal-api.html", methods: ["POST"], body: nil, url: { path: "/_internal/prevalidate_node_removal", paths: ["/_internal/prevalidate_node_removal"], params: { "names" => {"type"=>"list", "description"=>"A comma-separated list of node names to prevalidate"}, "ids" => {"type"=>"list", "description"=>"A comma-separated list of node IDs to prevalidate"}, "external_ids" => {"type"=>"list", "description"=>"A comma-separated list of node external IDs to prevalidate"}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, } } ), "_internal.update_desired_nodes" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-desired-nodes.html", methods: ["PUT"], body: {"description"=>"the specification of the desired nodes", "required"=>true}, url: { path: "/_internal/desired_nodes/{history_id}/{version}", paths: ["/_internal/desired_nodes/{history_id}/{version}"], parts: { "history_id" => {"type"=>"string", "description"=>"the history id"}, "version" => {"type"=>"integer", "description"=>"the version number"}, }, params: { "dry_run" => {"type"=>"boolean", "description"=>"Simulate the update"}, } } ), "async_search.delete" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html", methods: ["DELETE"], body: nil, url: { path: "/_async_search/{id}", paths: ["/_async_search/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The async search ID"}, }, } ), "async_search.get" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html", methods: ["GET"], body: nil, url: { path: "/_async_search/{id}", paths: ["/_async_search/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The async search ID"}, }, params: { "wait_for_completion_timeout" => {"type"=>"time", "description"=>"Specify the time that the request should block waiting for the final response"}, "keep_alive" => {"type"=>"time", "description"=>"Specify the time interval in which the results (partial or final) for this search will be available"}, "typed_keys" => {"type"=>"boolean", "description"=>"Specify whether aggregation and suggester names should be prefixed by their respective types in the response"}, } } ), "async_search.status" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html", methods: ["GET"], body: nil, url: { path: "/_async_search/status/{id}", paths: ["/_async_search/status/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The async search ID"}, }, } ), "async_search.submit" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html", methods: ["POST"], body: {"description"=>"The search definition using the Query DSL"}, url: { path: "/_async_search", paths: ["/_async_search", "/{index}/_async_search"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices"}, }, params: { "wait_for_completion_timeout" => {"type"=>"time", "description"=>"Specify the time that the request should block waiting for the final response", "default"=>"1s"}, "keep_on_completion" => {"type"=>"boolean", "description"=>"Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false)", "default"=>false}, "keep_alive" => {"type"=>"time", "description"=>"Update the time interval in which the results (partial or final) for this search will be available", "default"=>"5d"}, "batched_reduce_size" => {"type"=>"number", "description"=>"The number of shard results that should be reduced at once on the coordinating node. This value should be used as the granularity at which progress results will be made available.", "default"=>5}, "request_cache" => {"type"=>"boolean", "description"=>"Specify if request cache should be used for this request or not, defaults to true"}, "analyzer" => {"type"=>"string", "description"=>"The analyzer to use for the query string"}, "analyze_wildcard" => {"type"=>"boolean", "description"=>"Specify whether wildcard and prefix queries should be analyzed (default: false)"}, "default_operator" => {"type"=>"enum", "options"=>["AND", "OR"], "default"=>"OR", "description"=>"The default operator for query string query (AND or OR)"}, "df" => {"type"=>"string", "description"=>"The field to use as default where no field prefix is given in the query string"}, "explain" => {"type"=>"boolean", "description"=>"Specify whether to return detailed information about score computation as part of a hit"}, "stored_fields" => {"type"=>"list", "description"=>"A comma-separated list of stored fields to return as part of a hit"}, "docvalue_fields" => {"type"=>"list", "description"=>"A comma-separated list of fields to return as the docvalue representation of a field for each hit"}, "from" => {"type"=>"number", "description"=>"Starting offset (default: 0)"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "ignore_throttled" => {"type"=>"boolean", "description"=>"Whether specified concrete, expanded or aliased indices should be ignored when throttled"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "lenient" => {"type"=>"boolean", "description"=>"Specify whether format-based query failures (such as providing text to a numeric field) should be ignored"}, "preference" => {"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "q" => {"type"=>"string", "description"=>"Query in the Lucene query string syntax"}, "routing" => {"type"=>"list", "description"=>"A comma-separated list of specific routing values"}, "search_type" => {"type"=>"enum", "options"=>["query_then_fetch", "dfs_query_then_fetch"], "description"=>"Search operation type"}, "size" => {"type"=>"number", "description"=>"Number of hits to return (default: 10)"}, "sort" => {"type"=>"list", "description"=>"A comma-separated list of <field>:<direction> pairs"}, "_source" => {"type"=>"list", "description"=>"True or false to return the _source field or not, or a list of fields to return"}, "_source_excludes" => {"type"=>"list", "description"=>"A list of fields to exclude from the returned _source field"}, "_source_includes" => {"type"=>"list", "description"=>"A list of fields to extract and return from the _source field"}, "terminate_after" => {"type"=>"number", "description"=>"The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early."}, "stats" => {"type"=>"list", "description"=>"Specific 'tag' of the request for logging and statistical purposes"}, "suggest_field" => {"type"=>"string", "description"=>"Specify which field to use for suggestions"}, "suggest_mode" => {"type"=>"enum", "options"=>["missing", "popular", "always"], "default"=>"missing", "description"=>"Specify suggest mode"}, "suggest_size" => {"type"=>"number", "description"=>"How many suggestions to return in response"}, "suggest_text" => {"type"=>"string", "description"=>"The source text for which the suggestions should be returned"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "track_scores" => {"type"=>"boolean", "description"=>"Whether to calculate and return scores even if they are not used for sorting"}, "track_total_hits" => {"type"=>"boolean|long", "description"=>"Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number."}, "allow_partial_search_results" => {"type"=>"boolean", "default"=>true, "description"=>"Indicate if an error should be returned if there is a partial search failure or timeout"}, "typed_keys" => {"type"=>"boolean", "description"=>"Specify whether aggregation and suggester names should be prefixed by their respective types in the response"}, "version" => {"type"=>"boolean", "description"=>"Specify whether to return document version as part of a hit"}, "seq_no_primary_term" => {"type"=>"boolean", "description"=>"Specify whether to return sequence number and primary term of the last modification of each hit"}, "max_concurrent_shard_requests" => {"type"=>"number", "description"=>"The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", "default"=>5}, } } ), "autoscaling.delete_autoscaling_policy" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-delete-autoscaling-policy.html", methods: ["DELETE"], body: nil, url: { path: "/_autoscaling/policy/{name}", paths: ["/_autoscaling/policy/{name}"], parts: { "name" => {"type"=>"string", "description"=>"the name of the autoscaling policy"}, }, } ), "autoscaling.get_autoscaling_capacity" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html", methods: ["GET"], body: nil, url: { path: "/_autoscaling/capacity", paths: ["/_autoscaling/capacity"], } ), "autoscaling.get_autoscaling_policy" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-policy.html", methods: ["GET"], body: nil, url: { path: "/_autoscaling/policy/{name}", paths: ["/_autoscaling/policy/{name}"], parts: { "name" => {"type"=>"string", "description"=>"the name of the autoscaling policy"}, }, } ), "autoscaling.put_autoscaling_policy" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html", methods: ["PUT"], body: {"description"=>"the specification of the autoscaling policy", "required"=>true}, url: { path: "/_autoscaling/policy/{name}", paths: ["/_autoscaling/policy/{name}"], parts: { "name" => {"type"=>"string", "description"=>"the name of the autoscaling policy"}, }, } ), "bulk" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html", methods: ["POST", "PUT"], body: {"description"=>"The operation definition and data (action-data pairs), separated by newlines", "required"=>true, "serialize"=>"bulk"}, url: { path: "/_bulk", paths: ["/_bulk", "/{index}/_bulk"], parts: { "index" => {"type"=>"string", "description"=>"Default index for items which don't provide one"}, }, params: { "wait_for_active_shards" => {"type"=>"string", "description"=>"Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"}, "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes."}, "routing" => {"type"=>"string", "description"=>"Specific routing value"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "type" => {"type"=>"string", "description"=>"Default document type for items which don't provide one"}, "_source" => {"type"=>"list", "description"=>"True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request"}, "_source_excludes" => {"type"=>"list", "description"=>"Default list of fields to exclude from the returned _source field, can be overridden on each sub-request"}, "_source_includes" => {"type"=>"list", "description"=>"Default list of fields to extract and return from the _source field, can be overridden on each sub-request"}, "pipeline" => {"type"=>"string", "description"=>"The pipeline id to preprocess incoming documents with"}, "require_alias" => {"type"=>"boolean", "description"=>"Sets require_alias for all incoming documents. Defaults to unset (false)"}, } } ), "cat.aliases" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html", methods: ["GET"], body: nil, url: { path: "/_cat/aliases", paths: ["/_cat/aliases", "/_cat/aliases/{name}"], parts: { "name" => {"type"=>"list", "description"=>"A comma-separated list of alias names to return"}, }, params: { "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"all", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, } } ), "cat.allocation" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html", methods: ["GET"], body: nil, url: { path: "/_cat/allocation", paths: ["/_cat/allocation", "/_cat/allocation/{node_id}"], parts: { "node_id" => {"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information"}, }, params: { "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "bytes" => {"type"=>"enum", "description"=>"The unit in which to display byte values", "options"=>["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, } } ), "cat.component_templates" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-compoentn-templates.html", methods: ["GET"], body: nil, url: { path: "/_cat/component_templates", paths: ["/_cat/component_templates", "/_cat/component_templates/{name}"], parts: { "name" => {"type"=>"string", "description"=>"A pattern that returned component template names must match"}, }, params: { "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, } } ), "cat.count" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html", methods: ["GET"], body: nil, url: { path: "/_cat/count", paths: ["/_cat/count", "/_cat/count/{index}"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names to limit the returned information"}, }, params: { "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, } } ), "cat.fielddata" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html", methods: ["GET"], body: nil, url: { path: "/_cat/fielddata", paths: ["/_cat/fielddata", "/_cat/fielddata/{fields}"], parts: { "fields" => {"type"=>"list", "description"=>"A comma-separated list of fields to return the fielddata size"}, }, params: { "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "bytes" => {"type"=>"enum", "description"=>"The unit in which to display byte values", "options"=>["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, "fields" => {"type"=>"list", "description"=>"A comma-separated list of fields to return in the output"}, } } ), "cat.health" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html", methods: ["GET"], body: nil, url: { path: "/_cat/health", paths: ["/_cat/health"], params: { "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time" => {"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "ts" => {"type"=>"boolean", "description"=>"Set to false to disable timestamping", "default"=>true}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, } } ), "cat.help" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html", methods: ["GET"], body: nil, url: { path: "/_cat", paths: ["/_cat"], params: { "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, } } ), "cat.indices" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html", methods: ["GET"], body: nil, url: { path: "/_cat/indices", paths: ["/_cat/indices", "/_cat/indices/{index}"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names to limit the returned information"}, }, params: { "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "bytes" => {"type"=>"enum", "description"=>"The unit in which to display byte values", "options"=>["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "health" => {"type"=>"enum", "options"=>["green", "yellow", "red"], "description"=>"A health status (\"green\", \"yellow\", or \"red\" to filter only indices matching the specified health status"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "pri" => {"type"=>"boolean", "description"=>"Set to true to return stats only for primary shards", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time" => {"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, "include_unloaded_segments" => {"type"=>"boolean", "description"=>"If set to true segment stats will include stats for segments that are not currently loaded into memory", "default"=>false}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"all", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, } } ), "cat.master" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html", methods: ["GET"], body: nil, url: { path: "/_cat/master", paths: ["/_cat/master"], params: { "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, } } ), "cat.ml_data_frame_analytics" => RestApi.new( documentation: "http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html", methods: ["GET"], body: nil, url: { path: "/_cat/ml/data_frame/analytics", paths: ["/_cat/ml/data_frame/analytics", "/_cat/ml/data_frame/analytics/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The ID of the data frame analytics to fetch"}, }, params: { "allow_no_match" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)"}, "bytes" => {"type"=>"enum", "description"=>"The unit in which to display byte values", "options"=>["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]}, "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time" => {"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, } } ), "cat.ml_datafeeds" => RestApi.new( documentation: "http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html", methods: ["GET"], body: nil, url: { path: "/_cat/ml/datafeeds", paths: ["/_cat/ml/datafeeds", "/_cat/ml/datafeeds/{datafeed_id}"], parts: { "datafeed_id" => {"type"=>"string", "description"=>"The ID of the datafeeds stats to fetch"}, }, params: { "allow_no_match" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)"}, "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time" => {"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, } } ), "cat.ml_jobs" => RestApi.new( documentation: "http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html", methods: ["GET"], body: nil, url: { path: "/_cat/ml/anomaly_detectors", paths: ["/_cat/ml/anomaly_detectors", "/_cat/ml/anomaly_detectors/{job_id}"], parts: { "job_id" => {"type"=>"string", "description"=>"The ID of the jobs stats to fetch"}, }, params: { "allow_no_match" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)"}, "bytes" => {"type"=>"enum", "description"=>"The unit in which to display byte values", "options"=>["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]}, "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time" => {"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, } } ), "cat.ml_trained_models" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html", methods: ["GET"], body: nil, url: { path: "/_cat/ml/trained_models", paths: ["/_cat/ml/trained_models", "/_cat/ml/trained_models/{model_id}"], parts: { "model_id" => {"type"=>"string", "description"=>"The ID of the trained models stats to fetch"}, }, params: { "allow_no_match" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)", "default"=>true}, "from" => {"type"=>"int", "description"=>"skips a number of trained models", "default"=>0}, "size" => {"type"=>"int", "description"=>"specifies a max number of trained models to get", "default"=>100}, "bytes" => {"type"=>"enum", "description"=>"The unit in which to display byte values", "options"=>["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]}, "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time" => {"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, } } ), "cat.nodeattrs" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html", methods: ["GET"], body: nil, url: { path: "/_cat/nodeattrs", paths: ["/_cat/nodeattrs"], params: { "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, } } ), "cat.nodes" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html", methods: ["GET"], body: nil, url: { path: "/_cat/nodes", paths: ["/_cat/nodes"], params: { "bytes" => {"type"=>"enum", "description"=>"The unit in which to display byte values", "options"=>["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]}, "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "full_id" => {"type"=>"boolean", "description"=>"Return the full node ID instead of the shortened version (default: false)"}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time" => {"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, "include_unloaded_segments" => {"type"=>"boolean", "description"=>"If set to true segment stats will include stats for segments that are not currently loaded into memory", "default"=>false}, } } ), "cat.pending_tasks" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html", methods: ["GET"], body: nil, url: { path: "/_cat/pending_tasks", paths: ["/_cat/pending_tasks"], params: { "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time" => {"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, } } ), "cat.plugins" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html", methods: ["GET"], body: nil, url: { path: "/_cat/plugins", paths: ["/_cat/plugins"], params: { "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "include_bootstrap" => {"type"=>"boolean", "description"=>"Include bootstrap plugins in the response", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, } } ), "cat.recovery" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html", methods: ["GET"], body: nil, url: { path: "/_cat/recovery", paths: ["/_cat/recovery", "/_cat/recovery/{index}"], parts: { "index" => {"type"=>"list", "description"=>"Comma-separated list or wildcard expression of index names to limit the returned information"}, }, params: { "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "active_only" => {"type"=>"boolean", "description"=>"If `true`, the response only includes ongoing shard recoveries", "default"=>false}, "bytes" => {"type"=>"enum", "description"=>"The unit in which to display byte values", "options"=>["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]}, "detailed" => {"type"=>"boolean", "description"=>"If `true`, the response includes detailed information about shard recoveries", "default"=>false}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "index" => {"type"=>"list", "description"=>"Comma-separated list or wildcard expression of index names to limit the returned information"}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time" => {"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, } } ), "cat.repositories" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html", methods: ["GET"], body: nil, url: { path: "/_cat/repositories", paths: ["/_cat/repositories"], params: { "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node", "default"=>false}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, } } ), "cat.segments" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html", methods: ["GET"], body: nil, url: { path: "/_cat/segments", paths: ["/_cat/segments", "/_cat/segments/{index}"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names to limit the returned information"}, }, params: { "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "bytes" => {"type"=>"enum", "description"=>"The unit in which to display byte values", "options"=>["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, } } ), "cat.shards" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html", methods: ["GET"], body: nil, url: { path: "/_cat/shards", paths: ["/_cat/shards", "/_cat/shards/{index}"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names to limit the returned information"}, }, params: { "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "bytes" => {"type"=>"enum", "description"=>"The unit in which to display byte values", "options"=>["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time" => {"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, } } ), "cat.snapshots" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html", methods: ["GET"], body: nil, url: { path: "/_cat/snapshots", paths: ["/_cat/snapshots", "/_cat/snapshots/{repository}"], parts: { "repository" => {"type"=>"list", "description"=>"Name of repository from which to fetch the snapshot information"}, }, params: { "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Set to true to ignore unavailable snapshots", "default"=>false}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time" => {"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, } } ), "cat.tasks" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", methods: ["GET"], body: nil, url: { path: "/_cat/tasks", paths: ["/_cat/tasks"], params: { "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "nodes" => {"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}, "actions" => {"type"=>"list", "description"=>"A comma-separated list of actions that should be returned. Leave empty to return all."}, "detailed" => {"type"=>"boolean", "description"=>"Return detailed task information (default: false)"}, "parent_task_id" => {"type"=>"string", "description"=>"Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all."}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time" => {"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, } } ), "cat.templates" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html", methods: ["GET"], body: nil, url: { path: "/_cat/templates", paths: ["/_cat/templates", "/_cat/templates/{name}"], parts: { "name" => {"type"=>"string", "description"=>"A pattern that returned template names must match"}, }, params: { "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, } } ), "cat.thread_pool" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html", methods: ["GET"], body: nil, url: { path: "/_cat/thread_pool", paths: ["/_cat/thread_pool", "/_cat/thread_pool/{thread_pool_patterns}"], parts: { "thread_pool_patterns" => {"type"=>"list", "description"=>"A comma-separated list of regular-expressions to filter the thread pools in the output"}, }, params: { "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "time" => {"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, } } ), "cat.transforms" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html", methods: ["GET"], body: nil, url: { path: "/_cat/transforms", paths: ["/_cat/transforms", "/_cat/transforms/{transform_id}"], parts: { "transform_id" => {"type"=>"string", "description"=>"The id of the transform for which to get stats. '_all' or '*' implies all transforms"}, }, params: { "from" => {"type"=>"int", "required"=>false, "description"=>"skips a number of transform configs, defaults to 0"}, "size" => {"type"=>"int", "required"=>false, "description"=>"specifies a max number of transforms to get, defaults to 100"}, "allow_no_match" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)"}, "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, "h" => {"type"=>"list", "description"=>"Comma-separated list of column names to display"}, "help" => {"type"=>"boolean", "description"=>"Return help information", "default"=>false}, "s" => {"type"=>"list", "description"=>"Comma-separated list of column names or column aliases to sort by"}, "time" => {"type"=>"enum", "description"=>"The unit in which to display time values", "options"=>["d", "h", "m", "s", "ms", "micros", "nanos"]}, "v" => {"type"=>"boolean", "description"=>"Verbose mode. Display column headers", "default"=>false}, } } ), "ccr.delete_auto_follow_pattern" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html", methods: ["DELETE"], body: nil, url: { path: "/_ccr/auto_follow/{name}", paths: ["/_ccr/auto_follow/{name}"], parts: { "name" => {"type"=>"string", "description"=>"The name of the auto follow pattern."}, }, } ), "ccr.follow" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html", methods: ["PUT"], body: {"description"=>"The name of the leader index and other optional ccr related parameters", "required"=>true}, url: { path: "/{index}/_ccr/follow", paths: ["/{index}/_ccr/follow"], parts: { "index" => {"type"=>"string", "description"=>"The name of the follower index"}, }, params: { "wait_for_active_shards" => {"type"=>"string", "description"=>"Sets the number of shard copies that must be active before returning. Defaults to 0. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)", "default"=>"0"}, } } ), "ccr.follow_info" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html", methods: ["GET"], body: nil, url: { path: "/{index}/_ccr/info", paths: ["/{index}/_ccr/info"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index patterns; use `_all` to perform the operation on all indices"}, }, } ), "ccr.follow_stats" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-stats.html", methods: ["GET"], body: nil, url: { path: "/{index}/_ccr/stats", paths: ["/{index}/_ccr/stats"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index patterns; use `_all` to perform the operation on all indices"}, }, } ), "ccr.forget_follower" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-forget-follower.html", methods: ["POST"], body: {"description"=>"the name and UUID of the follower index, the name of the cluster containing the follower index, and the alias from the perspective of that cluster for the remote cluster containing the leader index", "required"=>true}, url: { path: "/{index}/_ccr/forget_follower", paths: ["/{index}/_ccr/forget_follower"], parts: { "index" => {"type"=>"string", "description"=>"the name of the leader index for which specified follower retention leases should be removed"}, }, } ), "ccr.get_auto_follow_pattern" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-auto-follow-pattern.html", methods: ["GET"], body: nil, url: { path: "/_ccr/auto_follow", paths: ["/_ccr/auto_follow", "/_ccr/auto_follow/{name}"], parts: { "name" => {"type"=>"string", "description"=>"The name of the auto follow pattern."}, }, } ), "ccr.pause_auto_follow_pattern" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-pause-auto-follow-pattern.html", methods: ["POST"], body: nil, url: { path: "/_ccr/auto_follow/{name}/pause", paths: ["/_ccr/auto_follow/{name}/pause"], parts: { "name" => {"type"=>"string", "description"=>"The name of the auto follow pattern that should pause discovering new indices to follow."}, }, } ), "ccr.pause_follow" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-pause-follow.html", methods: ["POST"], body: nil, url: { path: "/{index}/_ccr/pause_follow", paths: ["/{index}/_ccr/pause_follow"], parts: { "index" => {"type"=>"string", "description"=>"The name of the follower index that should pause following its leader index."}, }, } ), "ccr.put_auto_follow_pattern" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-auto-follow-pattern.html", methods: ["PUT"], body: {"description"=>"The specification of the auto follow pattern", "required"=>true}, url: { path: "/_ccr/auto_follow/{name}", paths: ["/_ccr/auto_follow/{name}"], parts: { "name" => {"type"=>"string", "description"=>"The name of the auto follow pattern."}, }, } ), "ccr.resume_auto_follow_pattern" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-resume-auto-follow-pattern.html", methods: ["POST"], body: nil, url: { path: "/_ccr/auto_follow/{name}/resume", paths: ["/_ccr/auto_follow/{name}/resume"], parts: { "name" => {"type"=>"string", "description"=>"The name of the auto follow pattern to resume discovering new indices to follow."}, }, } ), "ccr.resume_follow" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-resume-follow.html", methods: ["POST"], body: {"description"=>"The name of the leader index and other optional ccr related parameters", "required"=>false}, url: { path: "/{index}/_ccr/resume_follow", paths: ["/{index}/_ccr/resume_follow"], parts: { "index" => {"type"=>"string", "description"=>"The name of the follow index to resume following."}, }, } ), "ccr.stats" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-stats.html", methods: ["GET"], body: nil, url: { path: "/_ccr/stats", paths: ["/_ccr/stats"], } ), "ccr.unfollow" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-unfollow.html", methods: ["POST"], body: nil, url: { path: "/{index}/_ccr/unfollow", paths: ["/{index}/_ccr/unfollow"], parts: { "index" => {"type"=>"string", "description"=>"The name of the follower index that should be turned into a regular index."}, }, } ), "clear_scroll" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html", methods: ["DELETE"], body: {"description"=>"A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter"}, url: { path: "/_search/scroll", paths: ["/_search/scroll", "/_search/scroll/{scroll_id}"], parts: { "scroll_id" => {"type"=>"list", "description"=>"A comma-separated list of scroll IDs to clear", "deprecated"=>true}, }, } ), "close_point_in_time" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html", methods: ["DELETE"], body: {"description"=>"a point-in-time id to close"}, url: { path: "/_pit", paths: ["/_pit"], } ), "cluster.allocation_explain" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html", methods: ["GET", "POST"], body: {"description"=>"The index, shard, and primary flag to explain. Empty means 'explain a randomly-chosen unassigned shard'"}, url: { path: "/_cluster/allocation/explain", paths: ["/_cluster/allocation/explain"], params: { "include_yes_decisions" => {"type"=>"boolean", "description"=>"Return 'YES' decisions in explanation (default: false)"}, "include_disk_info" => {"type"=>"boolean", "description"=>"Return information about disk usage and shard sizes (default: false)"}, } } ), "cluster.delete_component_template" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", methods: ["DELETE"], body: nil, url: { path: "/_component_template/{name}", paths: ["/_component_template/{name}"], parts: { "name" => {"type"=>"string", "description"=>"The name of the template"}, }, params: { "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, } } ), "cluster.delete_voting_config_exclusions" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/voting-config-exclusions.html", methods: ["DELETE"], body: nil, url: { path: "/_cluster/voting_config_exclusions", paths: ["/_cluster/voting_config_exclusions"], params: { "wait_for_removal" => {"type"=>"boolean", "description"=>"Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list.", "default"=>true}, "master_timeout" => {"type"=>"time", "description"=>"Timeout for submitting request to master", "default"=>"30s"}, } } ), "cluster.exists_component_template" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", methods: ["HEAD"], body: nil, url: { path: "/_component_template/{name}", paths: ["/_component_template/{name}"], parts: { "name" => {"type"=>"string", "description"=>"The name of the template"}, }, params: { "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, } } ), "cluster.get_component_template" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", methods: ["GET"], body: nil, url: { path: "/_component_template", paths: ["/_component_template", "/_component_template/{name}"], parts: { "name" => {"type"=>"list", "description"=>"The comma separated names of the component templates"}, }, params: { "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, } } ), "cluster.get_settings" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-get-settings.html", methods: ["GET"], body: nil, url: { path: "/_cluster/settings", paths: ["/_cluster/settings"], params: { "flat_settings" => {"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "include_defaults" => {"type"=>"boolean", "description"=>"Whether to return all default clusters setting.", "default"=>false}, } } ), "cluster.health" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html", methods: ["GET"], body: nil, url: { path: "/_cluster/health", paths: ["/_cluster/health", "/_cluster/health/{index}"], parts: { "index" => {"type"=>"list", "description"=>"Limit the information returned to a specific index"}, }, params: { "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"all", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "level" => {"type"=>"enum", "options"=>["cluster", "indices", "shards"], "default"=>"cluster", "description"=>"Specify the level of detail for returned information"}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "wait_for_active_shards" => {"type"=>"string", "description"=>"Wait until the specified number of shards is active"}, "wait_for_nodes" => {"type"=>"string", "description"=>"Wait until the specified number of nodes is available"}, "wait_for_events" => {"type"=>"enum", "options"=>["immediate", "urgent", "high", "normal", "low", "languid"], "description"=>"Wait until all currently queued events with the given priority are processed"}, "wait_for_no_relocating_shards" => {"type"=>"boolean", "description"=>"Whether to wait until there are no relocating shards in the cluster"}, "wait_for_no_initializing_shards" => {"type"=>"boolean", "description"=>"Whether to wait until there are no initializing shards in the cluster"}, "wait_for_status" => {"type"=>"enum", "options"=>["green", "yellow", "red"], "description"=>"Wait until cluster is in a specific state"}, } } ), "cluster.pending_tasks" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html", methods: ["GET"], body: nil, url: { path: "/_cluster/pending_tasks", paths: ["/_cluster/pending_tasks"], params: { "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, } } ), "cluster.post_voting_config_exclusions" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/voting-config-exclusions.html", methods: ["POST"], body: nil, url: { path: "/_cluster/voting_config_exclusions", paths: ["/_cluster/voting_config_exclusions"], params: { "node_ids" => {"type"=>"string", "description"=>"A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_names."}, "node_names" => {"type"=>"string", "description"=>"A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_ids."}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout", "default"=>"30s"}, "master_timeout" => {"type"=>"time", "description"=>"Timeout for submitting request to master", "default"=>"30s"}, } } ), "cluster.put_component_template" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", methods: ["PUT", "POST"], body: {"description"=>"The template definition", "required"=>true}, url: { path: "/_component_template/{name}", paths: ["/_component_template/{name}"], parts: { "name" => {"type"=>"string", "description"=>"The name of the template"}, }, params: { "create" => {"type"=>"boolean", "description"=>"Whether the index template should only be added if new or can also replace an existing one", "default"=>false}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, } } ), "cluster.put_settings" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html", methods: ["PUT"], body: {"description"=>"The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart).", "required"=>true}, url: { path: "/_cluster/settings", paths: ["/_cluster/settings"], params: { "flat_settings" => {"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, } } ), "cluster.remote_info" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html", methods: ["GET"], body: nil, url: { path: "/_remote/info", paths: ["/_remote/info"], } ), "cluster.reroute" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html", methods: ["POST"], body: {"description"=>"The definition of `commands` to perform (`move`, `cancel`, `allocate`)"}, url: { path: "/_cluster/reroute", paths: ["/_cluster/reroute"], params: { "dry_run" => {"type"=>"boolean", "description"=>"Simulate the operation only and return the resulting state"}, "explain" => {"type"=>"boolean", "description"=>"Return an explanation of why the commands can or cannot be executed"}, "retry_failed" => {"type"=>"boolean", "description"=>"Retries allocation of shards that are blocked due to too many subsequent allocation failures"}, "metric" => {"type"=>"list", "options"=>["_all", "blocks", "metadata", "nodes", "none", "routing_table", "master_node", "version"], "description"=>"Limit the information returned to the specified metrics. Defaults to all but metadata"}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, } } ), "cluster.state" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html", methods: ["GET"], body: nil, url: { path: "/_cluster/state", paths: ["/_cluster/state", "/_cluster/state/{metric}", "/_cluster/state/{metric}/{index}"], parts: { "metric" => {"type"=>"list", "options"=>["_all", "blocks", "metadata", "nodes", "routing_table", "routing_nodes", "master_node", "version"], "description"=>"Limit the information returned to the specified metrics"}, "index" => {"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}, }, params: { "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, "flat_settings" => {"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "wait_for_metadata_version" => {"type"=>"number", "description"=>"Wait for the metadata version to be equal or greater than the specified metadata version"}, "wait_for_timeout" => {"type"=>"time", "description"=>"The maximum time to wait for wait_for_metadata_version before timing out"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, } } ), "cluster.stats" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html", methods: ["GET"], body: nil, url: { path: "/_cluster/stats", paths: ["/_cluster/stats", "/_cluster/stats/nodes/{node_id}"], parts: { "node_id" => {"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}, }, params: { "flat_settings" => {"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, } } ), "count" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html", methods: ["POST", "GET"], body: {"description"=>"A query to restrict the results specified with the Query DSL (optional)"}, url: { path: "/_count", paths: ["/_count", "/{index}/_count"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of indices to restrict the results"}, }, params: { "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "ignore_throttled" => {"type"=>"boolean", "description"=>"Whether specified concrete, expanded or aliased indices should be ignored when throttled"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "min_score" => {"type"=>"number", "description"=>"Include only documents with a specific `_score` value in the result"}, "preference" => {"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "routing" => {"type"=>"list", "description"=>"A comma-separated list of specific routing values"}, "q" => {"type"=>"string", "description"=>"Query in the Lucene query string syntax"}, "analyzer" => {"type"=>"string", "description"=>"The analyzer to use for the query string"}, "analyze_wildcard" => {"type"=>"boolean", "description"=>"Specify whether wildcard and prefix queries should be analyzed (default: false)"}, "default_operator" => {"type"=>"enum", "options"=>["AND", "OR"], "default"=>"OR", "description"=>"The default operator for query string query (AND or OR)"}, "df" => {"type"=>"string", "description"=>"The field to use as default where no field prefix is given in the query string"}, "lenient" => {"type"=>"boolean", "description"=>"Specify whether format-based query failures (such as providing text to a numeric field) should be ignored"}, "terminate_after" => {"type"=>"number", "description"=>"The maximum count for each shard, upon reaching which the query execution will terminate early"}, } } ), "create" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", methods: ["PUT", "POST"], body: {"description"=>"The document", "required"=>true}, url: { path: "/{index}/_create/{id}", paths: ["/{index}/_create/{id}"], parts: { "id" => {"type"=>"string", "description"=>"Document ID"}, "index" => {"type"=>"string", "description"=>"The name of the index"}, }, params: { "wait_for_active_shards" => {"type"=>"string", "description"=>"Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"}, "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes."}, "routing" => {"type"=>"string", "description"=>"Specific routing value"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "version" => {"type"=>"number", "description"=>"Explicit version number for concurrency control"}, "version_type" => {"type"=>"enum", "options"=>["internal", "external", "external_gte"], "description"=>"Specific version type"}, "pipeline" => {"type"=>"string", "description"=>"The pipeline id to preprocess incoming documents with"}, } } ), "dangling_indices.delete_dangling_index" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", methods: ["DELETE"], body: nil, url: { path: "/_dangling/{index_uuid}", paths: ["/_dangling/{index_uuid}"], parts: { "index_uuid" => {"type"=>"string", "description"=>"The UUID of the dangling index"}, }, params: { "accept_data_loss" => {"type"=>"boolean", "description"=>"Must be set to true in order to delete the dangling index"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, } } ), "dangling_indices.import_dangling_index" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", methods: ["POST"], body: nil, url: { path: "/_dangling/{index_uuid}", paths: ["/_dangling/{index_uuid}"], parts: { "index_uuid" => {"type"=>"string", "description"=>"The UUID of the dangling index"}, }, params: { "accept_data_loss" => {"type"=>"boolean", "description"=>"Must be set to true in order to import the dangling index"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, } } ), "dangling_indices.list_dangling_indices" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", methods: ["GET"], body: nil, url: { path: "/_dangling", paths: ["/_dangling"], } ), "delete" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html", methods: ["DELETE"], body: nil, url: { path: "/{index}/_doc/{id}", paths: ["/{index}/_doc/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The document ID"}, "index" => {"type"=>"string", "description"=>"The name of the index"}, }, params: { "wait_for_active_shards" => {"type"=>"string", "description"=>"Sets the number of shard copies that must be active before proceeding with the delete operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"}, "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes."}, "routing" => {"type"=>"string", "description"=>"Specific routing value"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "if_seq_no" => {"type"=>"number", "description"=>"only perform the delete operation if the last operation that has changed the document has the specified sequence number"}, "if_primary_term" => {"type"=>"number", "description"=>"only perform the delete operation if the last operation that has changed the document has the specified primary term"}, "version" => {"type"=>"number", "description"=>"Explicit version number for concurrency control"}, "version_type" => {"type"=>"enum", "options"=>["internal", "external", "external_gte"], "description"=>"Specific version type"}, } } ), "delete_by_query" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html", methods: ["POST"], body: {"description"=>"The search definition using the Query DSL", "required"=>true}, url: { path: "/{index}/_delete_by_query", paths: ["/{index}/_delete_by_query"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices"}, }, params: { "analyzer" => {"type"=>"string", "description"=>"The analyzer to use for the query string"}, "analyze_wildcard" => {"type"=>"boolean", "description"=>"Specify whether wildcard and prefix queries should be analyzed (default: false)"}, "default_operator" => {"type"=>"enum", "options"=>["AND", "OR"], "default"=>"OR", "description"=>"The default operator for query string query (AND or OR)"}, "df" => {"type"=>"string", "description"=>"The field to use as default where no field prefix is given in the query string"}, "from" => {"type"=>"number", "description"=>"Starting offset (default: 0)"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "conflicts" => {"type"=>"enum", "options"=>["abort", "proceed"], "default"=>"abort", "description"=>"What to do when the delete by query hits version conflicts?"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "lenient" => {"type"=>"boolean", "description"=>"Specify whether format-based query failures (such as providing text to a numeric field) should be ignored"}, "preference" => {"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "q" => {"type"=>"string", "description"=>"Query in the Lucene query string syntax"}, "routing" => {"type"=>"list", "description"=>"A comma-separated list of specific routing values"}, "scroll" => {"type"=>"time", "description"=>"Specify how long a consistent view of the index should be maintained for scrolled search"}, "search_type" => {"type"=>"enum", "options"=>["query_then_fetch", "dfs_query_then_fetch"], "description"=>"Search operation type"}, "search_timeout" => {"type"=>"time", "description"=>"Explicit timeout for each search request. Defaults to no timeout."}, "max_docs" => {"type"=>"number", "description"=>"Maximum number of documents to process (default: all documents)"}, "sort" => {"type"=>"list", "description"=>"A comma-separated list of <field>:<direction> pairs"}, "terminate_after" => {"type"=>"number", "description"=>"The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early."}, "stats" => {"type"=>"list", "description"=>"Specific 'tag' of the request for logging and statistical purposes"}, "version" => {"type"=>"boolean", "description"=>"Specify whether to return document version as part of a hit"}, "request_cache" => {"type"=>"boolean", "description"=>"Specify if request cache should be used for this request or not, defaults to index level setting"}, "refresh" => {"type"=>"boolean", "description"=>"Should the affected indexes be refreshed?"}, "timeout" => {"type"=>"time", "default"=>"1m", "description"=>"Time each individual bulk request should wait for shards that are unavailable."}, "wait_for_active_shards" => {"type"=>"string", "description"=>"Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"}, "scroll_size" => {"type"=>"number", "default"=>100, "description"=>"Size on the scroll request powering the delete by query"}, "wait_for_completion" => {"type"=>"boolean", "default"=>true, "description"=>"Should the request should block until the delete by query is complete."}, "requests_per_second" => {"type"=>"number", "default"=>0, "description"=>"The throttle for this request in sub-requests per second. -1 means no throttle."}, "slices" => {"type"=>"number|string", "default"=>1, "description"=>"The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`."}, } } ), "delete_by_query_rethrottle" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html", methods: ["POST"], body: nil, url: { path: "/_delete_by_query/{task_id}/_rethrottle", paths: ["/_delete_by_query/{task_id}/_rethrottle"], parts: { "task_id" => {"type"=>"string", "description"=>"The task id to rethrottle"}, }, params: { "requests_per_second" => {"type"=>"number", "required"=>true, "description"=>"The throttle to set on this request in floating sub-requests per second. -1 means set no throttle."}, } } ), "delete_script" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", methods: ["DELETE"], body: nil, url: { path: "/_scripts/{id}", paths: ["/_scripts/{id}"], parts: { "id" => {"type"=>"string", "description"=>"Script ID"}, }, params: { "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, } } ), "enrich.delete_policy" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html", methods: ["DELETE"], body: nil, url: { path: "/_enrich/policy/{name}", paths: ["/_enrich/policy/{name}"], parts: { "name" => {"type"=>"string", "description"=>"The name of the enrich policy"}, }, } ), "enrich.execute_policy" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/execute-enrich-policy-api.html", methods: ["PUT"], body: nil, url: { path: "/_enrich/policy/{name}/_execute", paths: ["/_enrich/policy/{name}/_execute"], parts: { "name" => {"type"=>"string", "description"=>"The name of the enrich policy"}, }, params: { "wait_for_completion" => {"type"=>"boolean", "default"=>true, "description"=>"Should the request should block until the execution is complete."}, } } ), "enrich.get_policy" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html", methods: ["GET"], body: nil, url: { path: "/_enrich/policy/{name}", paths: ["/_enrich/policy/{name}", "/_enrich/policy"], parts: { "name" => {"type"=>"list", "description"=>"A comma-separated list of enrich policy names"}, }, } ), "enrich.put_policy" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-enrich-policy-api.html", methods: ["PUT"], body: {"description"=>"The enrich policy to register", "required"=>true}, url: { path: "/_enrich/policy/{name}", paths: ["/_enrich/policy/{name}"], parts: { "name" => {"type"=>"string", "description"=>"The name of the enrich policy"}, }, } ), "enrich.stats" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html", methods: ["GET"], body: nil, url: { path: "/_enrich/_stats", paths: ["/_enrich/_stats"], } ), "eql.delete" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", methods: ["DELETE"], body: nil, url: { path: "/_eql/search/{id}", paths: ["/_eql/search/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The async search ID"}, }, } ), "eql.get" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", methods: ["GET"], body: nil, url: { path: "/_eql/search/{id}", paths: ["/_eql/search/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The async search ID"}, }, params: { "wait_for_completion_timeout" => {"type"=>"time", "description"=>"Specify the time that the request should block waiting for the final response"}, "keep_alive" => {"type"=>"time", "description"=>"Update the time interval in which the results (partial or final) for this search will be available", "default"=>"5d"}, } } ), "eql.get_status" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", methods: ["GET"], body: nil, url: { path: "/_eql/search/status/{id}", paths: ["/_eql/search/status/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The async search ID"}, }, } ), "eql.search" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", methods: ["GET", "POST"], body: {"description"=>"Eql request body. Use the `query` to limit the query scope.", "required"=>true}, url: { path: "/{index}/_eql/search", paths: ["/{index}/_eql/search"], parts: { "index" => {"type"=>"string", "description"=>"The name of the index to scope the operation"}, }, params: { "wait_for_completion_timeout" => {"type"=>"time", "description"=>"Specify the time that the request should block waiting for the final response"}, "keep_on_completion" => {"type"=>"boolean", "description"=>"Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false)", "default"=>false}, "keep_alive" => {"type"=>"time", "description"=>"Update the time interval in which the results (partial or final) for this search will be available", "default"=>"5d"}, } } ), "exists" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", methods: ["HEAD"], body: nil, url: { path: "/{index}/_doc/{id}", paths: ["/{index}/_doc/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The document ID"}, "index" => {"type"=>"string", "description"=>"The name of the index"}, }, params: { "stored_fields" => {"type"=>"list", "description"=>"A comma-separated list of stored fields to return in the response"}, "preference" => {"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "realtime" => {"type"=>"boolean", "description"=>"Specify whether to perform the operation in realtime or search mode"}, "refresh" => {"type"=>"boolean", "description"=>"Refresh the shard containing the document before performing the operation"}, "routing" => {"type"=>"string", "description"=>"Specific routing value"}, "_source" => {"type"=>"list", "description"=>"True or false to return the _source field or not, or a list of fields to return"}, "_source_excludes" => {"type"=>"list", "description"=>"A list of fields to exclude from the returned _source field"}, "_source_includes" => {"type"=>"list", "description"=>"A list of fields to extract and return from the _source field"}, "version" => {"type"=>"number", "description"=>"Explicit version number for concurrency control"}, "version_type" => {"type"=>"enum", "options"=>["internal", "external", "external_gte"], "description"=>"Specific version type"}, } } ), "exists_source" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", methods: ["HEAD"], body: nil, url: { path: "/{index}/_source/{id}", paths: ["/{index}/_source/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The document ID"}, "index" => {"type"=>"string", "description"=>"The name of the index"}, }, params: { "preference" => {"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "realtime" => {"type"=>"boolean", "description"=>"Specify whether to perform the operation in realtime or search mode"}, "refresh" => {"type"=>"boolean", "description"=>"Refresh the shard containing the document before performing the operation"}, "routing" => {"type"=>"string", "description"=>"Specific routing value"}, "_source" => {"type"=>"list", "description"=>"True or false to return the _source field or not, or a list of fields to return"}, "_source_excludes" => {"type"=>"list", "description"=>"A list of fields to exclude from the returned _source field"}, "_source_includes" => {"type"=>"list", "description"=>"A list of fields to extract and return from the _source field"}, "version" => {"type"=>"number", "description"=>"Explicit version number for concurrency control"}, "version_type" => {"type"=>"enum", "options"=>["internal", "external", "external_gte"], "description"=>"Specific version type"}, } } ), "explain" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html", methods: ["GET", "POST"], body: {"description"=>"The query definition using the Query DSL"}, url: { path: "/{index}/_explain/{id}", paths: ["/{index}/_explain/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The document ID"}, "index" => {"type"=>"string", "description"=>"The name of the index"}, }, params: { "analyze_wildcard" => {"type"=>"boolean", "description"=>"Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)"}, "analyzer" => {"type"=>"string", "description"=>"The analyzer for the query string query"}, "default_operator" => {"type"=>"enum", "options"=>["AND", "OR"], "default"=>"OR", "description"=>"The default operator for query string query (AND or OR)"}, "df" => {"type"=>"string", "description"=>"The default field for query string query (default: _all)"}, "stored_fields" => {"type"=>"list", "description"=>"A comma-separated list of stored fields to return in the response"}, "lenient" => {"type"=>"boolean", "description"=>"Specify whether format-based query failures (such as providing text to a numeric field) should be ignored"}, "preference" => {"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "q" => {"type"=>"string", "description"=>"Query in the Lucene query string syntax"}, "routing" => {"type"=>"string", "description"=>"Specific routing value"}, "_source" => {"type"=>"list", "description"=>"True or false to return the _source field or not, or a list of fields to return"}, "_source_excludes" => {"type"=>"list", "description"=>"A list of fields to exclude from the returned _source field"}, "_source_includes" => {"type"=>"list", "description"=>"A list of fields to extract and return from the _source field"}, } } ), "features.get_features" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-features-api.html", methods: ["GET"], body: nil, url: { path: "/_features", paths: ["/_features"], params: { "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, } } ), "features.reset_features" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", methods: ["POST"], body: nil, url: { path: "/_features/_reset", paths: ["/_features/_reset"], } ), "field_caps" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html", methods: ["GET", "POST"], body: {"description"=>"An index filter specified with the Query DSL"}, url: { path: "/_field_caps", paths: ["/_field_caps", "/{index}/_field_caps"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}, }, params: { "fields" => {"type"=>"list", "description"=>"A comma-separated list of field names"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "include_unmapped" => {"type"=>"boolean", "default"=>false, "description"=>"Indicates whether unmapped fields should be included in the response."}, "filters" => {"type"=>"list", "description"=>"An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent"}, "types" => {"type"=>"list", "description"=>"Only return results for fields that have one of the types in the list"}, } } ), "fleet.global_checkpoints" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-global-checkpoints.html", methods: ["GET"], body: nil, url: { path: "/{index}/_fleet/global_checkpoints", paths: ["/{index}/_fleet/global_checkpoints"], parts: { "index" => {"type"=>"string", "description"=>"The name of the index."}, }, params: { "wait_for_advance" => {"type"=>"boolean", "description"=>"Whether to wait for the global checkpoint to advance past the specified current checkpoints", "default"=>"false"}, "wait_for_index" => {"type"=>"boolean", "description"=>"Whether to wait for the target index to exist and all primary shards be active", "default"=>"false"}, "checkpoints" => {"type"=>"list", "description"=>"Comma separated list of checkpoints", "default"=>""}, "timeout" => {"type"=>"time", "description"=>"Timeout to wait for global checkpoint to advance", "default"=>"30s"}, } } ), "fleet.msearch" => RestApi.new( documentation: "", methods: ["GET", "POST"], body: {"description"=>"The request definitions (metadata-fleet search request definition pairs), separated by newlines", "required"=>true, "serialize"=>"bulk"}, url: { path: "/_fleet/_fleet_msearch", paths: ["/_fleet/_fleet_msearch", "/{index}/_fleet/_fleet_msearch"], parts: { "index" => {"type"=>"string", "description"=>"The index name to use as the default"}, }, } ), "fleet.search" => RestApi.new( documentation: "", methods: ["GET", "POST"], body: {"description"=>"The search definition using the Query DSL"}, url: { path: "/{index}/_fleet/_fleet_search", paths: ["/{index}/_fleet/_fleet_search"], parts: { "index" => {"type"=>"string", "description"=>"The index name to search."}, }, params: { "wait_for_checkpoints" => {"type"=>"list", "description"=>"Comma separated list of checkpoints, one per shard", "default"=>""}, "wait_for_checkpoints_timeout" => {"type"=>"time", "description"=>"Explicit wait_for_checkpoints timeout"}, "allow_partial_search_results" => {"type"=>"boolean", "default"=>true, "description"=>"Indicate if an error should be returned if there is a partial search failure or timeout"}, } } ), "get" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", methods: ["GET"], body: nil, url: { path: "/{index}/_doc/{id}", paths: ["/{index}/_doc/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The document ID"}, "index" => {"type"=>"string", "description"=>"The name of the index"}, }, params: { "force_synthetic_source" => {"type"=>"boolean", "description"=>"Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.", "visibility"=>"feature_flag", "feature_flag"=>"es.index_mode_feature_flag_registered"}, "stored_fields" => {"type"=>"list", "description"=>"A comma-separated list of stored fields to return in the response"}, "preference" => {"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "realtime" => {"type"=>"boolean", "description"=>"Specify whether to perform the operation in realtime or search mode"}, "refresh" => {"type"=>"boolean", "description"=>"Refresh the shard containing the document before performing the operation"}, "routing" => {"type"=>"string", "description"=>"Specific routing value"}, "_source" => {"type"=>"list", "description"=>"True or false to return the _source field or not, or a list of fields to return"}, "_source_excludes" => {"type"=>"list", "description"=>"A list of fields to exclude from the returned _source field"}, "_source_includes" => {"type"=>"list", "description"=>"A list of fields to extract and return from the _source field"}, "version" => {"type"=>"number", "description"=>"Explicit version number for concurrency control"}, "version_type" => {"type"=>"enum", "options"=>["internal", "external", "external_gte"], "description"=>"Specific version type"}, } } ), "get_script" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", methods: ["GET"], body: nil, url: { path: "/_scripts/{id}", paths: ["/_scripts/{id}"], parts: { "id" => {"type"=>"string", "description"=>"Script ID"}, }, params: { "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, } } ), "get_script_context" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html", methods: ["GET"], body: nil, url: { path: "/_script_context", paths: ["/_script_context"], } ), "get_script_languages" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", methods: ["GET"], body: nil, url: { path: "/_script_language", paths: ["/_script_language"], } ), "get_source" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", methods: ["GET"], body: nil, url: { path: "/{index}/_source/{id}", paths: ["/{index}/_source/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The document ID"}, "index" => {"type"=>"string", "description"=>"The name of the index"}, }, params: { "preference" => {"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "realtime" => {"type"=>"boolean", "description"=>"Specify whether to perform the operation in realtime or search mode"}, "refresh" => {"type"=>"boolean", "description"=>"Refresh the shard containing the document before performing the operation"}, "routing" => {"type"=>"string", "description"=>"Specific routing value"}, "_source" => {"type"=>"list", "description"=>"True or false to return the _source field or not, or a list of fields to return"}, "_source_excludes" => {"type"=>"list", "description"=>"A list of fields to exclude from the returned _source field"}, "_source_includes" => {"type"=>"list", "description"=>"A list of fields to extract and return from the _source field"}, "version" => {"type"=>"number", "description"=>"Explicit version number for concurrency control"}, "version_type" => {"type"=>"enum", "options"=>["internal", "external", "external_gte"], "description"=>"Specific version type"}, } } ), "graph.explore" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html", methods: ["GET", "POST"], body: {"description"=>"Graph Query DSL"}, url: { path: "/{index}/_graph/explore", paths: ["/{index}/_graph/explore"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices"}, }, params: { "routing" => {"type"=>"string", "description"=>"Specific routing value"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, } } ), "health_report" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html", methods: ["GET"], body: nil, url: { path: "/_health_report", paths: ["/_health_report", "/_health_report/{feature}"], parts: { "feature" => {"type"=>"string", "description"=>"A feature of the cluster, as returned by the top-level health API"}, }, params: { "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "verbose" => {"type"=>"boolean", "description"=>"Opt in for more information about the health of the system", "default"=>true}, "size" => {"type"=>"int", "description"=>"Limit the number of affected resources the health API returns", "default"=>1000}, } } ), "ilm.delete_lifecycle" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html", methods: ["DELETE"], body: nil, url: { path: "/_ilm/policy/{policy}", paths: ["/_ilm/policy/{policy}"], parts: { "policy" => {"type"=>"string", "description"=>"The name of the index lifecycle policy"}, }, } ), "ilm.explain_lifecycle" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html", methods: ["GET"], body: nil, url: { path: "/{index}/_ilm/explain", paths: ["/{index}/_ilm/explain"], parts: { "index" => {"type"=>"string", "description"=>"The name of the index to explain"}, }, params: { "only_managed" => {"type"=>"boolean", "description"=>"filters the indices included in the response to ones managed by ILM"}, "only_errors" => {"type"=>"boolean", "description"=>"filters the indices included in the response to ones in an ILM error state, implies only_managed"}, } } ), "ilm.get_lifecycle" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html", methods: ["GET"], body: nil, url: { path: "/_ilm/policy/{policy}", paths: ["/_ilm/policy/{policy}", "/_ilm/policy"], parts: { "policy" => {"type"=>"string", "description"=>"The name of the index lifecycle policy"}, }, } ), "ilm.get_status" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html", methods: ["GET"], body: nil, url: { path: "/_ilm/status", paths: ["/_ilm/status"], } ), "ilm.migrate_to_data_tiers" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html", methods: ["POST"], body: {"description"=>"Optionally specify a legacy index template name to delete and optionally specify a node attribute name used for index shard routing (defaults to \"data\")", "required"=>false}, url: { path: "/_ilm/migrate_to_data_tiers", paths: ["/_ilm/migrate_to_data_tiers"], params: { "dry_run" => {"type"=>"boolean", "description"=>"If set to true it will simulate the migration, providing a way to retrieve the ILM policies and indices that need to be migrated. The default is false"}, } } ), "ilm.move_to_step" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html", methods: ["POST"], body: {"description"=>"The new lifecycle step to move to"}, url: { path: "/_ilm/move/{index}", paths: ["/_ilm/move/{index}"], parts: { "index" => {"type"=>"string", "description"=>"The name of the index whose lifecycle step is to change"}, }, } ), "ilm.put_lifecycle" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html", methods: ["PUT"], body: {"description"=>"The lifecycle policy definition to register"}, url: { path: "/_ilm/policy/{policy}", paths: ["/_ilm/policy/{policy}"], parts: { "policy" => {"type"=>"string", "description"=>"The name of the index lifecycle policy"}, }, } ), "ilm.remove_policy" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html", methods: ["POST"], body: nil, url: { path: "/{index}/_ilm/remove", paths: ["/{index}/_ilm/remove"], parts: { "index" => {"type"=>"string", "description"=>"The name of the index to remove policy on"}, }, } ), "ilm.retry" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html", methods: ["POST"], body: nil, url: { path: "/{index}/_ilm/retry", paths: ["/{index}/_ilm/retry"], parts: { "index" => {"type"=>"string", "description"=>"The name of the indices (comma-separated) whose failed lifecycle step is to be retry"}, }, } ), "ilm.start" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html", methods: ["POST"], body: nil, url: { path: "/_ilm/start", paths: ["/_ilm/start"], } ), "ilm.stop" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html", methods: ["POST"], body: nil, url: { path: "/_ilm/stop", paths: ["/_ilm/stop"], } ), "index" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", methods: ["PUT", "POST"], body: {"description"=>"The document", "required"=>true}, url: { path: "/{index}/_doc/{id}", paths: ["/{index}/_doc/{id}", "/{index}/_doc"], parts: { "id" => {"type"=>"string", "description"=>"Document ID"}, "index" => {"type"=>"string", "description"=>"The name of the index"}, }, params: { "wait_for_active_shards" => {"type"=>"string", "description"=>"Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"}, "op_type" => {"type"=>"enum", "options"=>["index", "create"], "description"=>"Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID"}, "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes."}, "routing" => {"type"=>"string", "description"=>"Specific routing value"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "version" => {"type"=>"number", "description"=>"Explicit version number for concurrency control"}, "version_type" => {"type"=>"enum", "options"=>["internal", "external", "external_gte"], "description"=>"Specific version type"}, "if_seq_no" => {"type"=>"number", "description"=>"only perform the index operation if the last operation that has changed the document has the specified sequence number"}, "if_primary_term" => {"type"=>"number", "description"=>"only perform the index operation if the last operation that has changed the document has the specified primary term"}, "pipeline" => {"type"=>"string", "description"=>"The pipeline id to preprocess incoming documents with"}, "require_alias" => {"type"=>"boolean", "description"=>"When true, requires destination to be an alias. Default is false"}, } } ), "indices.add_block" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html", methods: ["PUT"], body: nil, url: { path: "/{index}/_block/{block}", paths: ["/{index}/_block/{block}"], parts: { "index" => {"type"=>"list", "description"=>"A comma separated list of indices to add a block to"}, "block" => {"type"=>"string", "description"=>"The block to add (one of read, write, read_only or metadata)"}, }, params: { "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, } } ), "indices.analyze" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html", methods: ["GET", "POST"], body: {"description"=>"Define analyzer/tokenizer parameters and the text on which the analysis should be performed"}, url: { path: "/_analyze", paths: ["/_analyze", "/{index}/_analyze"], parts: { "index" => {"type"=>"string", "description"=>"The name of the index to scope the operation"}, }, params: { "index" => {"type"=>"string", "description"=>"The name of the index to scope the operation"}, } } ), "indices.clear_cache" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html", methods: ["POST"], body: nil, url: { path: "/_cache/clear", paths: ["/_cache/clear", "/{index}/_cache/clear"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index name to limit the operation"}, }, params: { "fielddata" => {"type"=>"boolean", "description"=>"Clear field data"}, "fields" => {"type"=>"list", "description"=>"A comma-separated list of fields to clear when using the `fielddata` parameter (default: all)"}, "query" => {"type"=>"boolean", "description"=>"Clear query caches"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "index" => {"type"=>"list", "description"=>"A comma-separated list of index name to limit the operation"}, "request" => {"type"=>"boolean", "description"=>"Clear request cache"}, } } ), "indices.clone" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clone-index.html", methods: ["PUT", "POST"], body: {"description"=>"The configuration for the target index (`settings` and `aliases`)"}, url: { path: "/{index}/_clone/{target}", paths: ["/{index}/_clone/{target}"], parts: { "index" => {"type"=>"string", "description"=>"The name of the source index to clone"}, "target" => {"type"=>"string", "description"=>"The name of the target index to clone into"}, }, params: { "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, "wait_for_active_shards" => {"type"=>"string", "description"=>"Set the number of active shards to wait for on the cloned index before the operation returns."}, } } ), "indices.close" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html", methods: ["POST"], body: nil, url: { path: "/{index}/_close", paths: ["/{index}/_close"], parts: { "index" => {"type"=>"list", "description"=>"A comma separated list of indices to close"}, }, params: { "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "wait_for_active_shards" => {"type"=>"string", "description"=>"Sets the number of active shards to wait for before the operation returns."}, } } ), "indices.create" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html", methods: ["PUT"], body: {"description"=>"The configuration for the index (`settings` and `mappings`)"}, url: { path: "/{index}", paths: ["/{index}"], parts: { "index" => {"type"=>"string", "description"=>"The name of the index"}, }, params: { "wait_for_active_shards" => {"type"=>"string", "description"=>"Set the number of active shards to wait for before the operation returns."}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, } } ), "indices.create_data_stream" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", methods: ["PUT"], body: nil, url: { path: "/_data_stream/{name}", paths: ["/_data_stream/{name}"], parts: { "name" => {"type"=>"string", "description"=>"The name of the data stream"}, }, } ), "indices.data_streams_stats" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", methods: ["GET"], body: nil, url: { path: "/_data_stream/_stats", paths: ["/_data_stream/_stats", "/_data_stream/{name}/_stats"], parts: { "name" => {"type"=>"list", "description"=>"A comma-separated list of data stream names; use `_all` or empty string to perform the operation on all data streams"}, }, } ), "indices.delete" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html", methods: ["DELETE"], body: nil, url: { path: "/{index}", paths: ["/{index}"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices"}, }, params: { "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Ignore unavailable indexes (default: false)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Ignore if a wildcard expression resolves to no concrete indices (default: false)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open,closed", "description"=>"Whether wildcard expressions should get expanded to open, closed, or hidden indices"}, } } ), "indices.delete_alias" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", methods: ["DELETE"], body: nil, url: { path: "/{index}/_alias/{name}", paths: ["/{index}/_alias/{name}", "/{index}/_aliases/{name}"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names (supports wildcards); use `_all` for all indices"}, "name" => {"type"=>"list", "description"=>"A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices."}, }, params: { "timeout" => {"type"=>"time", "description"=>"Explicit timestamp for the document"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, } } ), "indices.delete_data_stream" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", methods: ["DELETE"], body: nil, url: { path: "/_data_stream/{name}", paths: ["/_data_stream/{name}"], parts: { "name" => {"type"=>"list", "description"=>"A comma-separated list of data streams to delete; use `*` to delete all data streams"}, }, params: { "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether wildcard expressions should get expanded to open or closed indices (default: open)"}, } } ), "indices.delete_index_template" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", methods: ["DELETE"], body: nil, url: { path: "/_index_template/{name}", paths: ["/_index_template/{name}"], parts: { "name" => {"type"=>"string", "description"=>"The name of the template"}, }, params: { "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, } } ), "indices.delete_template" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", methods: ["DELETE"], body: nil, url: { path: "/_template/{name}", paths: ["/_template/{name}"], parts: { "name" => {"type"=>"string", "description"=>"The name of the template"}, }, params: { "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, } } ), "indices.disk_usage" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-disk-usage.html", methods: ["POST"], body: nil, url: { path: "/{index}/_disk_usage", paths: ["/{index}/_disk_usage"], parts: { "index" => {"type"=>"string", "description"=>"Comma-separated list of indices or data streams to analyze the disk usage"}, }, params: { "run_expensive_tasks" => {"type"=>"boolean", "description"=>"Must be set to [true] in order for the task to be performed. Defaults to false."}, "flush" => {"type"=>"boolean", "description"=>"Whether flush or not before analyzing the index disk usage. Defaults to true"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, } } ), "indices.downsample" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-rollup.html", methods: ["POST"], body: {"description"=>"The downsampling configuration", "required"=>true}, url: { path: "/{index}/_downsample/{target_index}", paths: ["/{index}/_downsample/{target_index}"], parts: { "index" => {"type"=>"string", "description"=>"The index to downsample", "required"=>true}, "target_index" => {"type"=>"string", "description"=>"The name of the target index to store downsampled data", "required"=>true}, }, } ), "indices.exists" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html", methods: ["HEAD"], body: nil, url: { path: "/{index}", paths: ["/{index}"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names"}, }, params: { "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Ignore unavailable indexes (default: false)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Ignore if a wildcard expression resolves to no concrete indices (default: false)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether wildcard expressions should get expanded to open or closed indices (default: open)"}, "flat_settings" => {"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "include_defaults" => {"type"=>"boolean", "description"=>"Whether to return all default setting for each of the indices.", "default"=>false}, } } ), "indices.exists_alias" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", methods: ["HEAD"], body: nil, url: { path: "/_alias/{name}", paths: ["/_alias/{name}", "/{index}/_alias/{name}"], parts: { "name" => {"type"=>"list", "description"=>"A comma-separated list of alias names to return"}, "index" => {"type"=>"list", "description"=>"A comma-separated list of index names to filter aliases"}, }, params: { "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"all", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, } } ), "indices.exists_index_template" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", methods: ["HEAD"], body: nil, url: { path: "/_index_template/{name}", paths: ["/_index_template/{name}"], parts: { "name" => {"type"=>"string", "description"=>"The name of the template"}, }, params: { "flat_settings" => {"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, } } ), "indices.exists_template" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", methods: ["HEAD"], body: nil, url: { path: "/_template/{name}", paths: ["/_template/{name}"], parts: { "name" => {"type"=>"list", "description"=>"The comma separated names of the index templates"}, }, params: { "flat_settings" => {"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, } } ), "indices.field_usage_stats" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/field-usage-stats.html", methods: ["GET"], body: nil, url: { path: "/{index}/_field_usage_stats", paths: ["/{index}/_field_usage_stats"], parts: { "index" => {"type"=>"string", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}, }, params: { "fields" => {"type"=>"list", "description"=>"A comma-separated list of fields to include in the stats if only a subset of fields should be returned (supports wildcards)"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, } } ), "indices.flush" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html", methods: ["POST", "GET"], body: nil, url: { path: "/_flush", paths: ["/_flush", "/{index}/_flush"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string for all indices"}, }, params: { "force" => {"type"=>"boolean", "description"=>"Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)"}, "wait_if_ongoing" => {"type"=>"boolean", "description"=>"If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running."}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, } } ), "indices.forcemerge" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html", methods: ["POST"], body: nil, url: { path: "/_forcemerge", paths: ["/_forcemerge", "/{index}/_forcemerge"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}, }, params: { "flush" => {"type"=>"boolean", "description"=>"Specify whether the index should be flushed after performing the operation (default: true)"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "max_num_segments" => {"type"=>"number", "description"=>"The number of segments the index should be merged into (default: dynamic)"}, "only_expunge_deletes" => {"type"=>"boolean", "description"=>"Specify whether the operation should only expunge deleted documents"}, "wait_for_completion" => {"type"=>"boolean", "default"=>true, "description"=>"Should the request wait until the force merge is completed."}, } } ), "indices.get" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html", methods: ["GET"], body: nil, url: { path: "/{index}", paths: ["/{index}"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names"}, }, params: { "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Ignore unavailable indexes (default: false)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Ignore if a wildcard expression resolves to no concrete indices (default: false)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether wildcard expressions should get expanded to open or closed indices (default: open)"}, "features" => {"type"=>"enum", "options"=>["aliases", "mappings", "settings"], "default"=>"aliases,mappings,settings", "description"=>"Return only information on specified index features"}, "flat_settings" => {"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "include_defaults" => {"type"=>"boolean", "description"=>"Whether to return all default setting for each of the indices.", "default"=>false}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, } } ), "indices.get_alias" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", methods: ["GET"], body: nil, url: { path: "/_alias", paths: ["/_alias", "/_alias/{name}", "/{index}/_alias/{name}", "/{index}/_alias"], parts: { "name" => {"type"=>"list", "description"=>"A comma-separated list of alias names to return"}, "index" => {"type"=>"list", "description"=>"A comma-separated list of index names to filter aliases"}, }, params: { "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"all", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, } } ), "indices.get_data_stream" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", methods: ["GET"], body: nil, url: { path: "/_data_stream", paths: ["/_data_stream", "/_data_stream/{name}"], parts: { "name" => {"type"=>"list", "description"=>"A comma-separated list of data streams to get; use `*` to get all data streams"}, }, params: { "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether wildcard expressions should get expanded to open or closed indices (default: open)"}, } } ), "indices.get_field_mapping" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html", methods: ["GET"], body: nil, url: { path: "/_mapping/field/{fields}", paths: ["/_mapping/field/{fields}", "/{index}/_mapping/field/{fields}"], parts: { "fields" => {"type"=>"list", "description"=>"A comma-separated list of fields"}, "index" => {"type"=>"list", "description"=>"A comma-separated list of index names"}, }, params: { "include_defaults" => {"type"=>"boolean", "description"=>"Whether the default mapping values should be returned as well"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, } } ), "indices.get_index_template" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", methods: ["GET"], body: nil, url: { path: "/_index_template", paths: ["/_index_template", "/_index_template/{name}"], parts: { "name" => {"type"=>"string", "description"=>"A pattern that returned template names must match"}, }, params: { "flat_settings" => {"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, } } ), "indices.get_mapping" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html", methods: ["GET"], body: nil, url: { path: "/_mapping", paths: ["/_mapping", "/{index}/_mapping"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names"}, }, params: { "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)", "deprecated"=>{"version"=>"7.8.0", "description"=>"This parameter is a no-op and field mappings are always retrieved locally."}}, } } ), "indices.get_settings" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html", methods: ["GET"], body: nil, url: { path: "/_settings", paths: ["/_settings", "/{index}/_settings", "/{index}/_settings/{name}", "/_settings/{name}"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}, "name" => {"type"=>"list", "description"=>"The name of the settings that should be included"}, }, params: { "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"all", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "flat_settings" => {"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "include_defaults" => {"type"=>"boolean", "description"=>"Whether to return all default setting for each of the indices.", "default"=>false}, } } ), "indices.get_template" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", methods: ["GET"], body: nil, url: { path: "/_template", paths: ["/_template", "/_template/{name}"], parts: { "name" => {"type"=>"list", "description"=>"The comma separated names of the index templates"}, }, params: { "flat_settings" => {"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, } } ), "indices.migrate_to_data_stream" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", methods: ["POST"], body: nil, url: { path: "/_data_stream/_migrate/{name}", paths: ["/_data_stream/_migrate/{name}"], parts: { "name" => {"type"=>"string", "description"=>"The name of the alias to migrate"}, }, } ), "indices.modify_data_stream" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", methods: ["POST"], body: {"description"=>"The data stream modifications", "required"=>true}, url: { path: "/_data_stream/_modify", paths: ["/_data_stream/_modify"], } ), "indices.open" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html", methods: ["POST"], body: nil, url: { path: "/{index}/_open", paths: ["/{index}/_open"], parts: { "index" => {"type"=>"list", "description"=>"A comma separated list of indices to open"}, }, params: { "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"closed", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "wait_for_active_shards" => {"type"=>"string", "description"=>"Sets the number of active shards to wait for before the operation returns."}, } } ), "indices.promote_data_stream" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", methods: ["POST"], body: nil, url: { path: "/_data_stream/_promote/{name}", paths: ["/_data_stream/_promote/{name}"], parts: { "name" => {"type"=>"string", "description"=>"The name of the data stream"}, }, } ), "indices.put_alias" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", methods: ["PUT", "POST"], body: {"description"=>"The settings for the alias, such as `routing` or `filter`", "required"=>false}, url: { path: "/{index}/_alias/{name}", paths: ["/{index}/_alias/{name}", "/{index}/_aliases/{name}"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices."}, "name" => {"type"=>"string", "description"=>"The name of the alias to be created or updated"}, }, params: { "timeout" => {"type"=>"time", "description"=>"Explicit timestamp for the document"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, } } ), "indices.put_index_template" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", methods: ["PUT", "POST"], body: {"description"=>"The template definition", "required"=>true}, url: { path: "/_index_template/{name}", paths: ["/_index_template/{name}"], parts: { "name" => {"type"=>"string", "description"=>"The name of the template"}, }, params: { "create" => {"type"=>"boolean", "description"=>"Whether the index template should only be added if new or can also replace an existing one", "default"=>false}, "cause" => {"type"=>"string", "description"=>"User defined reason for creating/updating the index template", "default"=>false}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, } } ), "indices.put_mapping" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html", methods: ["PUT", "POST"], body: {"description"=>"The mapping definition", "required"=>true}, url: { path: "/{index}/_mapping", paths: ["/{index}/_mapping"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices."}, }, params: { "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "write_index_only" => {"type"=>"boolean", "default"=>false, "description"=>"When true, applies mappings only to the write index of an alias or data stream"}, } } ), "indices.put_settings" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html", methods: ["PUT"], body: {"description"=>"The index settings to be updated", "required"=>true}, url: { path: "/_settings", paths: ["/_settings", "/{index}/_settings"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}, }, params: { "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "preserve_existing" => {"type"=>"boolean", "description"=>"Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false`"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "flat_settings" => {"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, } } ), "indices.put_template" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", methods: ["PUT", "POST"], body: {"description"=>"The template definition", "required"=>true}, url: { path: "/_template/{name}", paths: ["/_template/{name}"], parts: { "name" => {"type"=>"string", "description"=>"The name of the template"}, }, params: { "order" => {"type"=>"number", "description"=>"The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)"}, "create" => {"type"=>"boolean", "description"=>"Whether the index template should only be added if new or can also replace an existing one", "default"=>false}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, } } ), "indices.recovery" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html", methods: ["GET"], body: nil, url: { path: "/_recovery", paths: ["/_recovery", "/{index}/_recovery"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}, }, params: { "detailed" => {"type"=>"boolean", "description"=>"Whether to display detailed information about shard recovery", "default"=>false}, "active_only" => {"type"=>"boolean", "description"=>"Display only those recoveries that are currently on-going", "default"=>false}, } } ), "indices.refresh" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html", methods: ["POST", "GET"], body: nil, url: { path: "/_refresh", paths: ["/_refresh", "/{index}/_refresh"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}, }, params: { "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, } } ), "indices.reload_search_analyzers" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-reload-analyzers.html", methods: ["GET", "POST"], body: nil, url: { path: "/{index}/_reload_search_analyzers", paths: ["/{index}/_reload_search_analyzers"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names to reload analyzers for"}, }, params: { "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, } } ), "indices.resolve_index" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html", methods: ["GET"], body: nil, url: { path: "/_resolve/index/{name}", paths: ["/_resolve/index/{name}"], parts: { "name" => {"type"=>"list", "description"=>"A comma-separated list of names or wildcard expressions"}, }, params: { "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether wildcard expressions should get expanded to open or closed indices (default: open)"}, } } ), "indices.rollover" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-rollover-index.html", methods: ["POST"], body: {"description"=>"The conditions that needs to be met for executing rollover"}, url: { path: "/{alias}/_rollover", paths: ["/{alias}/_rollover", "/{alias}/_rollover/{new_index}"], parts: { "alias" => {"type"=>"string", "description"=>"The name of the alias to rollover"}, "new_index" => {"type"=>"string", "description"=>"The name of the rollover index"}, }, params: { "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "dry_run" => {"type"=>"boolean", "description"=>"If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, "wait_for_active_shards" => {"type"=>"string", "description"=>"Set the number of active shards to wait for on the newly created rollover index before the operation returns."}, } } ), "indices.segments" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html", methods: ["GET"], body: nil, url: { path: "/_segments", paths: ["/_segments", "/{index}/_segments"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}, }, params: { "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "verbose" => {"type"=>"boolean", "description"=>"Includes detailed memory usage by Lucene.", "default"=>false, "deprecated"=>{"version"=>"8.0.0", "description"=>"lucene no longer keeps track of segment memory overhead as it is largely off-heap"}}, } } ), "indices.shard_stores" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html", methods: ["GET"], body: nil, url: { path: "/_shard_stores", paths: ["/_shard_stores", "/{index}/_shard_stores"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}, }, params: { "status" => {"type"=>"list", "options"=>["green", "yellow", "red", "all"], "description"=>"A comma-separated list of statuses used to filter on shards to get store information for"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, } } ), "indices.shrink" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shrink-index.html", methods: ["PUT", "POST"], body: {"description"=>"The configuration for the target index (`settings` and `aliases`)"}, url: { path: "/{index}/_shrink/{target}", paths: ["/{index}/_shrink/{target}"], parts: { "index" => {"type"=>"string", "description"=>"The name of the source index to shrink"}, "target" => {"type"=>"string", "description"=>"The name of the target index to shrink into"}, }, params: { "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, "wait_for_active_shards" => {"type"=>"string", "description"=>"Set the number of active shards to wait for on the shrunken index before the operation returns."}, } } ), "indices.simulate_index_template" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", methods: ["POST"], body: {"description"=>"New index template definition, which will be included in the simulation, as if it already exists in the system", "required"=>false}, url: { path: "/_index_template/_simulate_index/{name}", paths: ["/_index_template/_simulate_index/{name}"], parts: { "name" => {"type"=>"string", "description"=>"The name of the index (it must be a concrete index name)"}, }, params: { "create" => {"type"=>"boolean", "description"=>"Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one", "default"=>false}, "cause" => {"type"=>"string", "description"=>"User defined reason for dry-run creating the new template for simulation purposes", "default"=>false}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, } } ), "indices.simulate_template" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", methods: ["POST"], body: {"description"=>"New index template definition to be simulated, if no index template name is specified", "required"=>false}, url: { path: "/_index_template/_simulate", paths: ["/_index_template/_simulate", "/_index_template/_simulate/{name}"], parts: { "name" => {"type"=>"string", "description"=>"The name of the index template"}, }, params: { "create" => {"type"=>"boolean", "description"=>"Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one", "default"=>false}, "cause" => {"type"=>"string", "description"=>"User defined reason for dry-run creating the new template for simulation purposes", "default"=>false}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, } } ), "indices.split" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-split-index.html", methods: ["PUT", "POST"], body: {"description"=>"The configuration for the target index (`settings` and `aliases`)"}, url: { path: "/{index}/_split/{target}", paths: ["/{index}/_split/{target}"], parts: { "index" => {"type"=>"string", "description"=>"The name of the source index to split"}, "target" => {"type"=>"string", "description"=>"The name of the target index to split into"}, }, params: { "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, "wait_for_active_shards" => {"type"=>"string", "description"=>"Set the number of active shards to wait for on the shrunken index before the operation returns."}, } } ), "indices.stats" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html", methods: ["GET"], body: nil, url: { path: "/_stats", paths: ["/_stats", "/_stats/{metric}", "/{index}/_stats", "/{index}/_stats/{metric}"], parts: { "metric" => {"type"=>"list", "options"=>["_all", "completion", "docs", "fielddata", "query_cache", "flush", "get", "indexing", "merge", "request_cache", "refresh", "search", "segments", "store", "warmer", "bulk"], "description"=>"Limit the information returned the specific metrics."}, "index" => {"type"=>"list", "description"=>"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"}, }, params: { "completion_fields" => {"type"=>"list", "description"=>"A comma-separated list of fields for the `completion` index metric (supports wildcards)"}, "fielddata_fields" => {"type"=>"list", "description"=>"A comma-separated list of fields for the `fielddata` index metric (supports wildcards)"}, "fields" => {"type"=>"list", "description"=>"A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)"}, "groups" => {"type"=>"list", "description"=>"A comma-separated list of search groups for `search` index metric"}, "level" => {"type"=>"enum", "description"=>"Return stats aggregated at cluster, index or shard level", "options"=>["cluster", "indices", "shards"], "default"=>"indices"}, "include_segment_file_sizes" => {"type"=>"boolean", "description"=>"Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)", "default"=>false}, "include_unloaded_segments" => {"type"=>"boolean", "description"=>"If set to true segment stats will include stats for segments that are not currently loaded into memory", "default"=>false}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "forbid_closed_indices" => {"type"=>"boolean", "description"=>"If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices", "default"=>true}, } } ), "indices.unfreeze" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/unfreeze-index-api.html", methods: ["POST"], body: nil, url: { path: "/{index}/_unfreeze", paths: ["/{index}/_unfreeze"], parts: { "index" => {"type"=>"string", "description"=>"The name of the index to unfreeze"}, }, params: { "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"closed", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "wait_for_active_shards" => {"type"=>"string", "description"=>"Sets the number of active shards to wait for before the operation returns."}, } } ), "indices.update_aliases" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", methods: ["POST"], body: {"description"=>"The definition of `actions` to perform", "required"=>true}, url: { path: "/_aliases", paths: ["/_aliases"], params: { "timeout" => {"type"=>"time", "description"=>"Request timeout"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, } } ), "indices.validate_query" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html", methods: ["GET", "POST"], body: {"description"=>"The query definition specified with the Query DSL"}, url: { path: "/_validate/query", paths: ["/_validate/query", "/{index}/_validate/query"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices"}, }, params: { "explain" => {"type"=>"boolean", "description"=>"Return detailed information about the error"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "q" => {"type"=>"string", "description"=>"Query in the Lucene query string syntax"}, "analyzer" => {"type"=>"string", "description"=>"The analyzer to use for the query string"}, "analyze_wildcard" => {"type"=>"boolean", "description"=>"Specify whether wildcard and prefix queries should be analyzed (default: false)"}, "default_operator" => {"type"=>"enum", "options"=>["AND", "OR"], "default"=>"OR", "description"=>"The default operator for query string query (AND or OR)"}, "df" => {"type"=>"string", "description"=>"The field to use as default where no field prefix is given in the query string"}, "lenient" => {"type"=>"boolean", "description"=>"Specify whether format-based query failures (such as providing text to a numeric field) should be ignored"}, "rewrite" => {"type"=>"boolean", "description"=>"Provide a more detailed explanation showing the actual Lucene query that will be executed."}, "all_shards" => {"type"=>"boolean", "description"=>"Execute validation on all shards instead of one random shard per index"}, } } ), "info" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", methods: ["GET"], body: nil, url: { path: "/", paths: ["/"], } ), "ingest.delete_pipeline" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html", methods: ["DELETE"], body: nil, url: { path: "/_ingest/pipeline/{id}", paths: ["/_ingest/pipeline/{id}"], parts: { "id" => {"type"=>"string", "description"=>"Pipeline ID"}, }, params: { "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, } } ), "ingest.geo_ip_stats" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/geoip-stats-api.html", methods: ["GET"], body: nil, url: { path: "/_ingest/geoip/stats", paths: ["/_ingest/geoip/stats"], } ), "ingest.get_pipeline" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html", methods: ["GET"], body: nil, url: { path: "/_ingest/pipeline", paths: ["/_ingest/pipeline", "/_ingest/pipeline/{id}"], parts: { "id" => {"type"=>"string", "description"=>"Comma separated list of pipeline ids. Wildcards supported"}, }, params: { "summary" => {"type"=>"boolean", "description"=>"Return pipelines without their definitions (default: false)"}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, } } ), "ingest.processor_grok" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/grok-processor.html#grok-processor-rest-get", methods: ["GET"], body: nil, url: { path: "/_ingest/processor/grok", paths: ["/_ingest/processor/grok"], } ), "ingest.put_pipeline" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-pipeline-api.html", methods: ["PUT"], body: {"description"=>"The ingest definition", "required"=>true}, url: { path: "/_ingest/pipeline/{id}", paths: ["/_ingest/pipeline/{id}"], parts: { "id" => {"type"=>"string", "description"=>"Pipeline ID"}, }, params: { "if_version" => {"type"=>"int", "description"=>"Required version for optimistic concurrency control for pipeline updates"}, "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, } } ), "ingest.simulate" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html", methods: ["GET", "POST"], body: {"description"=>"The simulate definition", "required"=>true}, url: { path: "/_ingest/pipeline/_simulate", paths: ["/_ingest/pipeline/_simulate", "/_ingest/pipeline/{id}/_simulate"], parts: { "id" => {"type"=>"string", "description"=>"Pipeline ID"}, }, params: { "verbose" => {"type"=>"boolean", "description"=>"Verbose mode. Display data output for each processor in executed pipeline", "default"=>false}, } } ), "knn_search" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html", methods: ["GET", "POST"], body: {"description"=>"The search definition"}, url: { path: "/{index}/_knn_search", paths: ["/{index}/_knn_search"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names to search; use `_all` to perform the operation on all indices"}, }, params: { "routing" => {"type"=>"list", "description"=>"A comma-separated list of specific routing values"}, } } ), "license.delete" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-license.html", methods: ["DELETE"], body: nil, url: { path: "/_license", paths: ["/_license"], } ), "license.get" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html", methods: ["GET"], body: nil, url: { path: "/_license", paths: ["/_license"], params: { "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "accept_enterprise" => {"type"=>"boolean", "description"=>"Supported for backwards compatibility with 7.x. If this param is used it must be set to true", "deprecated"=>true}, } } ), "license.get_basic_status" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-basic-status.html", methods: ["GET"], body: nil, url: { path: "/_license/basic_status", paths: ["/_license/basic_status"], } ), "license.get_trial_status" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-trial-status.html", methods: ["GET"], body: nil, url: { path: "/_license/trial_status", paths: ["/_license/trial_status"], } ), "license.post" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-license.html", methods: ["PUT", "POST"], body: {"description"=>"licenses to be installed"}, url: { path: "/_license", paths: ["/_license"], params: { "acknowledge" => {"type"=>"boolean", "description"=>"whether the user has acknowledged acknowledge messages (default: false)"}, } } ), "license.post_start_basic" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-basic.html", methods: ["POST"], body: nil, url: { path: "/_license/start_basic", paths: ["/_license/start_basic"], params: { "acknowledge" => {"type"=>"boolean", "description"=>"whether the user has acknowledged acknowledge messages (default: false)"}, } } ), "license.post_start_trial" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trial.html", methods: ["POST"], body: nil, url: { path: "/_license/start_trial", paths: ["/_license/start_trial"], params: { "type" => {"type"=>"string", "description"=>"The type of trial license to generate (default: \"trial\")"}, "acknowledge" => {"type"=>"boolean", "description"=>"whether the user has acknowledged acknowledge messages (default: false)"}, } } ), "logstash.delete_pipeline" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html", methods: ["DELETE"], body: nil, url: { path: "/_logstash/pipeline/{id}", paths: ["/_logstash/pipeline/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The ID of the Pipeline"}, }, } ), "logstash.get_pipeline" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html", methods: ["GET"], body: nil, url: { path: "/_logstash/pipeline", paths: ["/_logstash/pipeline", "/_logstash/pipeline/{id}"], parts: { "id" => {"type"=>"string", "description"=>"A comma-separated list of Pipeline IDs"}, }, } ), "logstash.put_pipeline" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html", methods: ["PUT"], body: {"description"=>"The Pipeline to add or update", "required"=>true}, url: { path: "/_logstash/pipeline/{id}", paths: ["/_logstash/pipeline/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The ID of the Pipeline"}, }, } ), "mget" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html", methods: ["GET", "POST"], body: {"description"=>"Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is provided in the URL.", "required"=>true}, url: { path: "/_mget", paths: ["/_mget", "/{index}/_mget"], parts: { "index" => {"type"=>"string", "description"=>"The name of the index"}, }, params: { "force_synthetic_source" => {"type"=>"boolean", "description"=>"Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.", "visibility"=>"feature_flag", "feature_flag"=>"es.index_mode_feature_flag_registered"}, "stored_fields" => {"type"=>"list", "description"=>"A comma-separated list of stored fields to return in the response"}, "preference" => {"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "realtime" => {"type"=>"boolean", "description"=>"Specify whether to perform the operation in realtime or search mode"}, "refresh" => {"type"=>"boolean", "description"=>"Refresh the shard containing the document before performing the operation"}, "routing" => {"type"=>"string", "description"=>"Specific routing value"}, "_source" => {"type"=>"list", "description"=>"True or false to return the _source field or not, or a list of fields to return"}, "_source_excludes" => {"type"=>"list", "description"=>"A list of fields to exclude from the returned _source field"}, "_source_includes" => {"type"=>"list", "description"=>"A list of fields to extract and return from the _source field"}, } } ), "migration.deprecations" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html", methods: ["GET"], body: nil, url: { path: "/_migration/deprecations", paths: ["/_migration/deprecations", "/{index}/_migration/deprecations"], parts: { "index" => {"type"=>"string", "description"=>"Index pattern"}, }, } ), "migration.get_feature_upgrade_status" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", methods: ["GET"], body: nil, url: { path: "/_migration/system_features", paths: ["/_migration/system_features"], } ), "migration.post_feature_upgrade" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", methods: ["POST"], body: nil, url: { path: "/_migration/system_features", paths: ["/_migration/system_features"], } ), "ml.clear_trained_model_deployment_cache" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/clear-trained-model-deployment-cache.html", methods: ["POST"], body: nil, url: { path: "/_ml/trained_models/{model_id}/deployment/cache/_clear", paths: ["/_ml/trained_models/{model_id}/deployment/cache/_clear"], parts: { "model_id" => {"type"=>"string", "description"=>"The unique identifier of the trained model.", "required"=>true}, }, } ), "ml.close_job" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html", methods: ["POST"], body: {"description"=>"The URL params optionally sent in the body", "required"=>false}, url: { path: "/_ml/anomaly_detectors/{job_id}/_close", paths: ["/_ml/anomaly_detectors/{job_id}/_close"], parts: { "job_id" => {"type"=>"string", "description"=>"The name of the job to close"}, }, params: { "allow_no_match" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)"}, "force" => {"type"=>"boolean", "required"=>false, "description"=>"True if the job should be forcefully closed"}, "timeout" => {"type"=>"time", "description"=>"Controls the time to wait until a job has closed. Default to 30 minutes"}, } } ), "ml.delete_calendar" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html", methods: ["DELETE"], body: nil, url: { path: "/_ml/calendars/{calendar_id}", paths: ["/_ml/calendars/{calendar_id}"], parts: { "calendar_id" => {"type"=>"string", "description"=>"The ID of the calendar to delete"}, }, } ), "ml.delete_calendar_event" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html", methods: ["DELETE"], body: nil, url: { path: "/_ml/calendars/{calendar_id}/events/{event_id}", paths: ["/_ml/calendars/{calendar_id}/events/{event_id}"], parts: { "calendar_id" => {"type"=>"string", "description"=>"The ID of the calendar to modify"}, "event_id" => {"type"=>"string", "description"=>"The ID of the event to remove from the calendar"}, }, } ), "ml.delete_calendar_job" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html", methods: ["DELETE"], body: nil, url: { path: "/_ml/calendars/{calendar_id}/jobs/{job_id}", paths: ["/_ml/calendars/{calendar_id}/jobs/{job_id}"], parts: { "calendar_id" => {"type"=>"string", "description"=>"The ID of the calendar to modify"}, "job_id" => {"type"=>"string", "description"=>"The ID of the job to remove from the calendar"}, }, } ), "ml.delete_data_frame_analytics" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html", methods: ["DELETE"], body: nil, url: { path: "/_ml/data_frame/analytics/{id}", paths: ["/_ml/data_frame/analytics/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The ID of the data frame analytics to delete"}, }, params: { "force" => {"type"=>"boolean", "description"=>"True if the job should be forcefully deleted", "default"=>false}, "timeout" => {"type"=>"time", "description"=>"Controls the time to wait until a job is deleted. Defaults to 1 minute"}, } } ), "ml.delete_datafeed" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html", methods: ["DELETE"], body: nil, url: { path: "/_ml/datafeeds/{datafeed_id}", paths: ["/_ml/datafeeds/{datafeed_id}"], parts: { "datafeed_id" => {"type"=>"string", "description"=>"The ID of the datafeed to delete"}, }, params: { "force" => {"type"=>"boolean", "required"=>false, "description"=>"True if the datafeed should be forcefully deleted"}, } } ), "ml.delete_expired_data" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html", methods: ["DELETE"], body: {"description"=>"deleting expired data parameters"}, url: { path: "/_ml/_delete_expired_data/{job_id}", paths: ["/_ml/_delete_expired_data/{job_id}", "/_ml/_delete_expired_data"], parts: { "job_id" => {"type"=>"string", "description"=>"The ID of the job(s) to perform expired data hygiene for"}, }, params: { "requests_per_second" => {"type"=>"number", "required"=>false, "description"=>"The desired requests per second for the deletion processes."}, "timeout" => {"type"=>"time", "required"=>false, "description"=>"How long can the underlying delete processes run until they are canceled"}, } } ), "ml.delete_filter" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html", methods: ["DELETE"], body: nil, url: { path: "/_ml/filters/{filter_id}", paths: ["/_ml/filters/{filter_id}"], parts: { "filter_id" => {"type"=>"string", "description"=>"The ID of the filter to delete"}, }, } ), "ml.delete_forecast" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html", methods: ["DELETE"], body: nil, url: { path: "/_ml/anomaly_detectors/{job_id}/_forecast", paths: ["/_ml/anomaly_detectors/{job_id}/_forecast", "/_ml/anomaly_detectors/{job_id}/_forecast/{forecast_id}"], parts: { "job_id" => {"type"=>"string", "description"=>"The ID of the job from which to delete forecasts"}, "forecast_id" => {"type"=>"string", "description"=>"The ID of the forecast to delete, can be comma delimited list. Leaving blank implies `_all`"}, }, params: { "allow_no_forecasts" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if `_all` matches no forecasts"}, "timeout" => {"type"=>"time", "required"=>false, "description"=>"Controls the time to wait until the forecast(s) are deleted. Default to 30 seconds"}, } } ), "ml.delete_job" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html", methods: ["DELETE"], body: nil, url: { path: "/_ml/anomaly_detectors/{job_id}", paths: ["/_ml/anomaly_detectors/{job_id}"], parts: { "job_id" => {"type"=>"string", "description"=>"The ID of the job to delete"}, }, params: { "force" => {"type"=>"boolean", "description"=>"True if the job should be forcefully deleted", "default"=>false}, "wait_for_completion" => {"type"=>"boolean", "description"=>"Should this request wait until the operation has completed before returning", "default"=>true}, "delete_user_annotations" => {"type"=>"boolean", "description"=>"Should annotations added by the user be deleted", "default"=>false}, } } ), "ml.delete_model_snapshot" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html", methods: ["DELETE"], body: nil, url: { path: "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}", paths: ["/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}"], parts: { "job_id" => {"type"=>"string", "description"=>"The ID of the job to fetch"}, "snapshot_id" => {"type"=>"string", "description"=>"The ID of the snapshot to delete"}, }, } ), "ml.delete_trained_model" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html", methods: ["DELETE"], body: nil, url: { path: "/_ml/trained_models/{model_id}", paths: ["/_ml/trained_models/{model_id}"], parts: { "model_id" => {"type"=>"string", "description"=>"The ID of the trained model to delete"}, }, params: { "timeout" => {"type"=>"time", "required"=>false, "description"=>"Controls the amount of time to wait for the model to be deleted.", "default"=>"30s"}, "force" => {"type"=>"boolean", "required"=>false, "description"=>"True if the model should be forcefully deleted"}, } } ), "ml.delete_trained_model_alias" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html", methods: ["DELETE"], body: nil, url: { path: "/_ml/trained_models/{model_id}/model_aliases/{model_alias}", paths: ["/_ml/trained_models/{model_id}/model_aliases/{model_alias}"], parts: { "model_alias" => {"type"=>"string", "description"=>"The trained model alias to delete"}, "model_id" => {"type"=>"string", "description"=>"The trained model where the model alias is assigned"}, }, } ), "ml.estimate_model_memory" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html", methods: ["POST"], body: {"description"=>"The analysis config, plus cardinality estimates for fields it references", "required"=>true}, url: { path: "/_ml/anomaly_detectors/_estimate_model_memory", paths: ["/_ml/anomaly_detectors/_estimate_model_memory"], } ), "ml.evaluate_data_frame" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html", methods: ["POST"], body: {"description"=>"The evaluation definition", "required"=>true}, url: { path: "/_ml/data_frame/_evaluate", paths: ["/_ml/data_frame/_evaluate"], } ), "ml.explain_data_frame_analytics" => RestApi.new( documentation: "http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html", methods: ["GET", "POST"], body: {"description"=>"The data frame analytics config to explain", "required"=>false}, url: { path: "/_ml/data_frame/analytics/_explain", paths: ["/_ml/data_frame/analytics/_explain", "/_ml/data_frame/analytics/{id}/_explain"], parts: { "id" => {"type"=>"string", "description"=>"The ID of the data frame analytics to explain"}, }, } ), "ml.flush_job" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html", methods: ["POST"], body: {"description"=>"Flush parameters"}, url: { path: "/_ml/anomaly_detectors/{job_id}/_flush", paths: ["/_ml/anomaly_detectors/{job_id}/_flush"], parts: { "job_id" => {"type"=>"string", "description"=>"The name of the job to flush"}, }, params: { "calc_interim" => {"type"=>"boolean", "description"=>"Calculates interim results for the most recent bucket or all buckets within the latency period"}, "start" => {"type"=>"string", "description"=>"When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results"}, "end" => {"type"=>"string", "description"=>"When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results"}, "advance_time" => {"type"=>"string", "description"=>"Advances time to the given value generating results and updating the model for the advanced interval"}, "skip_time" => {"type"=>"string", "description"=>"Skips time to the given value without generating results or updating the model for the skipped interval"}, } } ), "ml.forecast" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html", methods: ["POST"], body: {"description"=>"Query parameters can be specified in the body", "required"=>false}, url: { path: "/_ml/anomaly_detectors/{job_id}/_forecast", paths: ["/_ml/anomaly_detectors/{job_id}/_forecast"], parts: { "job_id" => {"type"=>"string", "description"=>"The ID of the job to forecast for"}, }, params: { "duration" => {"type"=>"time", "required"=>false, "description"=>"The duration of the forecast"}, "expires_in" => {"type"=>"time", "required"=>false, "description"=>"The time interval after which the forecast expires. Expired forecasts will be deleted at the first opportunity."}, "max_model_memory" => {"type"=>"string", "required"=>false, "description"=>"The max memory able to be used by the forecast. Default is 20mb."}, } } ), "ml.get_buckets" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html", methods: ["GET", "POST"], body: {"description"=>"Bucket selection details if not provided in URI"}, url: { path: "/_ml/anomaly_detectors/{job_id}/results/buckets/{timestamp}", paths: ["/_ml/anomaly_detectors/{job_id}/results/buckets/{timestamp}", "/_ml/anomaly_detectors/{job_id}/results/buckets"], parts: { "job_id" => {"type"=>"string", "description"=>"ID of the job to get bucket results from"}, "timestamp" => {"type"=>"string", "description"=>"The timestamp of the desired single bucket result"}, }, params: { "expand" => {"type"=>"boolean", "description"=>"Include anomaly records"}, "exclude_interim" => {"type"=>"boolean", "description"=>"Exclude interim results"}, "from" => {"type"=>"int", "description"=>"skips a number of buckets"}, "size" => {"type"=>"int", "description"=>"specifies a max number of buckets to get"}, "start" => {"type"=>"string", "description"=>"Start time filter for buckets"}, "end" => {"type"=>"string", "description"=>"End time filter for buckets"}, "anomaly_score" => {"type"=>"double", "description"=>"Filter for the most anomalous buckets"}, "sort" => {"type"=>"string", "description"=>"Sort buckets by a particular field"}, "desc" => {"type"=>"boolean", "description"=>"Set the sort direction"}, } } ), "ml.get_calendar_events" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html", methods: ["GET"], body: nil, url: { path: "/_ml/calendars/{calendar_id}/events", paths: ["/_ml/calendars/{calendar_id}/events"], parts: { "calendar_id" => {"type"=>"string", "description"=>"The ID of the calendar containing the events"}, }, params: { "job_id" => {"type"=>"string", "description"=>"Get events for the job. When this option is used calendar_id must be '_all'"}, "start" => {"type"=>"string", "description"=>"Get events after this time"}, "end" => {"type"=>"date", "description"=>"Get events before this time"}, "from" => {"type"=>"int", "description"=>"Skips a number of events"}, "size" => {"type"=>"int", "description"=>"Specifies a max number of events to get"}, } } ), "ml.get_calendars" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html", methods: ["GET", "POST"], body: {"description"=>"The from and size parameters optionally sent in the body"}, url: { path: "/_ml/calendars", paths: ["/_ml/calendars", "/_ml/calendars/{calendar_id}"], parts: { "calendar_id" => {"type"=>"string", "description"=>"The ID of the calendar to fetch"}, }, params: { "from" => {"type"=>"int", "description"=>"skips a number of calendars"}, "size" => {"type"=>"int", "description"=>"specifies a max number of calendars to get"}, } } ), "ml.get_categories" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html", methods: ["GET", "POST"], body: {"description"=>"Category selection details if not provided in URI"}, url: { path: "/_ml/anomaly_detectors/{job_id}/results/categories/{category_id}", paths: ["/_ml/anomaly_detectors/{job_id}/results/categories/{category_id}", "/_ml/anomaly_detectors/{job_id}/results/categories/"], parts: { "job_id" => {"type"=>"string", "description"=>"The name of the job"}, "category_id" => {"type"=>"long", "description"=>"The identifier of the category definition of interest"}, }, params: { "from" => {"type"=>"int", "description"=>"skips a number of categories"}, "size" => {"type"=>"int", "description"=>"specifies a max number of categories to get"}, "partition_field_value" => {"type"=>"string", "description"=>"Specifies the partition to retrieve categories for. This is optional, and should never be used for jobs where per-partition categorization is disabled."}, } } ), "ml.get_data_frame_analytics" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html", methods: ["GET"], body: nil, url: { path: "/_ml/data_frame/analytics/{id}", paths: ["/_ml/data_frame/analytics/{id}", "/_ml/data_frame/analytics"], parts: { "id" => {"type"=>"string", "description"=>"The ID of the data frame analytics to fetch"}, }, params: { "allow_no_match" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)", "default"=>true}, "from" => {"type"=>"int", "description"=>"skips a number of analytics", "default"=>0}, "size" => {"type"=>"int", "description"=>"specifies a max number of analytics to get", "default"=>100}, "exclude_generated" => {"required"=>false, "type"=>"boolean", "default"=>false, "description"=>"Omits fields that are illegal to set on data frame analytics PUT"}, } } ), "ml.get_data_frame_analytics_stats" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html", methods: ["GET"], body: nil, url: { path: "/_ml/data_frame/analytics/_stats", paths: ["/_ml/data_frame/analytics/_stats", "/_ml/data_frame/analytics/{id}/_stats"], parts: { "id" => {"type"=>"string", "description"=>"The ID of the data frame analytics stats to fetch"}, }, params: { "allow_no_match" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)", "default"=>true}, "from" => {"type"=>"int", "description"=>"skips a number of analytics", "default"=>0}, "size" => {"type"=>"int", "description"=>"specifies a max number of analytics to get", "default"=>100}, "verbose" => {"type"=>"boolean", "required"=>false, "description"=>"whether the stats response should be verbose", "default"=>false}, } } ), "ml.get_datafeed_stats" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html", methods: ["GET"], body: nil, url: { path: "/_ml/datafeeds/{datafeed_id}/_stats", paths: ["/_ml/datafeeds/{datafeed_id}/_stats", "/_ml/datafeeds/_stats"], parts: { "datafeed_id" => {"type"=>"string", "description"=>"The ID of the datafeeds stats to fetch"}, }, params: { "allow_no_match" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)"}, } } ), "ml.get_datafeeds" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html", methods: ["GET"], body: nil, url: { path: "/_ml/datafeeds/{datafeed_id}", paths: ["/_ml/datafeeds/{datafeed_id}", "/_ml/datafeeds"], parts: { "datafeed_id" => {"type"=>"string", "description"=>"The ID of the datafeeds to fetch"}, }, params: { "allow_no_match" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)"}, "exclude_generated" => {"required"=>false, "type"=>"boolean", "default"=>false, "description"=>"Omits fields that are illegal to set on datafeed PUT"}, } } ), "ml.get_filters" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html", methods: ["GET"], body: nil, url: { path: "/_ml/filters", paths: ["/_ml/filters", "/_ml/filters/{filter_id}"], parts: { "filter_id" => {"type"=>"string", "description"=>"The ID of the filter to fetch"}, }, params: { "from" => {"type"=>"int", "description"=>"skips a number of filters"}, "size" => {"type"=>"int", "description"=>"specifies a max number of filters to get"}, } } ), "ml.get_influencers" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html", methods: ["GET", "POST"], body: {"description"=>"Influencer selection criteria"}, url: { path: "/_ml/anomaly_detectors/{job_id}/results/influencers", paths: ["/_ml/anomaly_detectors/{job_id}/results/influencers"], parts: { "job_id" => {"type"=>"string", "description"=>"Identifier for the anomaly detection job"}, }, params: { "exclude_interim" => {"type"=>"boolean", "description"=>"Exclude interim results"}, "from" => {"type"=>"int", "description"=>"skips a number of influencers"}, "size" => {"type"=>"int", "description"=>"specifies a max number of influencers to get"}, "start" => {"type"=>"string", "description"=>"start timestamp for the requested influencers"}, "end" => {"type"=>"string", "description"=>"end timestamp for the requested influencers"}, "influencer_score" => {"type"=>"double", "description"=>"influencer score threshold for the requested influencers"}, "sort" => {"type"=>"string", "description"=>"sort field for the requested influencers"}, "desc" => {"type"=>"boolean", "description"=>"whether the results should be sorted in decending order"}, } } ), "ml.get_job_stats" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html", methods: ["GET"], body: nil, url: { path: "/_ml/anomaly_detectors/_stats", paths: ["/_ml/anomaly_detectors/_stats", "/_ml/anomaly_detectors/{job_id}/_stats"], parts: { "job_id" => {"type"=>"string", "description"=>"The ID of the jobs stats to fetch"}, }, params: { "allow_no_match" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)"}, } } ), "ml.get_jobs" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html", methods: ["GET"], body: nil, url: { path: "/_ml/anomaly_detectors/{job_id}", paths: ["/_ml/anomaly_detectors/{job_id}", "/_ml/anomaly_detectors"], parts: { "job_id" => {"type"=>"string", "description"=>"The ID of the jobs to fetch"}, }, params: { "allow_no_match" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)"}, "exclude_generated" => {"required"=>false, "type"=>"boolean", "default"=>false, "description"=>"Omits fields that are illegal to set on job PUT"}, } } ), "ml.get_memory_stats" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-memory.html", methods: ["GET"], body: nil, url: { path: "/_ml/memory/_stats", paths: ["/_ml/memory/_stats", "/_ml/memory/{node_id}/_stats"], parts: { "node_id" => {"type"=>"string", "description"=>"Specifies the node or nodes to retrieve stats for."}, }, params: { "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, } } ), "ml.get_model_snapshot_upgrade_stats" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-model-snapshot-upgrade-stats.html", methods: ["GET"], body: nil, url: { path: "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade/_stats", paths: ["/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade/_stats"], parts: { "job_id" => {"type"=>"string", "description"=>"The ID of the job. May be a wildcard, comma separated list or `_all`."}, "snapshot_id" => {"type"=>"string", "description"=>"The ID of the snapshot. May be a wildcard, comma separated list or `_all`."}, }, params: { "allow_no_match" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no jobs or no snapshots. (This includes the `_all` string.)"}, } } ), "ml.get_model_snapshots" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html", methods: ["GET", "POST"], body: {"description"=>"Model snapshot selection criteria"}, url: { path: "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}", paths: ["/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}", "/_ml/anomaly_detectors/{job_id}/model_snapshots"], parts: { "job_id" => {"type"=>"string", "description"=>"The ID of the job to fetch"}, "snapshot_id" => {"type"=>"string", "description"=>"The ID of the snapshot to fetch"}, }, params: { "from" => {"type"=>"int", "description"=>"Skips a number of documents"}, "size" => {"type"=>"int", "description"=>"The default number of documents returned in queries as a string."}, "start" => {"type"=>"date", "description"=>"The filter 'start' query parameter"}, "end" => {"type"=>"date", "description"=>"The filter 'end' query parameter"}, "sort" => {"type"=>"string", "description"=>"Name of the field to sort on"}, "desc" => {"type"=>"boolean", "description"=>"True if the results should be sorted in descending order"}, } } ), "ml.get_overall_buckets" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html", methods: ["GET", "POST"], body: {"description"=>"Overall bucket selection details if not provided in URI"}, url: { path: "/_ml/anomaly_detectors/{job_id}/results/overall_buckets", paths: ["/_ml/anomaly_detectors/{job_id}/results/overall_buckets"], parts: { "job_id" => {"type"=>"string", "description"=>"The job IDs for which to calculate overall bucket results"}, }, params: { "top_n" => {"type"=>"int", "description"=>"The number of top job bucket scores to be used in the overall_score calculation"}, "bucket_span" => {"type"=>"string", "description"=>"The span of the overall buckets. Defaults to the longest job bucket_span"}, "overall_score" => {"type"=>"double", "description"=>"Returns overall buckets with overall scores higher than this value"}, "exclude_interim" => {"type"=>"boolean", "description"=>"If true overall buckets that include interim buckets will be excluded"}, "start" => {"type"=>"string", "description"=>"Returns overall buckets with timestamps after this time"}, "end" => {"type"=>"string", "description"=>"Returns overall buckets with timestamps earlier than this time"}, "allow_no_match" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)"}, } } ), "ml.get_records" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html", methods: ["GET", "POST"], body: {"description"=>"Record selection criteria"}, url: { path: "/_ml/anomaly_detectors/{job_id}/results/records", paths: ["/_ml/anomaly_detectors/{job_id}/results/records"], parts: { "job_id" => {"type"=>"string", "description"=>"The ID of the job"}, }, params: { "exclude_interim" => {"type"=>"boolean", "description"=>"Exclude interim results"}, "from" => {"type"=>"int", "description"=>"skips a number of records"}, "size" => {"type"=>"int", "description"=>"specifies a max number of records to get"}, "start" => {"type"=>"string", "description"=>"Start time filter for records"}, "end" => {"type"=>"string", "description"=>"End time filter for records"}, "record_score" => {"type"=>"double", "description"=>"Returns records with anomaly scores greater or equal than this value"}, "sort" => {"type"=>"string", "description"=>"Sort records by a particular field"}, "desc" => {"type"=>"boolean", "description"=>"Set the sort direction"}, } } ), "ml.get_trained_models" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html", methods: ["GET"], body: nil, url: { path: "/_ml/trained_models/{model_id}", paths: ["/_ml/trained_models/{model_id}", "/_ml/trained_models"], parts: { "model_id" => {"type"=>"string", "description"=>"The ID of the trained models to fetch"}, }, params: { "allow_no_match" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)", "default"=>true}, "include" => {"type"=>"string", "required"=>false, "description"=>"A comma-separate list of fields to optionally include. Valid options are 'definition' and 'total_feature_importance'. Default is none."}, "include_model_definition" => {"type"=>"boolean", "required"=>false, "description"=>"Should the full model definition be included in the results. These definitions can be large. So be cautious when including them. Defaults to false.", "default"=>false, "deprecated"=>true}, "decompress_definition" => {"type"=>"boolean", "required"=>false, "default"=>true, "description"=>"Should the model definition be decompressed into valid JSON or returned in a custom compressed format. Defaults to true."}, "from" => {"required"=>false, "type"=>"int", "description"=>"skips a number of trained models", "default"=>0}, "size" => {"required"=>false, "type"=>"int", "description"=>"specifies a max number of trained models to get", "default"=>100}, "tags" => {"required"=>false, "type"=>"list", "description"=>"A comma-separated list of tags that the model must have."}, "exclude_generated" => {"required"=>false, "type"=>"boolean", "default"=>false, "description"=>"Omits fields that are illegal to set on model PUT"}, } } ), "ml.get_trained_models_stats" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html", methods: ["GET"], body: nil, url: { path: "/_ml/trained_models/{model_id}/_stats", paths: ["/_ml/trained_models/{model_id}/_stats", "/_ml/trained_models/_stats"], parts: { "model_id" => {"type"=>"string", "description"=>"The ID of the trained models stats to fetch"}, }, params: { "allow_no_match" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)", "default"=>true}, "from" => {"type"=>"int", "description"=>"skips a number of trained models", "default"=>0}, "size" => {"type"=>"int", "description"=>"specifies a max number of trained models to get", "default"=>100}, } } ), "ml.infer_trained_model" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html", methods: ["POST"], body: {"description"=>"The docs to apply inference on and inference configuration overrides", "required"=>true}, url: { path: "/_ml/trained_models/{model_id}/_infer", paths: ["/_ml/trained_models/{model_id}/_infer", "/_ml/trained_models/{model_id}/deployment/_infer"], parts: { "model_id" => {"type"=>"string", "description"=>"The unique identifier of the trained model.", "required"=>true}, }, params: { "timeout" => {"type"=>"time", "required"=>false, "description"=>"Controls the amount of time to wait for inference results.", "default"=>"10s"}, } } ), "ml.info" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html", methods: ["GET"], body: nil, url: { path: "/_ml/info", paths: ["/_ml/info"], } ), "ml.open_job" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html", methods: ["POST"], body: {"description"=>"Query parameters can be specified in the body", "required"=>false}, url: { path: "/_ml/anomaly_detectors/{job_id}/_open", paths: ["/_ml/anomaly_detectors/{job_id}/_open"], parts: { "job_id" => {"type"=>"string", "description"=>"The ID of the job to open"}, }, } ), "ml.post_calendar_events" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html", methods: ["POST"], body: {"description"=>"A list of events", "required"=>true}, url: { path: "/_ml/calendars/{calendar_id}/events", paths: ["/_ml/calendars/{calendar_id}/events"], parts: { "calendar_id" => {"type"=>"string", "description"=>"The ID of the calendar to modify"}, }, } ), "ml.post_data" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html", methods: ["POST"], body: {"description"=>"The data to process", "required"=>true, "serialize"=>"bulk"}, url: { path: "/_ml/anomaly_detectors/{job_id}/_data", paths: ["/_ml/anomaly_detectors/{job_id}/_data"], parts: { "job_id" => {"type"=>"string", "description"=>"The name of the job receiving the data"}, }, params: { "reset_start" => {"type"=>"string", "description"=>"Optional parameter to specify the start of the bucket resetting range"}, "reset_end" => {"type"=>"string", "description"=>"Optional parameter to specify the end of the bucket resetting range"}, } } ), "ml.preview_data_frame_analytics" => RestApi.new( documentation: "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html", methods: ["GET", "POST"], body: {"description"=>"The data frame analytics config to preview", "required"=>false}, url: { path: "/_ml/data_frame/analytics/_preview", paths: ["/_ml/data_frame/analytics/_preview", "/_ml/data_frame/analytics/{id}/_preview"], parts: { "id" => {"type"=>"string", "description"=>"The ID of the data frame analytics to preview"}, }, } ), "ml.preview_datafeed" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html", methods: ["GET", "POST"], body: {"description"=>"The datafeed config and job config with which to execute the preview", "required"=>false}, url: { path: "/_ml/datafeeds/{datafeed_id}/_preview", paths: ["/_ml/datafeeds/{datafeed_id}/_preview", "/_ml/datafeeds/_preview"], parts: { "datafeed_id" => {"type"=>"string", "description"=>"The ID of the datafeed to preview"}, }, params: { "start" => {"type"=>"string", "required"=>false, "description"=>"The start time from where the datafeed preview should begin"}, "end" => {"type"=>"string", "required"=>false, "description"=>"The end time when the datafeed preview should stop"}, } } ), "ml.put_calendar" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html", methods: ["PUT"], body: {"description"=>"The calendar details", "required"=>false}, url: { path: "/_ml/calendars/{calendar_id}", paths: ["/_ml/calendars/{calendar_id}"], parts: { "calendar_id" => {"type"=>"string", "description"=>"The ID of the calendar to create"}, }, } ), "ml.put_calendar_job" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html", methods: ["PUT"], body: nil, url: { path: "/_ml/calendars/{calendar_id}/jobs/{job_id}", paths: ["/_ml/calendars/{calendar_id}/jobs/{job_id}"], parts: { "calendar_id" => {"type"=>"string", "description"=>"The ID of the calendar to modify"}, "job_id" => {"type"=>"string", "description"=>"The ID of the job to add to the calendar"}, }, } ), "ml.put_data_frame_analytics" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html", methods: ["PUT"], body: {"description"=>"The data frame analytics configuration", "required"=>true}, url: { path: "/_ml/data_frame/analytics/{id}", paths: ["/_ml/data_frame/analytics/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The ID of the data frame analytics to create"}, }, } ), "ml.put_datafeed" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html", methods: ["PUT"], body: {"description"=>"The datafeed config", "required"=>true}, url: { path: "/_ml/datafeeds/{datafeed_id}", paths: ["/_ml/datafeeds/{datafeed_id}"], parts: { "datafeed_id" => {"type"=>"string", "description"=>"The ID of the datafeed to create"}, }, params: { "ignore_unavailable" => {"type"=>"boolean", "description"=>"Ignore unavailable indexes (default: false)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Ignore if the source indices expressions resolves to no concrete indices (default: true)"}, "ignore_throttled" => {"type"=>"boolean", "description"=>"Ignore indices that are marked as throttled (default: true)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "description"=>"Whether source index expressions should get expanded to open or closed indices (default: open)"}, } } ), "ml.put_filter" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html", methods: ["PUT"], body: {"description"=>"The filter details", "required"=>true}, url: { path: "/_ml/filters/{filter_id}", paths: ["/_ml/filters/{filter_id}"], parts: { "filter_id" => {"type"=>"string", "description"=>"The ID of the filter to create"}, }, } ), "ml.put_job" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html", methods: ["PUT"], body: {"description"=>"The job", "required"=>true}, url: { path: "/_ml/anomaly_detectors/{job_id}", paths: ["/_ml/anomaly_detectors/{job_id}"], parts: { "job_id" => {"type"=>"string", "description"=>"The ID of the job to create"}, }, params: { "ignore_unavailable" => {"type"=>"boolean", "description"=>"Ignore unavailable indexes (default: false). Only set if datafeed_config is provided."}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Ignore if the source indices expressions resolves to no concrete indices (default: true). Only set if datafeed_config is provided."}, "ignore_throttled" => {"type"=>"boolean", "description"=>"Ignore indices that are marked as throttled (default: true). Only set if datafeed_config is provided."}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "description"=>"Whether source index expressions should get expanded to open or closed indices (default: open). Only set if datafeed_config is provided."}, } } ), "ml.put_trained_model" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html", methods: ["PUT"], body: {"description"=>"The trained model configuration", "required"=>true}, url: { path: "/_ml/trained_models/{model_id}", paths: ["/_ml/trained_models/{model_id}"], parts: { "model_id" => {"type"=>"string", "description"=>"The ID of the trained models to store"}, }, params: { "defer_definition_decompression" => {"required"=>false, "type"=>"boolean", "description"=>"If set to `true` and a `compressed_definition` is provided, the request defers definition decompression and skips relevant validations.", "default"=>false}, } } ), "ml.put_trained_model_alias" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html", methods: ["PUT"], body: nil, url: { path: "/_ml/trained_models/{model_id}/model_aliases/{model_alias}", paths: ["/_ml/trained_models/{model_id}/model_aliases/{model_alias}"], parts: { "model_alias" => {"type"=>"string", "description"=>"The trained model alias to update"}, "model_id" => {"type"=>"string", "description"=>"The trained model where the model alias should be assigned"}, }, params: { "reassign" => {"type"=>"boolean", "description"=>"If the model_alias already exists and points to a separate model_id, this parameter must be true. Defaults to false."}, } } ), "ml.put_trained_model_definition_part" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-definition-part.html", methods: ["PUT"], body: {"description"=>"The trained model definition part", "required"=>true}, url: { path: "/_ml/trained_models/{model_id}/definition/{part}", paths: ["/_ml/trained_models/{model_id}/definition/{part}"], parts: { "model_id" => {"type"=>"string", "description"=>"The ID of the trained model for this definition part"}, "part" => {"type"=>"int", "description"=>"The part number"}, }, } ), "ml.put_trained_model_vocabulary" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html", methods: ["PUT"], body: {"description"=>"The trained model vocabulary", "required"=>true}, url: { path: "/_ml/trained_models/{model_id}/vocabulary", paths: ["/_ml/trained_models/{model_id}/vocabulary"], parts: { "model_id" => {"type"=>"string", "description"=>"The ID of the trained model for this vocabulary"}, }, } ), "ml.reset_job" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html", methods: ["POST"], body: nil, url: { path: "/_ml/anomaly_detectors/{job_id}/_reset", paths: ["/_ml/anomaly_detectors/{job_id}/_reset"], parts: { "job_id" => {"type"=>"string", "description"=>"The ID of the job to reset"}, }, params: { "wait_for_completion" => {"type"=>"boolean", "description"=>"Should this request wait until the operation has completed before returning", "default"=>true}, "delete_user_annotations" => {"type"=>"boolean", "description"=>"Should annotations added by the user be deleted", "default"=>false}, } } ), "ml.revert_model_snapshot" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html", methods: ["POST"], body: {"description"=>"Reversion options"}, url: { path: "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert", paths: ["/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert"], parts: { "job_id" => {"type"=>"string", "description"=>"The ID of the job to fetch"}, "snapshot_id" => {"type"=>"string", "description"=>"The ID of the snapshot to revert to"}, }, params: { "delete_intervening_results" => {"type"=>"boolean", "description"=>"Should we reset the results back to the time of the snapshot?"}, } } ), "ml.set_upgrade_mode" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html", methods: ["POST"], body: nil, url: { path: "/_ml/set_upgrade_mode", paths: ["/_ml/set_upgrade_mode"], params: { "enabled" => {"type"=>"boolean", "description"=>"Whether to enable upgrade_mode ML setting or not. Defaults to false."}, "timeout" => {"type"=>"time", "description"=>"Controls the time to wait before action times out. Defaults to 30 seconds"}, } } ), "ml.start_data_frame_analytics" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html", methods: ["POST"], body: {"description"=>"The start data frame analytics parameters"}, url: { path: "/_ml/data_frame/analytics/{id}/_start", paths: ["/_ml/data_frame/analytics/{id}/_start"], parts: { "id" => {"type"=>"string", "description"=>"The ID of the data frame analytics to start"}, }, params: { "timeout" => {"type"=>"time", "required"=>false, "description"=>"Controls the time to wait until the task has started. Defaults to 20 seconds"}, } } ), "ml.start_datafeed" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html", methods: ["POST"], body: {"description"=>"The start datafeed parameters"}, url: { path: "/_ml/datafeeds/{datafeed_id}/_start", paths: ["/_ml/datafeeds/{datafeed_id}/_start"], parts: { "datafeed_id" => {"type"=>"string", "description"=>"The ID of the datafeed to start"}, }, params: { "start" => {"type"=>"string", "required"=>false, "description"=>"The start time from where the datafeed should begin"}, "end" => {"type"=>"string", "required"=>false, "description"=>"The end time when the datafeed should stop. When not set, the datafeed continues in real time"}, "timeout" => {"type"=>"time", "required"=>false, "description"=>"Controls the time to wait until a datafeed has started. Default to 20 seconds"}, } } ), "ml.start_trained_model_deployment" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trained-model-deployment.html", methods: ["POST"], body: nil, url: { path: "/_ml/trained_models/{model_id}/deployment/_start", paths: ["/_ml/trained_models/{model_id}/deployment/_start"], parts: { "model_id" => {"type"=>"string", "description"=>"The unique identifier of the trained model.", "required"=>true}, }, params: { "cache_size" => {"type"=>"string", "description"=>"A byte-size value for configuring the inference cache size. For example, 20mb.", "required"=>false}, "number_of_allocations" => {"type"=>"int", "description"=>"The total number of allocations this model is assigned across machine learning nodes.", "required"=>false, "default"=>1}, "threads_per_allocation" => {"type"=>"int", "description"=>"The number of threads used by each model allocation during inference.", "required"=>false, "default"=>1}, "priority" => {"type"=>"string", "description"=>"The deployment priority.", "required"=>false, "default"=>"normal"}, "queue_capacity" => {"type"=>"int", "description"=>"Controls how many inference requests are allowed in the queue at a time.", "required"=>false, "default"=>1024}, "timeout" => {"type"=>"time", "required"=>false, "description"=>"Controls the amount of time to wait for the model to deploy.", "default"=>"20s"}, "wait_for" => {"type"=>"string", "required"=>false, "description"=>"The allocation status for which to wait", "options"=>["starting", "started", "fully_allocated"], "default"=>"started"}, } } ), "ml.stop_data_frame_analytics" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html", methods: ["POST"], body: {"description"=>"The stop data frame analytics parameters"}, url: { path: "/_ml/data_frame/analytics/{id}/_stop", paths: ["/_ml/data_frame/analytics/{id}/_stop"], parts: { "id" => {"type"=>"string", "description"=>"The ID of the data frame analytics to stop"}, }, params: { "allow_no_match" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)"}, "force" => {"type"=>"boolean", "required"=>false, "description"=>"True if the data frame analytics should be forcefully stopped"}, "timeout" => {"type"=>"time", "required"=>false, "description"=>"Controls the time to wait until the task has stopped. Defaults to 20 seconds"}, } } ), "ml.stop_datafeed" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html", methods: ["POST"], body: {"description"=>"The URL params optionally sent in the body", "required"=>false}, url: { path: "/_ml/datafeeds/{datafeed_id}/_stop", paths: ["/_ml/datafeeds/{datafeed_id}/_stop"], parts: { "datafeed_id" => {"type"=>"string", "description"=>"The ID of the datafeed to stop"}, }, params: { "allow_no_match" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)"}, "allow_no_datafeeds" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)", "deprecated"=>true}, "force" => {"type"=>"boolean", "required"=>false, "description"=>"True if the datafeed should be forcefully stopped."}, "timeout" => {"type"=>"time", "required"=>false, "description"=>"Controls the time to wait until a datafeed has stopped. Default to 20 seconds"}, } } ), "ml.stop_trained_model_deployment" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/stop-trained-model-deployment.html", methods: ["POST"], body: {"description"=>"The stop deployment parameters"}, url: { path: "/_ml/trained_models/{model_id}/deployment/_stop", paths: ["/_ml/trained_models/{model_id}/deployment/_stop"], parts: { "model_id" => {"type"=>"string", "description"=>"The unique identifier of the trained model.", "required"=>true}, }, params: { "allow_no_match" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no deployments. (This includes `_all` string or when no deployments have been specified)"}, "force" => {"type"=>"boolean", "required"=>false, "description"=>"True if the deployment should be forcefully stopped"}, } } ), "ml.update_data_frame_analytics" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html", methods: ["POST"], body: {"description"=>"The data frame analytics settings to update", "required"=>true}, url: { path: "/_ml/data_frame/analytics/{id}/_update", paths: ["/_ml/data_frame/analytics/{id}/_update"], parts: { "id" => {"type"=>"string", "description"=>"The ID of the data frame analytics to update"}, }, } ), "ml.update_datafeed" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html", methods: ["POST"], body: {"description"=>"The datafeed update settings", "required"=>true}, url: { path: "/_ml/datafeeds/{datafeed_id}/_update", paths: ["/_ml/datafeeds/{datafeed_id}/_update"], parts: { "datafeed_id" => {"type"=>"string", "description"=>"The ID of the datafeed to update"}, }, params: { "ignore_unavailable" => {"type"=>"boolean", "description"=>"Ignore unavailable indexes (default: false)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Ignore if the source indices expressions resolves to no concrete indices (default: true)"}, "ignore_throttled" => {"type"=>"boolean", "description"=>"Ignore indices that are marked as throttled (default: true)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "description"=>"Whether source index expressions should get expanded to open or closed indices (default: open)"}, } } ), "ml.update_filter" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html", methods: ["POST"], body: {"description"=>"The filter update", "required"=>true}, url: { path: "/_ml/filters/{filter_id}/_update", paths: ["/_ml/filters/{filter_id}/_update"], parts: { "filter_id" => {"type"=>"string", "description"=>"The ID of the filter to update"}, }, } ), "ml.update_job" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html", methods: ["POST"], body: {"description"=>"The job update settings", "required"=>true}, url: { path: "/_ml/anomaly_detectors/{job_id}/_update", paths: ["/_ml/anomaly_detectors/{job_id}/_update"], parts: { "job_id" => {"type"=>"string", "description"=>"The ID of the job to create"}, }, } ), "ml.update_model_snapshot" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html", methods: ["POST"], body: {"description"=>"The model snapshot properties to update", "required"=>true}, url: { path: "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_update", paths: ["/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_update"], parts: { "job_id" => {"type"=>"string", "description"=>"The ID of the job to fetch"}, "snapshot_id" => {"type"=>"string", "description"=>"The ID of the snapshot to update"}, }, } ), "ml.update_trained_model_deployment" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-trained-model-deployment.html", methods: ["POST"], body: {"description"=>"The updated trained model deployment settings", "required"=>true}, url: { path: "/_ml/trained_models/{model_id}/deployment/_update", paths: ["/_ml/trained_models/{model_id}/deployment/_update"], parts: { "model_id" => {"type"=>"string", "description"=>"The unique identifier of the trained model."}, }, } ), "ml.upgrade_job_snapshot" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-upgrade-job-model-snapshot.html", methods: ["POST"], body: nil, url: { path: "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade", paths: ["/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade"], parts: { "job_id" => {"type"=>"string", "description"=>"The ID of the job"}, "snapshot_id" => {"type"=>"string", "description"=>"The ID of the snapshot"}, }, params: { "timeout" => {"type"=>"time", "required"=>false, "description"=>"How long should the API wait for the job to be opened and the old snapshot to be loaded."}, "wait_for_completion" => {"type"=>"boolean", "required"=>false, "description"=>"Should the request wait until the task is complete before responding to the caller. Default is false."}, } } ), "ml.validate" => RestApi.new( documentation: "https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", methods: ["POST"], body: {"description"=>"The job config", "required"=>true}, url: { path: "/_ml/anomaly_detectors/_validate", paths: ["/_ml/anomaly_detectors/_validate"], } ), "ml.validate_detector" => RestApi.new( documentation: "https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", methods: ["POST"], body: {"description"=>"The detector", "required"=>true}, url: { path: "/_ml/anomaly_detectors/_validate/detector", paths: ["/_ml/anomaly_detectors/_validate/detector"], } ), "monitoring.bulk" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/monitor-elasticsearch-cluster.html", methods: ["POST", "PUT"], body: {"description"=>"The operation definition and data (action-data pairs), separated by newlines", "required"=>true, "serialize"=>"bulk"}, url: { path: "/_monitoring/bulk", paths: ["/_monitoring/bulk", "/_monitoring/{type}/bulk"], parts: { "type" => {"type"=>"string", "description"=>"Default document type for items which don't provide one", "deprecated"=>true}, }, params: { "system_id" => {"type"=>"string", "description"=>"Identifier of the monitored system"}, "system_api_version" => {"type"=>"string", "description"=>"API Version of the monitored system"}, "interval" => {"type"=>"string", "description"=>"Collection interval (e.g., '10s' or '10000ms') of the payload"}, } } ), "msearch" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html", methods: ["GET", "POST"], body: {"description"=>"The request definitions (metadata-search request definition pairs), separated by newlines", "required"=>true, "serialize"=>"bulk"}, url: { path: "/_msearch", paths: ["/_msearch", "/{index}/_msearch"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names to use as default"}, }, params: { "search_type" => {"type"=>"enum", "options"=>["query_then_fetch", "dfs_query_then_fetch"], "description"=>"Search operation type"}, "max_concurrent_searches" => {"type"=>"number", "description"=>"Controls the maximum number of concurrent searches the multi search api will execute"}, "typed_keys" => {"type"=>"boolean", "description"=>"Specify whether aggregation and suggester names should be prefixed by their respective types in the response"}, "pre_filter_shard_size" => {"type"=>"number", "description"=>"A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint."}, "max_concurrent_shard_requests" => {"type"=>"number", "description"=>"The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", "default"=>5}, "rest_total_hits_as_int" => {"type"=>"boolean", "description"=>"Indicates whether hits.total should be rendered as an integer or an object in the rest search response", "default"=>false}, "ccs_minimize_roundtrips" => {"type"=>"boolean", "description"=>"Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", "default"=>"true"}, } } ), "msearch_template" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html", methods: ["GET", "POST"], body: {"description"=>"The request definitions (metadata-search request definition pairs), separated by newlines", "required"=>true, "serialize"=>"bulk"}, url: { path: "/_msearch/template", paths: ["/_msearch/template", "/{index}/_msearch/template"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names to use as default"}, }, params: { "search_type" => {"type"=>"enum", "options"=>["query_then_fetch", "dfs_query_then_fetch"], "description"=>"Search operation type"}, "typed_keys" => {"type"=>"boolean", "description"=>"Specify whether aggregation and suggester names should be prefixed by their respective types in the response"}, "max_concurrent_searches" => {"type"=>"number", "description"=>"Controls the maximum number of concurrent searches the multi search api will execute"}, "rest_total_hits_as_int" => {"type"=>"boolean", "description"=>"Indicates whether hits.total should be rendered as an integer or an object in the rest search response", "default"=>false}, "ccs_minimize_roundtrips" => {"type"=>"boolean", "description"=>"Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", "default"=>"true"}, } } ), "mtermvectors" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html", methods: ["GET", "POST"], body: {"description"=>"Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.", "required"=>false}, url: { path: "/_mtermvectors", paths: ["/_mtermvectors", "/{index}/_mtermvectors"], parts: { "index" => {"type"=>"string", "description"=>"The index in which the document resides."}, }, params: { "ids" => {"type"=>"list", "description"=>"A comma-separated list of documents ids. You must define ids as parameter or set \"ids\" or \"docs\" in the request body"}, "term_statistics" => {"type"=>"boolean", "description"=>"Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".", "default"=>false}, "field_statistics" => {"type"=>"boolean", "description"=>"Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".", "default"=>true}, "fields" => {"type"=>"list", "description"=>"A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\"."}, "offsets" => {"type"=>"boolean", "description"=>"Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".", "default"=>true}, "positions" => {"type"=>"boolean", "description"=>"Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".", "default"=>true}, "payloads" => {"type"=>"boolean", "description"=>"Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".", "default"=>true}, "preference" => {"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\"."}, "routing" => {"type"=>"string", "description"=>"Specific routing value. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\"."}, "realtime" => {"type"=>"boolean", "description"=>"Specifies if requests are real-time as opposed to near-real-time (default: true)."}, "version" => {"type"=>"number", "description"=>"Explicit version number for concurrency control"}, "version_type" => {"type"=>"enum", "options"=>["internal", "external", "external_gte"], "description"=>"Specific version type"}, } } ), "nodes.clear_repositories_metering_archive" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-repositories-metering-archive-api.html", methods: ["DELETE"], body: nil, url: { path: "/_nodes/{node_id}/_repositories_metering/{max_archive_version}", paths: ["/_nodes/{node_id}/_repositories_metering/{max_archive_version}"], parts: { "node_id" => {"type"=>"list", "description"=>"Comma-separated list of node IDs or names used to limit returned information."}, "max_archive_version" => {"type"=>"long", "description"=>"Specifies the maximum archive_version to be cleared from the archive."}, }, } ), "nodes.get_repositories_metering_info" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html", methods: ["GET"], body: nil, url: { path: "/_nodes/{node_id}/_repositories_metering", paths: ["/_nodes/{node_id}/_repositories_metering"], parts: { "node_id" => {"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information."}, }, } ), "nodes.hot_threads" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html", methods: ["GET"], body: nil, url: { path: "/_nodes/hot_threads", paths: ["/_nodes/hot_threads", "/_nodes/{node_id}/hot_threads"], parts: { "node_id" => {"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}, }, params: { "interval" => {"type"=>"time", "description"=>"The interval for the second sampling of threads"}, "snapshots" => {"type"=>"number", "description"=>"Number of samples of thread stacktrace (default: 10)"}, "threads" => {"type"=>"number", "description"=>"Specify the number of threads to provide information for (default: 3)"}, "ignore_idle_threads" => {"type"=>"boolean", "description"=>"Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true)"}, "type" => {"type"=>"enum", "options"=>["cpu", "wait", "block", "mem"], "description"=>"The type to sample (default: cpu)"}, "sort" => {"type"=>"enum", "options"=>["cpu", "total"], "description"=>"The sort order for 'cpu' type (default: total)"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, } } ), "nodes.info" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html", methods: ["GET"], body: nil, url: { path: "/_nodes", paths: ["/_nodes", "/_nodes/{node_id}", "/_nodes/{metric}", "/_nodes/{node_id}/{metric}"], parts: { "node_id" => {"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}, "metric" => {"type"=>"list", "options"=>["settings", "os", "process", "jvm", "thread_pool", "transport", "http", "plugins", "ingest", "indices", "aggregations", "_all", "_none"], "description"=>"A comma-separated list of metrics you wish returned. Use `_all` to retrieve all metrics and `_none` to retrieve the node identity without any additional metrics."}, }, params: { "flat_settings" => {"type"=>"boolean", "description"=>"Return settings in flat format (default: false)"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, } } ), "nodes.reload_secure_settings" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings", methods: ["POST"], body: {"description"=>"An object containing the password for the elasticsearch keystore", "required"=>false}, url: { path: "/_nodes/reload_secure_settings", paths: ["/_nodes/reload_secure_settings", "/_nodes/{node_id}/reload_secure_settings"], parts: { "node_id" => {"type"=>"list", "description"=>"A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes."}, }, params: { "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, } } ), "nodes.stats" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html", methods: ["GET"], body: nil, url: { path: "/_nodes/stats", paths: ["/_nodes/stats", "/_nodes/{node_id}/stats", "/_nodes/stats/{metric}", "/_nodes/{node_id}/stats/{metric}", "/_nodes/stats/{metric}/{index_metric}", "/_nodes/{node_id}/stats/{metric}/{index_metric}"], parts: { "node_id" => {"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}, "metric" => {"type"=>"list", "options"=>["_all", "breaker", "fs", "http", "indices", "jvm", "os", "process", "thread_pool", "transport", "discovery", "indexing_pressure"], "description"=>"Limit the information returned to the specified metrics"}, "index_metric" => {"type"=>"list", "options"=>["_all", "completion", "docs", "fielddata", "query_cache", "flush", "get", "indexing", "merge", "request_cache", "refresh", "search", "segments", "store", "warmer", "bulk", "shard_stats"], "description"=>"Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified."}, }, params: { "completion_fields" => {"type"=>"list", "description"=>"A comma-separated list of fields for the `completion` index metric (supports wildcards)"}, "fielddata_fields" => {"type"=>"list", "description"=>"A comma-separated list of fields for the `fielddata` index metric (supports wildcards)"}, "fields" => {"type"=>"list", "description"=>"A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)"}, "groups" => {"type"=>"boolean", "description"=>"A comma-separated list of search groups for `search` index metric"}, "level" => {"type"=>"enum", "description"=>"Return indices stats aggregated at index, node or shard level", "options"=>["indices", "node", "shards"], "default"=>"node"}, "types" => {"type"=>"list", "description"=>"A comma-separated list of document types for the `indexing` index metric"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "include_segment_file_sizes" => {"type"=>"boolean", "description"=>"Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)", "default"=>false}, "include_unloaded_segments" => {"type"=>"boolean", "description"=>"If set to true segment stats will include stats for segments that are not currently loaded into memory", "default"=>false}, } } ), "nodes.usage" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-usage.html", methods: ["GET"], body: nil, url: { path: "/_nodes/usage", paths: ["/_nodes/usage", "/_nodes/{node_id}/usage", "/_nodes/usage/{metric}", "/_nodes/{node_id}/usage/{metric}"], parts: { "node_id" => {"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}, "metric" => {"type"=>"list", "options"=>["_all", "rest_actions"], "description"=>"Limit the information returned to the specified metrics"}, }, params: { "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, } } ), "open_point_in_time" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html", methods: ["POST"], body: nil, url: { path: "/{index}/_pit", paths: ["/{index}/_pit"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices"}, }, params: { "preference" => {"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "routing" => {"type"=>"string", "description"=>"Specific routing value"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "keep_alive" => {"type"=>"string", "description"=>"Specific the time to live for the point in time", "required"=>true}, } } ), "ping" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", methods: ["HEAD"], body: nil, url: { path: "/", paths: ["/"], } ), "put_script" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", methods: ["PUT", "POST"], body: {"description"=>"The document", "required"=>true}, url: { path: "/_scripts/{id}", paths: ["/_scripts/{id}", "/_scripts/{id}/{context}"], parts: { "id" => {"type"=>"string", "description"=>"Script ID"}, "context" => {"type"=>"string", "description"=>"Script context"}, }, params: { "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for connection to master"}, "context" => {"type"=>"string", "description"=>"Context name to compile script against"}, } } ), "rank_eval" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html", methods: ["GET", "POST"], body: {"description"=>"The ranking evaluation search definition, including search requests, document ratings and ranking metric definition.", "required"=>true}, url: { path: "/_rank_eval", paths: ["/_rank_eval", "/{index}/_rank_eval"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices"}, }, params: { "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "search_type" => {"type"=>"enum", "options"=>["query_then_fetch", "dfs_query_then_fetch"], "description"=>"Search operation type"}, } } ), "reindex" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html", methods: ["POST"], body: {"description"=>"The search definition using the Query DSL and the prototype for the index request.", "required"=>true}, url: { path: "/_reindex", paths: ["/_reindex"], params: { "refresh" => {"type"=>"boolean", "description"=>"Should the affected indexes be refreshed?"}, "timeout" => {"type"=>"time", "default"=>"1m", "description"=>"Time each individual bulk request should wait for shards that are unavailable."}, "wait_for_active_shards" => {"type"=>"string", "description"=>"Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"}, "wait_for_completion" => {"type"=>"boolean", "default"=>true, "description"=>"Should the request should block until the reindex is complete."}, "requests_per_second" => {"type"=>"number", "default"=>0, "description"=>"The throttle to set on this request in sub-requests per second. -1 means no throttle."}, "scroll" => {"type"=>"time", "description"=>"Control how long to keep the search context alive", "default"=>"5m"}, "slices" => {"type"=>"number|string", "default"=>1, "description"=>"The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`."}, "max_docs" => {"type"=>"number", "description"=>"Maximum number of documents to process (default: all documents)"}, } } ), "reindex_rethrottle" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html", methods: ["POST"], body: nil, url: { path: "/_reindex/{task_id}/_rethrottle", paths: ["/_reindex/{task_id}/_rethrottle"], parts: { "task_id" => {"type"=>"string", "description"=>"The task id to rethrottle"}, }, params: { "requests_per_second" => {"type"=>"number", "required"=>true, "description"=>"The throttle to set on this request in floating sub-requests per second. -1 means set no throttle."}, } } ), "render_search_template" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html", methods: ["GET", "POST"], body: {"description"=>"The search definition template and its params"}, url: { path: "/_render/template", paths: ["/_render/template", "/_render/template/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The id of the stored search template"}, }, } ), "rollup.delete_job" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-delete-job.html", methods: ["DELETE"], body: nil, url: { path: "/_rollup/job/{id}", paths: ["/_rollup/job/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The ID of the job to delete"}, }, } ), "rollup.get_jobs" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-job.html", methods: ["GET"], body: nil, url: { path: "/_rollup/job/{id}", paths: ["/_rollup/job/{id}", "/_rollup/job/"], parts: { "id" => {"type"=>"string", "description"=>"The ID of the job(s) to fetch. Accepts glob patterns, or left blank for all jobs"}, }, } ), "rollup.get_rollup_caps" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-caps.html", methods: ["GET"], body: nil, url: { path: "/_rollup/data/{id}", paths: ["/_rollup/data/{id}", "/_rollup/data/"], parts: { "id" => {"type"=>"string", "description"=>"The ID of the index to check rollup capabilities on, or left blank for all jobs"}, }, } ), "rollup.get_rollup_index_caps" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-index-caps.html", methods: ["GET"], body: nil, url: { path: "/{index}/_rollup/data", paths: ["/{index}/_rollup/data"], parts: { "index" => {"type"=>"string", "description"=>"The rollup index or index pattern to obtain rollup capabilities from."}, }, } ), "rollup.put_job" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-put-job.html", methods: ["PUT"], body: {"description"=>"The job configuration", "required"=>true}, url: { path: "/_rollup/job/{id}", paths: ["/_rollup/job/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The ID of the job to create"}, }, } ), "rollup.rollup_search" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-search.html", methods: ["GET", "POST"], body: {"description"=>"The search request body", "required"=>true}, url: { path: "/{index}/_rollup_search", paths: ["/{index}/_rollup_search"], parts: { "index" => {"type"=>"list", "description"=>"The indices or index-pattern(s) (containing rollup or regular data) that should be searched"}, }, params: { "typed_keys" => {"type"=>"boolean", "description"=>"Specify whether aggregation and suggester names should be prefixed by their respective types in the response"}, "rest_total_hits_as_int" => {"type"=>"boolean", "description"=>"Indicates whether hits.total should be rendered as an integer or an object in the rest search response", "default"=>false}, } } ), "rollup.start_job" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-start-job.html", methods: ["POST"], body: nil, url: { path: "/_rollup/job/{id}/_start", paths: ["/_rollup/job/{id}/_start"], parts: { "id" => {"type"=>"string", "description"=>"The ID of the job to start"}, }, } ), "rollup.stop_job" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-stop-job.html", methods: ["POST"], body: nil, url: { path: "/_rollup/job/{id}/_stop", paths: ["/_rollup/job/{id}/_stop"], parts: { "id" => {"type"=>"string", "description"=>"The ID of the job to stop"}, }, params: { "wait_for_completion" => {"type"=>"boolean", "required"=>false, "description"=>"True if the API should block until the job has fully stopped, false if should be executed async. Defaults to false."}, "timeout" => {"type"=>"time", "required"=>false, "description"=>"Block for (at maximum) the specified duration while waiting for the job to stop. Defaults to 30s."}, } } ), "scripts_painless_execute" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html", methods: ["GET", "POST"], body: {"description"=>"The script to execute"}, url: { path: "/_scripts/painless/_execute", paths: ["/_scripts/painless/_execute"], } ), "scroll" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll", methods: ["GET", "POST"], body: {"description"=>"The scroll ID if not passed by URL or query parameter."}, url: { path: "/_search/scroll", paths: ["/_search/scroll", "/_search/scroll/{scroll_id}"], parts: { "scroll_id" => {"type"=>"string", "description"=>"The scroll ID", "deprecated"=>true}, }, params: { "scroll" => {"type"=>"time", "description"=>"Specify how long a consistent view of the index should be maintained for scrolled search"}, "scroll_id" => {"type"=>"string", "description"=>"The scroll ID for scrolled search"}, "rest_total_hits_as_int" => {"type"=>"boolean", "description"=>"Indicates whether hits.total should be rendered as an integer or an object in the rest search response", "default"=>false}, } } ), "search" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html", methods: ["GET", "POST"], body: {"description"=>"The search definition using the Query DSL"}, url: { path: "/_search", paths: ["/_search", "/{index}/_search"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices"}, }, params: { "analyzer" => {"type"=>"string", "description"=>"The analyzer to use for the query string"}, "analyze_wildcard" => {"type"=>"boolean", "description"=>"Specify whether wildcard and prefix queries should be analyzed (default: false)"}, "ccs_minimize_roundtrips" => {"type"=>"boolean", "description"=>"Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", "default"=>"true"}, "default_operator" => {"type"=>"enum", "options"=>["AND", "OR"], "default"=>"OR", "description"=>"The default operator for query string query (AND or OR)"}, "df" => {"type"=>"string", "description"=>"The field to use as default where no field prefix is given in the query string"}, "explain" => {"type"=>"boolean", "description"=>"Specify whether to return detailed information about score computation as part of a hit"}, "stored_fields" => {"type"=>"list", "description"=>"A comma-separated list of stored fields to return as part of a hit"}, "docvalue_fields" => {"type"=>"list", "description"=>"A comma-separated list of fields to return as the docvalue representation of a field for each hit"}, "from" => {"type"=>"number", "description"=>"Starting offset (default: 0)"}, "force_synthetic_source" => {"type"=>"boolean", "description"=>"Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.", "visibility"=>"feature_flag", "feature_flag"=>"es.index_mode_feature_flag_registered"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "ignore_throttled" => {"type"=>"boolean", "description"=>"Whether specified concrete, expanded or aliased indices should be ignored when throttled"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "lenient" => {"type"=>"boolean", "description"=>"Specify whether format-based query failures (such as providing text to a numeric field) should be ignored"}, "preference" => {"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "q" => {"type"=>"string", "description"=>"Query in the Lucene query string syntax"}, "routing" => {"type"=>"list", "description"=>"A comma-separated list of specific routing values"}, "scroll" => {"type"=>"time", "description"=>"Specify how long a consistent view of the index should be maintained for scrolled search"}, "search_type" => {"type"=>"enum", "options"=>["query_then_fetch", "dfs_query_then_fetch"], "description"=>"Search operation type"}, "size" => {"type"=>"number", "description"=>"Number of hits to return (default: 10)"}, "sort" => {"type"=>"list", "description"=>"A comma-separated list of <field>:<direction> pairs"}, "_source" => {"type"=>"list", "description"=>"True or false to return the _source field or not, or a list of fields to return"}, "_source_excludes" => {"type"=>"list", "description"=>"A list of fields to exclude from the returned _source field"}, "_source_includes" => {"type"=>"list", "description"=>"A list of fields to extract and return from the _source field"}, "terminate_after" => {"type"=>"number", "description"=>"The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early."}, "stats" => {"type"=>"list", "description"=>"Specific 'tag' of the request for logging and statistical purposes"}, "suggest_field" => {"type"=>"string", "description"=>"Specify which field to use for suggestions"}, "suggest_mode" => {"type"=>"enum", "options"=>["missing", "popular", "always"], "default"=>"missing", "description"=>"Specify suggest mode"}, "suggest_size" => {"type"=>"number", "description"=>"How many suggestions to return in response"}, "suggest_text" => {"type"=>"string", "description"=>"The source text for which the suggestions should be returned"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "track_scores" => {"type"=>"boolean", "description"=>"Whether to calculate and return scores even if they are not used for sorting"}, "track_total_hits" => {"type"=>"boolean|long", "description"=>"Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number."}, "allow_partial_search_results" => {"type"=>"boolean", "default"=>true, "description"=>"Indicate if an error should be returned if there is a partial search failure or timeout"}, "typed_keys" => {"type"=>"boolean", "description"=>"Specify whether aggregation and suggester names should be prefixed by their respective types in the response"}, "version" => {"type"=>"boolean", "description"=>"Specify whether to return document version as part of a hit"}, "seq_no_primary_term" => {"type"=>"boolean", "description"=>"Specify whether to return sequence number and primary term of the last modification of each hit"}, "request_cache" => {"type"=>"boolean", "description"=>"Specify if request cache should be used for this request or not, defaults to index level setting"}, "batched_reduce_size" => {"type"=>"number", "description"=>"The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", "default"=>512}, "max_concurrent_shard_requests" => {"type"=>"number", "description"=>"The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", "default"=>5}, "pre_filter_shard_size" => {"type"=>"number", "description"=>"A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint."}, "rest_total_hits_as_int" => {"type"=>"boolean", "description"=>"Indicates whether hits.total should be rendered as an integer or an object in the rest search response", "default"=>false}, "min_compatible_shard_node" => {"type"=>"string", "description"=>"The minimum compatible version that all shards involved in search should have for this request to be successful"}, } } ), "search_mvt" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html", methods: ["POST", "GET"], body: {"description"=>"Search request body.", "required"=>false}, url: { path: "/{index}/_mvt/{field}/{zoom}/{x}/{y}", paths: ["/{index}/_mvt/{field}/{zoom}/{x}/{y}"], parts: { "index" => {"type"=>"list", "description"=>"Comma-separated list of data streams, indices, or aliases to search"}, "field" => {"type"=>"string", "description"=>"Field containing geospatial data to return"}, "zoom" => {"type"=>"int", "description"=>"Zoom level for the vector tile to search"}, "x" => {"type"=>"int", "description"=>"X coordinate for the vector tile to search"}, "y" => {"type"=>"int", "description"=>"Y coordinate for the vector tile to search"}, }, params: { "exact_bounds" => {"type"=>"boolean", "description"=>"If false, the meta layer's feature is the bounding box of the tile. If true, the meta layer's feature is a bounding box resulting from a `geo_bounds` aggregation.", "default"=>false}, "extent" => {"type"=>"int", "description"=>"Size, in pixels, of a side of the vector tile.", "default"=>4096}, "grid_precision" => {"type"=>"int", "description"=>"Additional zoom levels available through the aggs layer. Accepts 0-8.", "default"=>8}, "grid_type" => {"type"=>"enum", "options"=>["grid", "point", "centroid"], "description"=>"Determines the geometry type for features in the aggs layer.", "default"=>"grid"}, "size" => {"type"=>"int", "description"=>"Maximum number of features to return in the hits layer. Accepts 0-10000.", "default"=>10000}, "track_total_hits" => {"type"=>"boolean|long", "description"=>"Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number."}, "with_labels" => {"type"=>"boolean", "description"=>"If true, the hits and aggs layers will contain additional point features with suggested label positions for the original features.", "default"=>false}, } } ), "search_shards" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html", methods: ["GET", "POST"], body: nil, url: { path: "/_search_shards", paths: ["/_search_shards", "/{index}/_search_shards"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices"}, }, params: { "preference" => {"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "routing" => {"type"=>"string", "description"=>"Specific routing value"}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, } } ), "search_template" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html", methods: ["GET", "POST"], body: {"description"=>"The search definition template and its params", "required"=>true}, url: { path: "/_search/template", paths: ["/_search/template", "/{index}/_search/template"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices"}, }, params: { "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "ignore_throttled" => {"type"=>"boolean", "description"=>"Whether specified concrete, expanded or aliased indices should be ignored when throttled"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "preference" => {"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "routing" => {"type"=>"list", "description"=>"A comma-separated list of specific routing values"}, "scroll" => {"type"=>"time", "description"=>"Specify how long a consistent view of the index should be maintained for scrolled search"}, "search_type" => {"type"=>"enum", "options"=>["query_then_fetch", "dfs_query_then_fetch"], "description"=>"Search operation type"}, "explain" => {"type"=>"boolean", "description"=>"Specify whether to return detailed information about score computation as part of a hit"}, "profile" => {"type"=>"boolean", "description"=>"Specify whether to profile the query execution"}, "typed_keys" => {"type"=>"boolean", "description"=>"Specify whether aggregation and suggester names should be prefixed by their respective types in the response"}, "rest_total_hits_as_int" => {"type"=>"boolean", "description"=>"Indicates whether hits.total should be rendered as an integer or an object in the rest search response", "default"=>false}, "ccs_minimize_roundtrips" => {"type"=>"boolean", "description"=>"Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", "default"=>"true"}, } } ), "searchable_snapshots.cache_stats" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", methods: ["GET"], body: nil, url: { path: "/_searchable_snapshots/cache/stats", paths: ["/_searchable_snapshots/cache/stats", "/_searchable_snapshots/{node_id}/cache/stats"], parts: { "node_id" => {"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}, }, } ), "searchable_snapshots.clear_cache" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", methods: ["POST"], body: nil, url: { path: "/_searchable_snapshots/cache/clear", paths: ["/_searchable_snapshots/cache/clear", "/{index}/_searchable_snapshots/cache/clear"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names"}, }, params: { "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "index" => {"type"=>"list", "description"=>"A comma-separated list of index name to limit the operation"}, } } ), "searchable_snapshots.mount" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-api-mount-snapshot.html", methods: ["POST"], body: {"description"=>"The restore configuration for mounting the snapshot as searchable", "required"=>true}, url: { path: "/_snapshot/{repository}/{snapshot}/_mount", paths: ["/_snapshot/{repository}/{snapshot}/_mount"], parts: { "repository" => {"type"=>"string", "description"=>"The name of the repository containing the snapshot of the index to mount"}, "snapshot" => {"type"=>"string", "description"=>"The name of the snapshot of the index to mount"}, }, params: { "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "wait_for_completion" => {"type"=>"boolean", "description"=>"Should this request wait until the operation has completed before returning", "default"=>false}, "storage" => {"type"=>"string", "description"=>"Selects the kind of local storage used to accelerate searches. Experimental, and defaults to `full_copy`", "default"=>false}, } } ), "searchable_snapshots.stats" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", methods: ["GET"], body: nil, url: { path: "/_searchable_snapshots/stats", paths: ["/_searchable_snapshots/stats", "/{index}/_searchable_snapshots/stats"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names"}, }, params: { "level" => {"type"=>"enum", "description"=>"Return stats aggregated at cluster, index or shard level", "options"=>["cluster", "indices", "shards"], "default"=>"indices"}, } } ), "security.activate_user_profile" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-activate-user-profile.html", methods: ["POST"], body: {"description"=>"The grant type and user's credential", "required"=>true}, url: { path: "/_security/profile/_activate", paths: ["/_security/profile/_activate"], } ), "security.authenticate" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html", methods: ["GET"], body: nil, url: { path: "/_security/_authenticate", paths: ["/_security/_authenticate"], } ), "security.bulk_update_api_keys" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-update-api-keys.html", methods: ["POST"], body: {"description"=>"The API key request to update the attributes of multiple API keys.", "required"=>true}, url: { path: "/_security/api_key/_bulk_update", paths: ["/_security/api_key/_bulk_update"], } ), "security.change_password" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html", methods: ["PUT", "POST"], body: {"description"=>"the new password for the user", "required"=>true}, url: { path: "/_security/user/{username}/_password", paths: ["/_security/user/{username}/_password", "/_security/user/_password"], parts: { "username" => {"type"=>"string", "description"=>"The username of the user to change the password for"}, }, params: { "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes."}, } } ), "security.clear_api_key_cache" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-api-key-cache.html", methods: ["POST"], body: nil, url: { path: "/_security/api_key/{ids}/_clear_cache", paths: ["/_security/api_key/{ids}/_clear_cache"], parts: { "ids" => {"type"=>"list", "description"=>"A comma-separated list of IDs of API keys to clear from the cache"}, }, } ), "security.clear_cached_privileges" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html", methods: ["POST"], body: nil, url: { path: "/_security/privilege/{application}/_clear_cache", paths: ["/_security/privilege/{application}/_clear_cache"], parts: { "application" => {"type"=>"list", "description"=>"A comma-separated list of application names"}, }, } ), "security.clear_cached_realms" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html", methods: ["POST"], body: nil, url: { path: "/_security/realm/{realms}/_clear_cache", paths: ["/_security/realm/{realms}/_clear_cache"], parts: { "realms" => {"type"=>"list", "description"=>"Comma-separated list of realms to clear"}, }, params: { "usernames" => {"type"=>"list", "description"=>"Comma-separated list of usernames to clear from the cache", "required"=>false}, } } ), "security.clear_cached_roles" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html", methods: ["POST"], body: nil, url: { path: "/_security/role/{name}/_clear_cache", paths: ["/_security/role/{name}/_clear_cache"], parts: { "name" => {"type"=>"list", "description"=>"Role name"}, }, } ), "security.clear_cached_service_tokens" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-service-token-caches.html", methods: ["POST"], body: nil, url: { path: "/_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache", paths: ["/_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache"], parts: { "namespace" => {"type"=>"string", "description"=>"An identifier for the namespace"}, "service" => {"type"=>"string", "description"=>"An identifier for the service name"}, "name" => {"type"=>"list", "description"=>"A comma-separated list of service token names"}, }, } ), "security.create_api_key" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html", methods: ["PUT", "POST"], body: {"description"=>"The api key request to create an API key", "required"=>true}, url: { path: "/_security/api_key", paths: ["/_security/api_key"], params: { "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes."}, } } ), "security.create_service_token" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html", methods: ["PUT", "POST"], body: nil, url: { path: "/_security/service/{namespace}/{service}/credential/token/{name}", paths: ["/_security/service/{namespace}/{service}/credential/token/{name}", "/_security/service/{namespace}/{service}/credential/token"], parts: { "namespace" => {"type"=>"string", "description"=>"An identifier for the namespace"}, "service" => {"type"=>"string", "description"=>"An identifier for the service name"}, "name" => {"type"=>"string", "description"=>"An identifier for the token name"}, }, params: { "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes."}, } } ), "security.delete_privileges" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html", methods: ["DELETE"], body: nil, url: { path: "/_security/privilege/{application}/{name}", paths: ["/_security/privilege/{application}/{name}"], parts: { "application" => {"type"=>"string", "description"=>"Application name"}, "name" => {"type"=>"string", "description"=>"Privilege name"}, }, params: { "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes."}, } } ), "security.delete_role" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html", methods: ["DELETE"], body: nil, url: { path: "/_security/role/{name}", paths: ["/_security/role/{name}"], parts: { "name" => {"type"=>"string", "description"=>"Role name"}, }, params: { "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes."}, } } ), "security.delete_role_mapping" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html", methods: ["DELETE"], body: nil, url: { path: "/_security/role_mapping/{name}", paths: ["/_security/role_mapping/{name}"], parts: { "name" => {"type"=>"string", "description"=>"Role-mapping name"}, }, params: { "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes."}, } } ), "security.delete_service_token" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html", methods: ["DELETE"], body: nil, url: { path: "/_security/service/{namespace}/{service}/credential/token/{name}", paths: ["/_security/service/{namespace}/{service}/credential/token/{name}"], parts: { "namespace" => {"type"=>"string", "description"=>"An identifier for the namespace"}, "service" => {"type"=>"string", "description"=>"An identifier for the service name"}, "name" => {"type"=>"string", "description"=>"An identifier for the token name"}, }, params: { "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes."}, } } ), "security.delete_user" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html", methods: ["DELETE"], body: nil, url: { path: "/_security/user/{username}", paths: ["/_security/user/{username}"], parts: { "username" => {"type"=>"string", "description"=>"username"}, }, params: { "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes."}, } } ), "security.disable_user" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html", methods: ["PUT", "POST"], body: nil, url: { path: "/_security/user/{username}/_disable", paths: ["/_security/user/{username}/_disable"], parts: { "username" => {"type"=>"string", "description"=>"The username of the user to disable"}, }, params: { "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes."}, } } ), "security.disable_user_profile" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-disable-user-profile.html", methods: ["PUT", "POST"], body: nil, url: { path: "/_security/profile/{uid}/_disable", paths: ["/_security/profile/{uid}/_disable"], parts: { "uid" => {"type"=>"string", "description"=>"Unique identifier for the user profile"}, }, params: { "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes."}, } } ), "security.enable_user" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html", methods: ["PUT", "POST"], body: nil, url: { path: "/_security/user/{username}/_enable", paths: ["/_security/user/{username}/_enable"], parts: { "username" => {"type"=>"string", "description"=>"The username of the user to enable"}, }, params: { "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes."}, } } ), "security.enable_user_profile" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-enable-user-profile.html", methods: ["PUT", "POST"], body: nil, url: { path: "/_security/profile/{uid}/_enable", paths: ["/_security/profile/{uid}/_enable"], parts: { "uid" => {"type"=>"string", "description"=>"An unique identifier of the user profile"}, }, params: { "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes."}, } } ), "security.enroll_kibana" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-kibana-enrollment.html", methods: ["GET"], body: nil, url: { path: "/_security/enroll/kibana", paths: ["/_security/enroll/kibana"], } ), "security.enroll_node" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-node-enrollment.html", methods: ["GET"], body: nil, url: { path: "/_security/enroll/node", paths: ["/_security/enroll/node"], } ), "security.get_api_key" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html", methods: ["GET"], body: nil, url: { path: "/_security/api_key", paths: ["/_security/api_key"], params: { "id" => {"type"=>"string", "description"=>"API key id of the API key to be retrieved"}, "name" => {"type"=>"string", "description"=>"API key name of the API key to be retrieved"}, "username" => {"type"=>"string", "description"=>"user name of the user who created this API key to be retrieved"}, "realm_name" => {"type"=>"string", "description"=>"realm name of the user who created this API key to be retrieved"}, "owner" => {"type"=>"boolean", "default"=>false, "description"=>"flag to query API keys owned by the currently authenticated user"}, "with_limited_by" => {"type"=>"boolean", "default"=>false, "description"=>"flag to show the limited-by role descriptors of API Keys"}, } } ), "security.get_builtin_privileges" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html", methods: ["GET"], body: nil, url: { path: "/_security/privilege/_builtin", paths: ["/_security/privilege/_builtin"], } ), "security.get_privileges" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html", methods: ["GET"], body: nil, url: { path: "/_security/privilege", paths: ["/_security/privilege", "/_security/privilege/{application}", "/_security/privilege/{application}/{name}"], parts: { "application" => {"type"=>"string", "description"=>"Application name"}, "name" => {"type"=>"string", "description"=>"Privilege name"}, }, } ), "security.get_role" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html", methods: ["GET"], body: nil, url: { path: "/_security/role/{name}", paths: ["/_security/role/{name}", "/_security/role"], parts: { "name" => {"type"=>"list", "description"=>"A comma-separated list of role names"}, }, } ), "security.get_role_mapping" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html", methods: ["GET"], body: nil, url: { path: "/_security/role_mapping/{name}", paths: ["/_security/role_mapping/{name}", "/_security/role_mapping"], parts: { "name" => {"type"=>"list", "description"=>"A comma-separated list of role-mapping names"}, }, } ), "security.get_service_accounts" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html", methods: ["GET"], body: nil, url: { path: "/_security/service/{namespace}/{service}", paths: ["/_security/service/{namespace}/{service}", "/_security/service/{namespace}", "/_security/service"], parts: { "namespace" => {"type"=>"string", "description"=>"An identifier for the namespace"}, "service" => {"type"=>"string", "description"=>"An identifier for the service name"}, }, } ), "security.get_service_credentials" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-credentials.html", methods: ["GET"], body: nil, url: { path: "/_security/service/{namespace}/{service}/credential", paths: ["/_security/service/{namespace}/{service}/credential"], parts: { "namespace" => {"type"=>"string", "description"=>"An identifier for the namespace"}, "service" => {"type"=>"string", "description"=>"An identifier for the service name"}, }, } ), "security.get_token" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html", methods: ["POST"], body: {"description"=>"The token request to get", "required"=>true}, url: { path: "/_security/oauth2/token", paths: ["/_security/oauth2/token"], } ), "security.get_user" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html", methods: ["GET"], body: nil, url: { path: "/_security/user/{username}", paths: ["/_security/user/{username}", "/_security/user"], parts: { "username" => {"type"=>"list", "description"=>"A comma-separated list of usernames"}, }, params: { "with_profile_uid" => {"type"=>"boolean", "default"=>false, "description"=>"flag to retrieve profile uid (if exists) associated to the user"}, } } ), "security.get_user_privileges" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html", methods: ["GET"], body: nil, url: { path: "/_security/user/_privileges", paths: ["/_security/user/_privileges"], } ), "security.get_user_profile" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-profile.html", methods: ["GET"], body: nil, url: { path: "/_security/profile/{uid}", paths: ["/_security/profile/{uid}"], parts: { "uid" => {"type"=>"list", "description"=>"A comma-separated list of unique identifier for user profiles"}, }, params: { "data" => {"type"=>"list", "description"=>"A comma-separated list of keys for which the corresponding application data are retrieved."}, } } ), "security.grant_api_key" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-grant-api-key.html", methods: ["POST"], body: {"description"=>"The api key request to create an API key", "required"=>true}, url: { path: "/_security/api_key/grant", paths: ["/_security/api_key/grant"], params: { "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes."}, } } ), "security.has_privileges" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html", methods: ["GET", "POST"], body: {"description"=>"The privileges to test", "required"=>true}, url: { path: "/_security/user/_has_privileges", paths: ["/_security/user/_has_privileges", "/_security/user/{user}/_has_privileges"], parts: { "user" => {"type"=>"string", "description"=>"Username"}, }, } ), "security.has_privileges_user_profile" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges-user-profile.html", methods: ["GET", "POST"], body: {"description"=>"The privileges to check and the list of profile IDs", "required"=>true}, url: { path: "/_security/profile/_has_privileges", paths: ["/_security/profile/_has_privileges"], } ), "security.invalidate_api_key" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html", methods: ["DELETE"], body: {"description"=>"The api key request to invalidate API key(s)", "required"=>true}, url: { path: "/_security/api_key", paths: ["/_security/api_key"], } ), "security.invalidate_token" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html", methods: ["DELETE"], body: {"description"=>"The token to invalidate", "required"=>true}, url: { path: "/_security/oauth2/token", paths: ["/_security/oauth2/token"], } ), "security.oidc_authenticate" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-authenticate.html", methods: ["POST"], body: {"description"=>"The OpenID Connect response to authenticate", "required"=>true}, url: { path: "/_security/oidc/authenticate", paths: ["/_security/oidc/authenticate"], } ), "security.oidc_logout" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-logout.html", methods: ["POST"], body: {"description"=>"Access token and refresh token to invalidate", "required"=>true}, url: { path: "/_security/oidc/logout", paths: ["/_security/oidc/logout"], } ), "security.oidc_prepare_authentication" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-prepare-authentication.html", methods: ["POST"], body: {"description"=>"The OpenID Connect authentication realm configuration", "required"=>true}, url: { path: "/_security/oidc/prepare", paths: ["/_security/oidc/prepare"], } ), "security.put_privileges" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html", methods: ["PUT", "POST"], body: {"description"=>"The privilege(s) to add", "required"=>true}, url: { path: "/_security/privilege/", paths: ["/_security/privilege/"], params: { "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes."}, } } ), "security.put_role" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html", methods: ["PUT", "POST"], body: {"description"=>"The role to add", "required"=>true}, url: { path: "/_security/role/{name}", paths: ["/_security/role/{name}"], parts: { "name" => {"type"=>"string", "description"=>"Role name"}, }, params: { "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes."}, } } ), "security.put_role_mapping" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html", methods: ["PUT", "POST"], body: {"description"=>"The role mapping to add", "required"=>true}, url: { path: "/_security/role_mapping/{name}", paths: ["/_security/role_mapping/{name}"], parts: { "name" => {"type"=>"string", "description"=>"Role-mapping name"}, }, params: { "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes."}, } } ), "security.put_user" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html", methods: ["PUT", "POST"], body: {"description"=>"The user to add", "required"=>true}, url: { path: "/_security/user/{username}", paths: ["/_security/user/{username}"], parts: { "username" => {"type"=>"string", "description"=>"The username of the User"}, }, params: { "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes."}, } } ), "security.query_api_keys" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html", methods: ["GET", "POST"], body: {"description"=>"From, size, query, sort and search_after", "required"=>false}, url: { path: "/_security/_query/api_key", paths: ["/_security/_query/api_key"], params: { "with_limited_by" => {"type"=>"boolean", "default"=>false, "description"=>"flag to show the limited-by role descriptors of API Keys"}, } } ), "security.saml_authenticate" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html", methods: ["POST"], body: {"description"=>"The SAML response to authenticate", "required"=>true}, url: { path: "/_security/saml/authenticate", paths: ["/_security/saml/authenticate"], } ), "security.saml_complete_logout" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-complete-logout.html", methods: ["POST"], body: {"description"=>"The logout response to verify", "required"=>true}, url: { path: "/_security/saml/complete_logout", paths: ["/_security/saml/complete_logout"], } ), "security.saml_invalidate" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-invalidate.html", methods: ["POST"], body: {"description"=>"The LogoutRequest message", "required"=>true}, url: { path: "/_security/saml/invalidate", paths: ["/_security/saml/invalidate"], } ), "security.saml_logout" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-logout.html", methods: ["POST"], body: {"description"=>"The tokens to invalidate", "required"=>true}, url: { path: "/_security/saml/logout", paths: ["/_security/saml/logout"], } ), "security.saml_prepare_authentication" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html", methods: ["POST"], body: {"description"=>"The realm for which to create the authentication request, identified by either its name or the ACS URL", "required"=>true}, url: { path: "/_security/saml/prepare", paths: ["/_security/saml/prepare"], } ), "security.saml_service_provider_metadata" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-sp-metadata.html", methods: ["GET"], body: nil, url: { path: "/_security/saml/metadata/{realm_name}", paths: ["/_security/saml/metadata/{realm_name}"], parts: { "realm_name" => {"type"=>"string", "description"=>"The name of the SAML realm to get the metadata for"}, }, } ), "security.suggest_user_profiles" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-suggest-user-profile.html", methods: ["GET", "POST"], body: {"description"=>"The suggestion definition for user profiles", "required"=>false}, url: { path: "/_security/profile/_suggest", paths: ["/_security/profile/_suggest"], params: { "data" => {"type"=>"list", "description"=>"A comma-separated list of keys for which the corresponding application data are retrieved."}, } } ), "security.update_api_key" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html", methods: ["PUT"], body: {"description"=>"The API key request to update attributes of an API key.", "required"=>false}, url: { path: "/_security/api_key/{id}", paths: ["/_security/api_key/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The ID of the API key to update"}, }, } ), "security.update_user_profile_data" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-user-profile-data.html", methods: ["PUT", "POST"], body: {"description"=>"The application data to update", "required"=>true}, url: { path: "/_security/profile/{uid}/_data", paths: ["/_security/profile/{uid}/_data"], parts: { "uid" => {"type"=>"string", "description"=>"An unique identifier of the user profile"}, }, params: { "if_seq_no" => {"type"=>"number", "description"=>"only perform the update operation if the last operation that has changed the document has the specified sequence number"}, "if_primary_term" => {"type"=>"number", "description"=>"only perform the update operation if the last operation that has changed the document has the specified primary term"}, "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes."}, } } ), "shutdown.delete_node" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current", methods: ["DELETE"], body: nil, url: { path: "/_nodes/{node_id}/shutdown", paths: ["/_nodes/{node_id}/shutdown"], parts: { "node_id" => {"type"=>"string", "description"=>"The node id of node to be removed from the shutdown state"}, }, } ), "shutdown.get_node" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current", methods: ["GET"], body: nil, url: { path: "/_nodes/shutdown", paths: ["/_nodes/shutdown", "/_nodes/{node_id}/shutdown"], parts: { "node_id" => {"type"=>"string", "description"=>"Which node for which to retrieve the shutdown status"}, }, } ), "shutdown.put_node" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current", methods: ["PUT"], body: {"description"=>"The shutdown type definition to register", "required"=>true}, url: { path: "/_nodes/{node_id}/shutdown", paths: ["/_nodes/{node_id}/shutdown"], parts: { "node_id" => {"type"=>"string", "description"=>"The node id of node to be shut down"}, }, } ), "slm.delete_lifecycle" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-delete-policy.html", methods: ["DELETE"], body: nil, url: { path: "/_slm/policy/{policy_id}", paths: ["/_slm/policy/{policy_id}"], parts: { "policy_id" => {"type"=>"string", "description"=>"The id of the snapshot lifecycle policy to remove"}, }, } ), "slm.execute_lifecycle" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-lifecycle.html", methods: ["PUT"], body: nil, url: { path: "/_slm/policy/{policy_id}/_execute", paths: ["/_slm/policy/{policy_id}/_execute"], parts: { "policy_id" => {"type"=>"string", "description"=>"The id of the snapshot lifecycle policy to be executed"}, }, } ), "slm.execute_retention" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html", methods: ["POST"], body: nil, url: { path: "/_slm/_execute_retention", paths: ["/_slm/_execute_retention"], } ), "slm.get_lifecycle" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-policy.html", methods: ["GET"], body: nil, url: { path: "/_slm/policy/{policy_id}", paths: ["/_slm/policy/{policy_id}", "/_slm/policy"], parts: { "policy_id" => {"type"=>"list", "description"=>"Comma-separated list of snapshot lifecycle policies to retrieve"}, }, } ), "slm.get_stats" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-get-stats.html", methods: ["GET"], body: nil, url: { path: "/_slm/stats", paths: ["/_slm/stats"], } ), "slm.get_status" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-status.html", methods: ["GET"], body: nil, url: { path: "/_slm/status", paths: ["/_slm/status"], } ), "slm.put_lifecycle" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put-policy.html", methods: ["PUT"], body: {"description"=>"The snapshot lifecycle policy definition to register"}, url: { path: "/_slm/policy/{policy_id}", paths: ["/_slm/policy/{policy_id}"], parts: { "policy_id" => {"type"=>"string", "description"=>"The id of the snapshot lifecycle policy"}, }, } ), "slm.start" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-start.html", methods: ["POST"], body: nil, url: { path: "/_slm/start", paths: ["/_slm/start"], } ), "slm.stop" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-stop.html", methods: ["POST"], body: nil, url: { path: "/_slm/stop", paths: ["/_slm/stop"], } ), "snapshot.cleanup_repository" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/clean-up-snapshot-repo-api.html", methods: ["POST"], body: nil, url: { path: "/_snapshot/{repository}/_cleanup", paths: ["/_snapshot/{repository}/_cleanup"], parts: { "repository" => {"type"=>"string", "description"=>"A repository name"}, }, params: { "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, } } ), "snapshot.clone" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", methods: ["PUT"], body: {"description"=>"The snapshot clone definition", "required"=>true}, url: { path: "/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}", paths: ["/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}"], parts: { "repository" => {"type"=>"string", "description"=>"A repository name"}, "snapshot" => {"type"=>"string", "description"=>"The name of the snapshot to clone from"}, "target_snapshot" => {"type"=>"string", "description"=>"The name of the cloned snapshot to create"}, }, params: { "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, } } ), "snapshot.create" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", methods: ["PUT", "POST"], body: {"description"=>"The snapshot definition", "required"=>false}, url: { path: "/_snapshot/{repository}/{snapshot}", paths: ["/_snapshot/{repository}/{snapshot}"], parts: { "repository" => {"type"=>"string", "description"=>"A repository name"}, "snapshot" => {"type"=>"string", "description"=>"A snapshot name"}, }, params: { "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "wait_for_completion" => {"type"=>"boolean", "description"=>"Should this request wait until the operation has completed before returning", "default"=>false}, } } ), "snapshot.create_repository" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", methods: ["PUT", "POST"], body: {"description"=>"The repository definition", "required"=>true}, url: { path: "/_snapshot/{repository}", paths: ["/_snapshot/{repository}"], parts: { "repository" => {"type"=>"string", "description"=>"A repository name"}, }, params: { "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "verify" => {"type"=>"boolean", "description"=>"Whether to verify the repository after creation"}, } } ), "snapshot.delete" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", methods: ["DELETE"], body: nil, url: { path: "/_snapshot/{repository}/{snapshot}", paths: ["/_snapshot/{repository}/{snapshot}"], parts: { "repository" => {"type"=>"string", "description"=>"A repository name"}, "snapshot" => {"type"=>"list", "description"=>"A comma-separated list of snapshot names"}, }, params: { "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, } } ), "snapshot.delete_repository" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", methods: ["DELETE"], body: nil, url: { path: "/_snapshot/{repository}", paths: ["/_snapshot/{repository}"], parts: { "repository" => {"type"=>"list", "description"=>"Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported."}, }, params: { "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, } } ), "snapshot.get" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", methods: ["GET"], body: nil, url: { path: "/_snapshot/{repository}/{snapshot}", paths: ["/_snapshot/{repository}/{snapshot}"], parts: { "repository" => {"type"=>"string", "description"=>"A repository name"}, "snapshot" => {"type"=>"list", "description"=>"A comma-separated list of snapshot names"}, }, params: { "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown"}, "index_names" => {"type"=>"boolean", "description"=>"Whether to include the name of each index in the snapshot. Defaults to true."}, "index_details" => {"type"=>"boolean", "description"=>"Whether to include details of each index in the snapshot, if those details are available. Defaults to false."}, "include_repository" => {"type"=>"boolean", "description"=>"Whether to include the repository name in the snapshot info. Defaults to true."}, "sort" => {"type"=>"enum", "default"=>"start_time", "options"=>["start_time", "duration", "name", "repository", "index_count", "shard_count", "failed_shard_count"], "description"=>"Allows setting a sort order for the result. Defaults to start_time"}, "size" => {"type"=>"integer", "description"=>"Maximum number of snapshots to return. Defaults to 0 which means return all that match without limit."}, "order" => {"type"=>"enum", "default"=>"asc", "options"=>["asc", "desc"], "description"=>"Sort order"}, "from_sort_value" => {"type"=>"string", "description"=>"Value of the current sort column at which to start retrieval."}, "after" => {"type"=>"string", "description"=>"Offset identifier to start pagination from as returned by the 'next' field in the response body."}, "offset" => {"type"=>"integer", "description"=>"Numeric offset to start pagination based on the snapshots matching the request. Defaults to 0"}, "slm_policy_filter" => {"type"=>"string", "description"=>"Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Accepts wildcards. Use the special pattern '_none' to match snapshots without an SLM policy"}, "verbose" => {"type"=>"boolean", "description"=>"Whether to show verbose snapshot info or only show the basic info found in the repository index blob"}, } } ), "snapshot.get_repository" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", methods: ["GET"], body: nil, url: { path: "/_snapshot", paths: ["/_snapshot", "/_snapshot/{repository}"], parts: { "repository" => {"type"=>"list", "description"=>"A comma-separated list of repository names"}, }, params: { "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "local" => {"type"=>"boolean", "description"=>"Return local information, do not retrieve the state from master node (default: false)"}, } } ), "snapshot.repository_analyze" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", methods: ["POST"], body: nil, url: { path: "/_snapshot/{repository}/_analyze", paths: ["/_snapshot/{repository}/_analyze"], parts: { "repository" => {"type"=>"string", "description"=>"A repository name"}, }, params: { "blob_count" => {"type"=>"number", "description"=>"Number of blobs to create during the test. Defaults to 100."}, "concurrency" => {"type"=>"number", "description"=>"Number of operations to run concurrently during the test. Defaults to 10."}, "read_node_count" => {"type"=>"number", "description"=>"Number of nodes on which to read a blob after writing. Defaults to 10."}, "early_read_node_count" => {"type"=>"number", "description"=>"Number of nodes on which to perform an early read on a blob, i.e. before writing has completed. Early reads are rare actions so the 'rare_action_probability' parameter is also relevant. Defaults to 2."}, "seed" => {"type"=>"number", "description"=>"Seed for the random number generator used to create the test workload. Defaults to a random value."}, "rare_action_probability" => {"type"=>"number", "description"=>"Probability of taking a rare action such as an early read or an overwrite. Defaults to 0.02."}, "max_blob_size" => {"type"=>"string", "description"=>"Maximum size of a blob to create during the test, e.g '1gb' or '100mb'. Defaults to '10mb'."}, "max_total_data_size" => {"type"=>"string", "description"=>"Maximum total size of all blobs to create during the test, e.g '1tb' or '100gb'. Defaults to '1gb'."}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout. Defaults to '30s'."}, "detailed" => {"type"=>"boolean", "description"=>"Whether to return detailed results or a summary. Defaults to 'false' so that only the summary is returned."}, "rarely_abort_writes" => {"type"=>"boolean", "description"=>"Whether to rarely abort writes before they complete. Defaults to 'true'."}, } } ), "snapshot.restore" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", methods: ["POST"], body: {"description"=>"Details of what to restore", "required"=>false}, url: { path: "/_snapshot/{repository}/{snapshot}/_restore", paths: ["/_snapshot/{repository}/{snapshot}/_restore"], parts: { "repository" => {"type"=>"string", "description"=>"A repository name"}, "snapshot" => {"type"=>"string", "description"=>"A snapshot name"}, }, params: { "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "wait_for_completion" => {"type"=>"boolean", "description"=>"Should this request wait until the operation has completed before returning", "default"=>false}, } } ), "snapshot.status" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", methods: ["GET"], body: nil, url: { path: "/_snapshot/_status", paths: ["/_snapshot/_status", "/_snapshot/{repository}/_status", "/_snapshot/{repository}/{snapshot}/_status"], parts: { "repository" => {"type"=>"string", "description"=>"A repository name"}, "snapshot" => {"type"=>"list", "description"=>"A comma-separated list of snapshot names"}, }, params: { "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown"}, } } ), "snapshot.verify_repository" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", methods: ["POST"], body: nil, url: { path: "/_snapshot/{repository}/_verify", paths: ["/_snapshot/{repository}/_verify"], parts: { "repository" => {"type"=>"string", "description"=>"A repository name"}, }, params: { "master_timeout" => {"type"=>"time", "description"=>"Explicit operation timeout for connection to master node"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, } } ), "sql.clear_cursor" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html", methods: ["POST"], body: {"description"=>"Specify the cursor value in the `cursor` element to clean the cursor.", "required"=>true}, url: { path: "/_sql/close", paths: ["/_sql/close"], } ), "sql.delete_async" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-async-sql-search-api.html", methods: ["DELETE"], body: nil, url: { path: "/_sql/async/delete/{id}", paths: ["/_sql/async/delete/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The async search ID"}, }, } ), "sql.get_async" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-api.html", methods: ["GET"], body: nil, url: { path: "/_sql/async/{id}", paths: ["/_sql/async/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The async search ID"}, }, params: { "delimiter" => {"type"=>"string", "description"=>"Separator for CSV results", "default"=>","}, "format" => {"type"=>"string", "description"=>"Short version of the Accept header, e.g. json, yaml"}, "keep_alive" => {"type"=>"time", "description"=>"Retention period for the search and its results", "default"=>"5d"}, "wait_for_completion_timeout" => {"type"=>"time", "description"=>"Duration to wait for complete results"}, } } ), "sql.get_async_status" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-status-api.html", methods: ["GET"], body: nil, url: { path: "/_sql/async/status/{id}", paths: ["/_sql/async/status/{id}"], parts: { "id" => {"type"=>"string", "description"=>"The async search ID"}, }, } ), "sql.query" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-search-api.html", methods: ["POST", "GET"], body: {"description"=>"Use the `query` element to start a query. Use the `cursor` element to continue a query.", "required"=>true}, url: { path: "/_sql", paths: ["/_sql"], params: { "format" => {"type"=>"string", "description"=>"a short version of the Accept header, e.g. json, yaml"}, } } ), "sql.translate" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html", methods: ["POST", "GET"], body: {"description"=>"Specify the query in the `query` element.", "required"=>true}, url: { path: "/_sql/translate", paths: ["/_sql/translate"], } ), "ssl.certificates" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html", methods: ["GET"], body: nil, url: { path: "/_ssl/certificates", paths: ["/_ssl/certificates"], } ), "tasks.cancel" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", methods: ["POST"], body: nil, url: { path: "/_tasks/_cancel", paths: ["/_tasks/_cancel", "/_tasks/{task_id}/_cancel"], parts: { "task_id" => {"type"=>"string", "description"=>"Cancel the task with specified task id (node_id:task_number)"}, }, params: { "nodes" => {"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}, "actions" => {"type"=>"list", "description"=>"A comma-separated list of actions that should be cancelled. Leave empty to cancel all."}, "parent_task_id" => {"type"=>"string", "description"=>"Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all."}, "wait_for_completion" => {"type"=>"boolean", "description"=>"Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false"}, } } ), "tasks.get" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", methods: ["GET"], body: nil, url: { path: "/_tasks/{task_id}", paths: ["/_tasks/{task_id}"], parts: { "task_id" => {"type"=>"string", "description"=>"Return the task with specified id (node_id:task_number)"}, }, params: { "wait_for_completion" => {"type"=>"boolean", "description"=>"Wait for the matching tasks to complete (default: false)"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, } } ), "tasks.list" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", methods: ["GET"], body: nil, url: { path: "/_tasks", paths: ["/_tasks"], params: { "nodes" => {"type"=>"list", "description"=>"A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"}, "actions" => {"type"=>"list", "description"=>"A comma-separated list of actions that should be returned. Leave empty to return all."}, "detailed" => {"type"=>"boolean", "description"=>"Return detailed task information (default: false)"}, "parent_task_id" => {"type"=>"string", "description"=>"Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all."}, "wait_for_completion" => {"type"=>"boolean", "description"=>"Wait for the matching tasks to complete (default: false)"}, "group_by" => {"type"=>"enum", "description"=>"Group tasks by nodes or parent/child relationships", "options"=>["nodes", "parents", "none"], "default"=>"nodes"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, } } ), "terms_enum" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html", methods: ["GET", "POST"], body: {"description"=>"field name, string which is the prefix expected in matching terms, timeout and size for max number of results"}, url: { path: "/{index}/_terms_enum", paths: ["/{index}/_terms_enum"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices"}, }, } ), "termvectors" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html", methods: ["GET", "POST"], body: {"description"=>"Define parameters and or supply a document to get termvectors for. See documentation.", "required"=>false}, url: { path: "/{index}/_termvectors/{id}", paths: ["/{index}/_termvectors/{id}", "/{index}/_termvectors"], parts: { "index" => {"type"=>"string", "description"=>"The index in which the document resides."}, "id" => {"type"=>"string", "description"=>"The id of the document, when not specified a doc param should be supplied."}, }, params: { "term_statistics" => {"type"=>"boolean", "description"=>"Specifies if total term frequency and document frequency should be returned.", "default"=>false}, "field_statistics" => {"type"=>"boolean", "description"=>"Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.", "default"=>true}, "fields" => {"type"=>"list", "description"=>"A comma-separated list of fields to return."}, "offsets" => {"type"=>"boolean", "description"=>"Specifies if term offsets should be returned.", "default"=>true}, "positions" => {"type"=>"boolean", "description"=>"Specifies if term positions should be returned.", "default"=>true}, "payloads" => {"type"=>"boolean", "description"=>"Specifies if term payloads should be returned.", "default"=>true}, "preference" => {"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)."}, "routing" => {"type"=>"string", "description"=>"Specific routing value."}, "realtime" => {"type"=>"boolean", "description"=>"Specifies if request is real-time as opposed to near-real-time (default: true)."}, "version" => {"type"=>"number", "description"=>"Explicit version number for concurrency control"}, "version_type" => {"type"=>"enum", "options"=>["internal", "external", "external_gte"], "description"=>"Specific version type"}, } } ), "text_structure.find_structure" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/find-structure.html", methods: ["POST"], body: {"description"=>"The contents of the file to be analyzed", "required"=>true, "serialize"=>"bulk"}, url: { path: "/_text_structure/find_structure", paths: ["/_text_structure/find_structure"], params: { "lines_to_sample" => {"type"=>"int", "description"=>"How many lines of the file should be included in the analysis", "default"=>1000}, "line_merge_size_limit" => {"type"=>"int", "description"=>"Maximum number of characters permitted in a single message when lines are merged to create messages.", "default"=>10000}, "timeout" => {"type"=>"time", "description"=>"Timeout after which the analysis will be aborted", "default"=>"25s"}, "charset" => {"type"=>"string", "description"=>"Optional parameter to specify the character set of the file"}, "format" => {"type"=>"enum", "options"=>["ndjson", "xml", "delimited", "semi_structured_text"], "description"=>"Optional parameter to specify the high level file format"}, "has_header_row" => {"type"=>"boolean", "description"=>"Optional parameter to specify whether a delimited file includes the column names in its first row"}, "column_names" => {"type"=>"list", "description"=>"Optional parameter containing a comma separated list of the column names for a delimited file"}, "delimiter" => {"type"=>"string", "description"=>"Optional parameter to specify the delimiter character for a delimited file - must be a single character"}, "quote" => {"type"=>"string", "description"=>"Optional parameter to specify the quote character for a delimited file - must be a single character"}, "should_trim_fields" => {"type"=>"boolean", "description"=>"Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them"}, "grok_pattern" => {"type"=>"string", "description"=>"Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file"}, "ecs_compatibility" => {"type"=>"string", "description"=>"Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'"}, "timestamp_field" => {"type"=>"string", "description"=>"Optional parameter to specify the timestamp field in the file"}, "timestamp_format" => {"type"=>"string", "description"=>"Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format"}, "explain" => {"type"=>"boolean", "description"=>"Whether to include a commentary on how the structure was derived", "default"=>false}, } } ), "transform.delete_transform" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html", methods: ["DELETE"], body: nil, url: { path: "/_transform/{transform_id}", paths: ["/_transform/{transform_id}"], parts: { "transform_id" => {"type"=>"string", "description"=>"The id of the transform to delete"}, }, params: { "force" => {"type"=>"boolean", "required"=>false, "description"=>"When `true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted."}, "timeout" => {"type"=>"time", "required"=>false, "description"=>"Controls the time to wait for the transform deletion"}, } } ), "transform.get_transform" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html", methods: ["GET"], body: nil, url: { path: "/_transform/{transform_id}", paths: ["/_transform/{transform_id}", "/_transform"], parts: { "transform_id" => {"type"=>"string", "description"=>"The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms"}, }, params: { "from" => {"type"=>"int", "required"=>false, "description"=>"skips a number of transform configs, defaults to 0"}, "size" => {"type"=>"int", "required"=>false, "description"=>"specifies a max number of transforms to get, defaults to 100"}, "allow_no_match" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)"}, "exclude_generated" => {"required"=>false, "type"=>"boolean", "default"=>false, "description"=>"Omits fields that are illegal to set on transform PUT"}, } } ), "transform.get_transform_stats" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html", methods: ["GET"], body: nil, url: { path: "/_transform/{transform_id}/_stats", paths: ["/_transform/{transform_id}/_stats"], parts: { "transform_id" => {"type"=>"string", "description"=>"The id of the transform for which to get stats. '_all' or '*' implies all transforms"}, }, params: { "from" => {"type"=>"number", "required"=>false, "description"=>"skips a number of transform stats, defaults to 0"}, "size" => {"type"=>"number", "required"=>false, "description"=>"specifies a max number of transform stats to get, defaults to 100"}, "timeout" => {"type"=>"time", "required"=>false, "description"=>"Controls the time to wait for the stats"}, "allow_no_match" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)"}, } } ), "transform.preview_transform" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html", methods: ["GET", "POST"], body: {"description"=>"The definition for the transform to preview", "required"=>false}, url: { path: "/_transform/{transform_id}/_preview", paths: ["/_transform/{transform_id}/_preview", "/_transform/_preview"], parts: { "transform_id" => {"type"=>"string", "description"=>"The id of the transform to preview."}, }, params: { "timeout" => {"type"=>"time", "required"=>false, "description"=>"Controls the time to wait for the preview"}, } } ), "transform.put_transform" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html", methods: ["PUT"], body: {"description"=>"The transform definition", "required"=>true}, url: { path: "/_transform/{transform_id}", paths: ["/_transform/{transform_id}"], parts: { "transform_id" => {"type"=>"string", "description"=>"The id of the new transform."}, }, params: { "defer_validation" => {"type"=>"boolean", "required"=>false, "description"=>"If validations should be deferred until transform starts, defaults to false."}, "timeout" => {"type"=>"time", "required"=>false, "description"=>"Controls the time to wait for the transform to start"}, } } ), "transform.reset_transform" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html", methods: ["POST"], body: nil, url: { path: "/_transform/{transform_id}/_reset", paths: ["/_transform/{transform_id}/_reset"], parts: { "transform_id" => {"type"=>"string", "description"=>"The id of the transform to reset"}, }, params: { "force" => {"type"=>"boolean", "required"=>false, "description"=>"When `true`, the transform is reset regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be reset."}, "timeout" => {"type"=>"time", "required"=>false, "description"=>"Controls the time to wait for the transform to reset"}, } } ), "transform.schedule_now_transform" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html", methods: ["POST"], body: nil, url: { path: "/_transform/{transform_id}/_schedule_now", paths: ["/_transform/{transform_id}/_schedule_now"], parts: { "transform_id" => {"type"=>"string", "required"=>true, "description"=>"The id of the transform."}, }, params: { "timeout" => {"type"=>"time", "required"=>false, "description"=>"Controls the time to wait for the scheduling to take place"}, } } ), "transform.start_transform" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html", methods: ["POST"], body: nil, url: { path: "/_transform/{transform_id}/_start", paths: ["/_transform/{transform_id}/_start"], parts: { "transform_id" => {"type"=>"string", "description"=>"The id of the transform to start"}, }, params: { "from" => {"type"=>"string", "required"=>false, "description"=>"Restricts the set of transformed entities to those changed after this time"}, "timeout" => {"type"=>"time", "required"=>false, "description"=>"Controls the time to wait for the transform to start"}, } } ), "transform.stop_transform" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html", methods: ["POST"], body: nil, url: { path: "/_transform/{transform_id}/_stop", paths: ["/_transform/{transform_id}/_stop"], parts: { "transform_id" => {"type"=>"string", "description"=>"The id of the transform to stop"}, }, params: { "force" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to force stop a failed transform or not. Default to false"}, "wait_for_completion" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to wait for the transform to fully stop before returning or not. Default to false"}, "timeout" => {"type"=>"time", "required"=>false, "description"=>"Controls the time to wait until the transform has stopped. Default to 30 seconds"}, "allow_no_match" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)"}, "wait_for_checkpoint" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to wait for the transform to reach a checkpoint before stopping. Default to false"}, } } ), "transform.update_transform" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html", methods: ["POST"], body: {"description"=>"The update transform definition", "required"=>true}, url: { path: "/_transform/{transform_id}/_update", paths: ["/_transform/{transform_id}/_update"], parts: { "transform_id" => {"type"=>"string", "required"=>true, "description"=>"The id of the transform."}, }, params: { "defer_validation" => {"type"=>"boolean", "required"=>false, "description"=>"If validations should be deferred until transform starts, defaults to false."}, "timeout" => {"type"=>"time", "required"=>false, "description"=>"Controls the time to wait for the update"}, } } ), "transform.upgrade_transforms" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/upgrade-transforms.html", methods: ["POST"], body: nil, url: { path: "/_transform/_upgrade", paths: ["/_transform/_upgrade"], params: { "dry_run" => {"type"=>"boolean", "required"=>false, "description"=>"Whether to only check for updates but don't execute"}, "timeout" => {"type"=>"time", "required"=>false, "description"=>"Controls the time to wait for the upgrade"}, } } ), "update" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html", methods: ["POST"], body: {"description"=>"The request definition requires either `script` or partial `doc`", "required"=>true}, url: { path: "/{index}/_update/{id}", paths: ["/{index}/_update/{id}"], parts: { "id" => {"type"=>"string", "description"=>"Document ID"}, "index" => {"type"=>"string", "description"=>"The name of the index"}, }, params: { "wait_for_active_shards" => {"type"=>"string", "description"=>"Sets the number of shard copies that must be active before proceeding with the update operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"}, "_source" => {"type"=>"list", "description"=>"True or false to return the _source field or not, or a list of fields to return"}, "_source_excludes" => {"type"=>"list", "description"=>"A list of fields to exclude from the returned _source field"}, "_source_includes" => {"type"=>"list", "description"=>"A list of fields to extract and return from the _source field"}, "lang" => {"type"=>"string", "description"=>"The script language (default: painless)"}, "refresh" => {"type"=>"enum", "options"=>["true", "false", "wait_for"], "description"=>"If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes."}, "retry_on_conflict" => {"type"=>"number", "description"=>"Specify how many times should the operation be retried when a conflict occurs (default: 0)"}, "routing" => {"type"=>"string", "description"=>"Specific routing value"}, "timeout" => {"type"=>"time", "description"=>"Explicit operation timeout"}, "if_seq_no" => {"type"=>"number", "description"=>"only perform the update operation if the last operation that has changed the document has the specified sequence number"}, "if_primary_term" => {"type"=>"number", "description"=>"only perform the update operation if the last operation that has changed the document has the specified primary term"}, "require_alias" => {"type"=>"boolean", "description"=>"When true, requires destination is an alias. Default is false"}, } } ), "update_by_query" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html", methods: ["POST"], body: {"description"=>"The search definition using the Query DSL"}, url: { path: "/{index}/_update_by_query", paths: ["/{index}/_update_by_query"], parts: { "index" => {"type"=>"list", "description"=>"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices"}, }, params: { "analyzer" => {"type"=>"string", "description"=>"The analyzer to use for the query string"}, "analyze_wildcard" => {"type"=>"boolean", "description"=>"Specify whether wildcard and prefix queries should be analyzed (default: false)"}, "default_operator" => {"type"=>"enum", "options"=>["AND", "OR"], "default"=>"OR", "description"=>"The default operator for query string query (AND or OR)"}, "df" => {"type"=>"string", "description"=>"The field to use as default where no field prefix is given in the query string"}, "from" => {"type"=>"number", "description"=>"Starting offset (default: 0)"}, "ignore_unavailable" => {"type"=>"boolean", "description"=>"Whether specified concrete indices should be ignored when unavailable (missing or closed)"}, "allow_no_indices" => {"type"=>"boolean", "description"=>"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"}, "conflicts" => {"type"=>"enum", "options"=>["abort", "proceed"], "default"=>"abort", "description"=>"What to do when the update by query hits version conflicts?"}, "expand_wildcards" => {"type"=>"enum", "options"=>["open", "closed", "hidden", "none", "all"], "default"=>"open", "description"=>"Whether to expand wildcard expression to concrete indices that are open, closed or both."}, "lenient" => {"type"=>"boolean", "description"=>"Specify whether format-based query failures (such as providing text to a numeric field) should be ignored"}, "pipeline" => {"type"=>"string", "description"=>"Ingest pipeline to set on index requests made by this action. (default: none)"}, "preference" => {"type"=>"string", "description"=>"Specify the node or shard the operation should be performed on (default: random)"}, "q" => {"type"=>"string", "description"=>"Query in the Lucene query string syntax"}, "routing" => {"type"=>"list", "description"=>"A comma-separated list of specific routing values"}, "scroll" => {"type"=>"time", "description"=>"Specify how long a consistent view of the index should be maintained for scrolled search"}, "search_type" => {"type"=>"enum", "options"=>["query_then_fetch", "dfs_query_then_fetch"], "description"=>"Search operation type"}, "search_timeout" => {"type"=>"time", "description"=>"Explicit timeout for each search request. Defaults to no timeout."}, "max_docs" => {"type"=>"number", "description"=>"Maximum number of documents to process (default: all documents)"}, "sort" => {"type"=>"list", "description"=>"A comma-separated list of <field>:<direction> pairs"}, "terminate_after" => {"type"=>"number", "description"=>"The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early."}, "stats" => {"type"=>"list", "description"=>"Specific 'tag' of the request for logging and statistical purposes"}, "version" => {"type"=>"boolean", "description"=>"Specify whether to return document version as part of a hit"}, "version_type" => {"type"=>"boolean", "description"=>"Should the document increment the version number (internal) on hit or not (reindex)"}, "request_cache" => {"type"=>"boolean", "description"=>"Specify if request cache should be used for this request or not, defaults to index level setting"}, "refresh" => {"type"=>"boolean", "description"=>"Should the affected indexes be refreshed?"}, "timeout" => {"type"=>"time", "default"=>"1m", "description"=>"Time each individual bulk request should wait for shards that are unavailable."}, "wait_for_active_shards" => {"type"=>"string", "description"=>"Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"}, "scroll_size" => {"type"=>"number", "default"=>100, "description"=>"Size on the scroll request powering the update by query"}, "wait_for_completion" => {"type"=>"boolean", "default"=>true, "description"=>"Should the request should block until the update by query operation is complete."}, "requests_per_second" => {"type"=>"number", "default"=>0, "description"=>"The throttle to set on this request in sub-requests per second. -1 means no throttle."}, "slices" => {"type"=>"number|string", "default"=>1, "description"=>"The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`."}, } } ), "update_by_query_rethrottle" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html", methods: ["POST"], body: nil, url: { path: "/_update_by_query/{task_id}/_rethrottle", paths: ["/_update_by_query/{task_id}/_rethrottle"], parts: { "task_id" => {"type"=>"string", "description"=>"The task id to rethrottle"}, }, params: { "requests_per_second" => {"type"=>"number", "required"=>true, "description"=>"The throttle to set on this request in floating sub-requests per second. -1 means set no throttle."}, } } ), "watcher.ack_watch" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html", methods: ["PUT", "POST"], body: nil, url: { path: "/_watcher/watch/{watch_id}/_ack", paths: ["/_watcher/watch/{watch_id}/_ack", "/_watcher/watch/{watch_id}/_ack/{action_id}"], parts: { "watch_id" => {"type"=>"string", "description"=>"Watch ID"}, "action_id" => {"type"=>"list", "description"=>"A comma-separated list of the action ids to be acked"}, }, } ), "watcher.activate_watch" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html", methods: ["PUT", "POST"], body: nil, url: { path: "/_watcher/watch/{watch_id}/_activate", paths: ["/_watcher/watch/{watch_id}/_activate"], parts: { "watch_id" => {"type"=>"string", "description"=>"Watch ID"}, }, } ), "watcher.deactivate_watch" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html", methods: ["PUT", "POST"], body: nil, url: { path: "/_watcher/watch/{watch_id}/_deactivate", paths: ["/_watcher/watch/{watch_id}/_deactivate"], parts: { "watch_id" => {"type"=>"string", "description"=>"Watch ID"}, }, } ), "watcher.delete_watch" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html", methods: ["DELETE"], body: nil, url: { path: "/_watcher/watch/{id}", paths: ["/_watcher/watch/{id}"], parts: { "id" => {"type"=>"string", "description"=>"Watch ID"}, }, } ), "watcher.execute_watch" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html", methods: ["PUT", "POST"], body: {"description"=>"Execution control", "required"=>false}, url: { path: "/_watcher/watch/{id}/_execute", paths: ["/_watcher/watch/{id}/_execute", "/_watcher/watch/_execute"], parts: { "id" => {"type"=>"string", "description"=>"Watch ID"}, }, params: { "debug" => {"type"=>"boolean", "description"=>"indicates whether the watch should execute in debug mode", "required"=>false}, } } ), "watcher.get_watch" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html", methods: ["GET"], body: nil, url: { path: "/_watcher/watch/{id}", paths: ["/_watcher/watch/{id}"], parts: { "id" => {"type"=>"string", "description"=>"Watch ID"}, }, } ), "watcher.put_watch" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html", methods: ["PUT", "POST"], body: {"description"=>"The watch", "required"=>false}, url: { path: "/_watcher/watch/{id}", paths: ["/_watcher/watch/{id}"], parts: { "id" => {"type"=>"string", "description"=>"Watch ID"}, }, params: { "active" => {"type"=>"boolean", "description"=>"Specify whether the watch is in/active by default"}, "version" => {"type"=>"number", "description"=>"Explicit version number for concurrency control"}, "if_seq_no" => {"type"=>"number", "description"=>"only update the watch if the last operation that has changed the watch has the specified sequence number"}, "if_primary_term" => {"type"=>"number", "description"=>"only update the watch if the last operation that has changed the watch has the specified primary term"}, } } ), "watcher.query_watches" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-query-watches.html", methods: ["GET", "POST"], body: {"description"=>"From, size, query, sort and search_after", "required"=>false}, url: { path: "/_watcher/_query/watches", paths: ["/_watcher/_query/watches"], } ), "watcher.start" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html", methods: ["POST"], body: nil, url: { path: "/_watcher/_start", paths: ["/_watcher/_start"], } ), "watcher.stats" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html", methods: ["GET"], body: nil, url: { path: "/_watcher/stats", paths: ["/_watcher/stats", "/_watcher/stats/{metric}"], parts: { "metric" => {"type"=>"list", "options"=>["_all", "queued_watches", "current_watches", "pending_watches"], "description"=>"Controls what additional stat metrics should be include in the response"}, }, params: { "metric" => {"type"=>"list", "options"=>["_all", "queued_watches", "current_watches", "pending_watches"], "description"=>"Controls what additional stat metrics should be include in the response"}, "emit_stacktraces" => {"type"=>"boolean", "description"=>"Emits stack traces of currently running watches", "required"=>false}, } } ), "watcher.stop" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html", methods: ["POST"], body: nil, url: { path: "/_watcher/_stop", paths: ["/_watcher/_stop"], } ), "xpack.info" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html", methods: ["GET"], body: nil, url: { path: "/_xpack", paths: ["/_xpack"], params: { "categories" => {"type"=>"list", "description"=>"Comma-separated list of info categories. Can be any of: build, license, features"}, "accept_enterprise" => {"type"=>"boolean", "description"=>"If this param is used it must be set to true", "deprecated"=>{"version"=>"8.0.0", "description"=>"Supported for backwards compatibility with 7.x"}}, } } ), "xpack.usage" => RestApi.new( documentation: "https://www.elastic.co/guide/en/elasticsearch/reference/current/usage-api.html", methods: ["GET"], body: nil, url: { path: "/_xpack/usage", paths: ["/_xpack/usage"], params: { "master_timeout" => {"type"=>"time", "description"=>"Specify timeout for watch write operation"}, } } ), } @common_params = { "pretty" => {"type"=>"boolean", "description"=>"Pretty format the returned JSON response.", "default"=>false}, "human" => {"type"=>"boolean", "description"=>"Return human readable values for statistics.", "default"=>true}, "error_trace" => {"type"=>"boolean", "description"=>"Include the stack trace of returned errors.", "default"=>false}, "source" => {"type"=>"string", "description"=>"The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests."}, "filter_path" => {"type"=>"list", "description"=>"A comma-separated list of filters used to reduce the response."}, } super end |