Review-> Docs -> add SVG for the scheduler API Docs

docs/autocaler-scheduler-apisv1.drawio

@@ -1 +1 @@
-<mxfile host="Electron" modified="2023-04-12T10:08:19.574Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/18.0.1 Chrome/100.0.4896.143 Electron/18.2.0 Safari/537.36" etag="G7No2c9EJuDRGXp39HN1" version="18.0.1" type="device"><diagram id="t1d-M7BKujPft_ienzus" name="Page-1">7R1Zk5rY+tekauahU+zLIwgIgooibi+32EERkFX89fccl16UJJ1MujuZjFXdwtn5tvNtBz/hvd2hn1tZOExdL/6EIe7hEy58wjAMZSnwBUvaSwlCY+eSII/ccxn6VGBER+9SiFxKq8j1ihcNyzSNyyh7WeikSeI55YsyK8/T5mUzP41fzppZgXdXYDhWfF+6iNwyPJcyJPJULntREF5nJpBLzc66Nr4UFKHlps2zIlz8hPfyNC3PV7tDz4sh9K5wOfeTvlD7uLDcS8rXdGjZ48N8k60GLEUwGrss2tHkAb1goyjb6xN7LgDA5TbNyzAN0sSKxadSPk+rxPXgsAi4e2qjpWkGClFQuPHKsr1g06rKFBSF5S6+1IIV5+3y0v90s4I3n8nrrXB4Xim017tDVMJu6GcEu9w+6wjunvrBm+fddC+Pdl7p5Zey82PDZ/0iOC9FRVrljvcVGLIXsrTywCu/ButHpAN28VKwmrwF/XIvtsqofrkO60K2wWO7J8yCiwtyvwfR53FrK64uM8meFQMSxRDDy2sAF4yKwep5G14F8IpBGPSOOl7ivgmj0jMy6wSfBoiAl3i+zOnlpXf4OpjvwXLpQF057SJAHvmreeJG9Mpi4TNOpJA3giR2B8mhFSVfhyPyy8ERpTHANR8LSfIOkoYTem4Vn6Bo7SAUErvIThA4gTcCALqFJIBJ+RJcRZmnW6+Xxink9iRNoNDyozi+KbLiKEjArQNgCAUDDyEcAdnPXSp2keueJF4Xfl5i8KegiHyBIrKD0tEO/LBvhR/qDj99cfbvhT+O3Iga9J5BqA74428Ff/oPhz91zwDvCn8U/wjl6CdqJsw/1DguXfU0AjM/ySniBk+3CDhrQpdeNzh4XMaPo4W5YwswTHjRZqQshxOEXlW8glNezwG5V0RHyz4NBRGbwac7PS/JfyIFOBbAZHFG6vcw4c9gHOYGIdgrdSTsrTiH/SqKYkB7iVf8wQjqkGwo8p4IQok/bG/BbtRfjO5Qf993d7lXfwVRE2fivxgL+A0WmA/HAvZLOUDob3lA/DQprzj+BDUm+Pm5SgN6Ufu/6c/A/qF28c+45944uVreblS/QCi1r6CP7QS7B9/aRTGAJvcJSoSLkXlpMPBKPge2PNiYkGGapLf1nzCwVmQHaoozo/BPg1+N/esistzrXMSXe4Axk84utuVsgxPJPThn1MPF54H9FwYtRrim5xd/f2EWqQa4kKwsKyDkaR5c/Q+AmAYzScXF7i6ui4Flp/W8XONJv/I6Sk8wv5b+obs6SnZJM6zLZCfeTJzde5r+dHFG/xbi7N7Wv3Js0SaO8cSffwxzvXSGdXrD3tWmQe/tTt38k1TmTvH2virzvV35R6EAIz5aW743G++gX4RWBi+L0kucKP4rnvu2ExaHno5Y9VExtpmAJKoN5t+ut0RpuVUiyw4GUMsvc2uMNnaVIEc3cUiekzmqMSZQElaUh9MrG0wA1Y0YPKCk5Wy1BEzJ00c7Q4g1gI1E53ZSr4HeItnzwYasEUZWGBtMxjubkvWTloWDHdFRO06WJSge69Rq6kt0vVKH9iAq9HoDwMTPV3VCk74uEdpJdZqZE7He1gGikXSwrpoeP5uNqGC66E1U2c2RXoiuhpy53yzTucQNm4k/2poDbwSG2oiYp64XMS7PqXxEBIW0LBxtPa24JOP4Ou6BZ+H5SdpugMLJm1Af4wfKKluNUwyPp0E9SLmWSExDEvqRUvMkEvSOAWvS/pY0G70W23Dd7uaxOObTtC+w6lraB3oYMOt06mu0UDIyJ83aY7OqKaA48iNUMsZrfqzSY5TVxHAxzCEt7PsTmagItYiMfaphiw258ObMwpwm1GYNuu1wqgmSeYTXEP47jt3vB6Bc2hg8hNeAX01LTqDGW/RoVBiX5wzpxly7GGaLcBk3vFR6tnQoOTsX+vNwTFbUaMal2GpX7hmrQY4IOTMa9Lhjg6CvTznM2BzSaTnTJAICcR5MVdQYLihUyAufHUMEe0gaHwdEFlPK0pdSMu4dTQtrte1OHrENJAzsyE+Q/iJnheGiENOdkQagVEP1aq70ZNPYuMlhJC+sqmiZcGDM9qB2j4wNm82KII43CbpEBJHHLZ50dqizPsTiHF1KZBnKXEgO5m4OQdcPRUAy0nxWe1SszGcaJKsQHa2IZKGS6WydS+FRJLTxaE4OZ5uJj+dSTy4YXhpscwAnM+rPbd8Fvab98dTaT/HJiU0xXj5i5FE3e8kClxRnifYteo7O5mthao0YNj0qLsEeif3S4H0EM3x9SpMKO3OXSr6R5kzdWzD9AhfG6nbClwtzTcf0wdAmZsK2DhjdgLyw1AiVrtO2TA95bY0Pc9kr7Xpkh01bE1aZr5PecG63xNKgucoMRtu4HilVYzMLcrYzVn7Jx1udmA+nFGczQXgYhT2iT0X8EuPsdW5WRY9O9WRDryxAe1Ie1iSEFdlUvSNSnp5Swvv0ASyn2h3BDeWL+t/dwjm2bC/mH42hZ3qjdPp8U5/8Z7KYYj/j9EulBKfRzxTWofNj7Gfm2va5YEZJ5Knip0tn/D7I3ws9Zwv7+VAFblL4yHnqeEUBdUnEOlmpUVKD3dG9j7neRrK/3eIBDLeNTks9h70RK3HPN+hpmzjX5VWSREnwi+7cH0toKILc+io/eNfH79UuLQWgDdMCTM2dcfuDEZg/D7/YTSYGzt5bNvR7ovfqjOhwpdlXvu6leQ7T6548Pvbv5e95S4Te4JO+x2cXu76ZoUpg36+k52tbs8uiEcUFmHNaVpqy8uqF5Wd+YyhmU6K0wx/AIPysNtBF2E9zdcIZ1JYKSFRo6rEvuHBjl0PYhF95eexqLKPXjC9juBxoxBiGnKSYqBQKBxfCrAH/HR6fkX5OuDXK1Doz1oDWJulIu0DYsd5SbBay3pppFHtQ5AZGH3qKvqcZeYHpBA6VfOxQV47vBaLq+15uJceaZTzBXB2YsCygejGpgC477NNHQgoUowB/23DKaXIvC9sBl07E+XBE8ma8dxLBkBBxQWkWP5z1coLjMtD/wHNZsG/4foTsvX68Ib2e6u2sVan0NFlWF0xg7AYzLZ64Ze0Emi328z0lAkWGx5PYVUhTwvMJF6iiqAycibjKhrNJCTAoNY64h4pQKLC9NFDakG3FbFxzptgmzZgsxgAYwmg/WWWaPKwTftlr2nhqTzzO6qlZsZBqbEFwYoovfLUVFwrfHxKxKi7YnT3Ml/Zw7R4WXrOelTuooa7srVHrVQm0dov2MdFcrakRNMHQwdYP5uK2nUYrvuz1KwtbrdX5soporVRZerJt1ps1Oorl5UxVVPN41MKR1SNR3UIdWWqhrttT2R003jaOmDdqsdyIyRKfZko/E+h0YGn5sLQWcclv40j0VX9rTJQsKA2v4pPJXAtYx5yrc6HUt0Ejrv0G5zxka61EHdoVE3o7PevCuDn2D+Uoq4v12QbUKPANTTgrhuYdrbE4w/2SqiNLv5QQHa4s/Em3fC4jSIx+KyGB/4Alv9ZsIR0GgmL5gL/6UdgyblnSOyWaHZV46uI5PbGj1VaM2oqFpLFkKz/W+R0wkdeiOsvLPLI9N676DdD9JNGc0MLCOuwIRtEPusf2iQPKmGwWQdSSx1U6waf4kRVCebZVY26lUIarLdUBU0rDCNLFTk7E8dwtXWm8GAfmEVFNteFUnttzdpDOtpxecEbqq/Z2Io7dPAKcGpjCLqGmTaWIrQ/6jnYCsoknBins+2owXWupkWLmrAKjpwci1f25P8fk8WhKVzUp+ZlZ9/kzAQYKgM0vSnDES4JD7wgOBSZKF8G9Fbn9gOMon280OywOgt5Yy2bHqmt8xgpM79DfDbNEDir1Ighor48PenTfnHPQ01O7xDzfCmoCUKaNICnpbosTS3xcky7YVaDJuSN0aG1WxN51e4qfHGBh5gwsIDuP7mFdyQQGNxhyOYNb0qkeDOSjbdn2lnsIDVlmCtuP8UgWdjjPLXEopDRhDj0MDMvQCYQUnTHKsVHmnCYOGFQPaI8m9f4A1CgeYY3hRsEJS5M+9kmSng5KqmZCPHRInOeJLONDJmO4BrqF5lSZwGcD8oAXG9SS23A5ouVhsxQAo0necFT3Iy0b1YMpy+urZbDihpaozHCUa4SNmQrcWlLnnDw1F8pk20dHq7YnOxVXETOHl7xFs48HQ4mTcqWqtvvDRBsuAgFZIzi3QhxCjrPFAZuQ/CLIVXW7kKdcusraSqArzo0FysDV4URci7mjTPzxpN8ecnaAL+WY75E4QSuSMDHaPbnHCnCtGbOB2+9PzK1apz5Ez16lJ0JmqejiEI64uD+0IrmvTZNdsbMoIjCn+2ybzllkbLBYElkVDVE3xYO9Fx3msgjuokFkk3uxXQvZYMJYWdA/SnOsqBt8xWEHq9wYWTCOTbod5LXrVh7rEJg5GLbcWN0q8+0Rnw5MiyDZadwIvc22GS2VaAS+gYaCaPlazU1R2I5itTkWcsnyDL6ErrR+LDr8zDvuxwO6wZvGXsfCURhLmrO1iomErmdQm4LiQkkzC1wSUOwpeT1OyZrzB5Yw9SbDNccdcH4Tb45DPkA0fWSbDL7Sh5tGm6WyXAdxsaisaigzce1K8kxYKesoozJiRpeys+WNEX9YsilAG8HiKwANPulxYsvOR2guZzbPyWqKGERGEFTe+nkVuOUq1vR2iGw815sjPEEODnk9ULzByGCndVgI3Py4TiBv0dxMLIUikXNI1pOtBh9o2OBawAW4eeit98wyLoL+RN0Zi0FgOrQ71fHcKk11NRzH9m61UTxhsUPzoqH1PlMFo8hpPY7fowtyJZTpoVm4NaMGMx7yV8IMMc9RXCguJKsPPaHCjhmuVxtfKgWokLWyTEHZXOB7hwjqLZRGi3Z5ILd7ds/Okt4MdLLtQVWvB/V8s4mYFWjC2JBJbIer/A1ee3jI6FPodp0fcTZPWD3ycA2qixhRIf4vKdIfKOallXHN4HquRNBMh8uJeiORTt5rEL/HkRKSfenFe3gM0X/cSYj77fF3OFRyB0kC74oRvjMs7/PqruCD/PkCYi9Sg85eBZhbgxHZoTOL5lXnUx5dJOfpXu0l+U2DlNSNu/KB7MpufdeDK+QfdnLlMS58RQHKfrDLmGTuoP17HZ0g2W6I/8OzEyRziynmBgVvfHiC7EzNfwVr/AI+3J/AKbcRPMAp98LqXdOKqHtv7b89DRy7RQKBdR1GfVeBRX3IWa9fOXGSuuik30ycPCuvH5U5SXV5lv5LBP8vEfwdNxXsVp6RXfLsfTPBKfI/gXYDkdcebPlggdZ1suWPTgW/OTX2gHcZmO+rtN2n6/+rE5Ex6lUS7n01tj8sH/8OBzj1wRi4mq7/5YX9lLy/m9cqPHTlCbxrYhh7n096h7mORCIbJhLBHIFD7olTcb/1RihKo/2AWiiFQaQIDMnK5YBhjws8HQwblWaIvj/zYYxGXeyCHeWXuDfaNfoUGYewtY3SMBjEjrC0xwhEvvHtlN7s58zIFerJ0dHDSo8xXT86OAzX4hvcnZHy7JRyxDG+J6FkqJhJjx/aTCXEMnEO5wp7mWYstucwqKTTCT3Vxj2cwXRRHww2jYbKK1JO+1Zkej1yOFm2fS1SV7JCLgNe3VgwPWUhwihxM91TLT6aGcExHaPJfMEj6tZWbKG2tkwzRkRB4YZqcITJUekkV8cWFxWzeHgcqaXF0LXpkWppSylHzQaTnpWWixrQQ2CPyo2Z4FQ0VPhm05fUgTjDcqkXC8OsN5/UOCmu1GjrkGq42GumPCsHurLcDlahzjGpJNWItPSQmqeNedlOKX1tqih+zPCcSjbLIl5LaS1SGYyi6xki75e5Di5huEzVbC9d79lFORGFUkBnrh8juyImslrwMK3wUYFZL6tjES8sT5O0gcdZNQsTvLf5jJtjJXuKzPOCHxLBZFwu2MGymmiSCgdf2kYhLHzJw1KOQPaNTi2rPZeXq5ZdmTl1PJEHWoo8FkhzmB+eFaFdjUuO4KUZJ3FGT/XFCKEZQRbLgdIfTlZcyvvGeMQVoiVJypiLprwyaA2LFyamuPfZWgbDGLqhbY460dAb+2j6xPGcPbBcn5MZeUugaxgTROqfHwB8Kc1OPXDw+Un6EfWZZp99yNu9mujYqlmW/ozdyxLq81tlgLD3fq7vDcugzBfCMrMxqOW9jqDMX010CkgWWX7KN0cKz6nyqGz//lIu++8Rt/nYrepOE+nwoVId2UVvZuyyXdlsP4m4OOgFUoz/6OP19EG/IiLIdmgy5JvRB3uHp/dwhlxeV3p9B+mr3lV6daA8elNe92pUiM3LQlDmffwp7O9xsv4anv4gR9i/CI8f+gJb9t7lIu5sz3Vfc3Btlu4cC24DPQBOK0pgAgfylw8MUvBtnHSDv++o5L2zaZjb094dB0neN5UGRboswDNwq7hzV90BIoqSy5aKgC0VQ57+n1Sy29AFfg5YEJdvmj7HLZC7KM2DlWWx91C0wNbcnRvfBmbOdQ9V1B2xuS01vCCF0RlT6W4/Te0UMPbpenxoAy85X5t2lZRV95hSlFuQqCwYPXrNIoQ8BUj4nh6yF9ce1AxA3cirvO5eBRjvofDyyH8Gz2f6zjXH6VJxxiSsSdJ8Z8XP6morjyzwDdQQq6xy+Dr2r7ZzrOxLTZoL2cJK4iLIkBhIUi9/gLE0qKTf9UzzLITAOedmncugmvVw0Zi4EyVaefmsKgKsm1wmeiS9U02Zg7F8MPx1ooufGrLZ6XXxz2Zp0tx9ua7HscCj2NsIDAfHPKt4DxdGfdHuh4J255W6npPmQLSmyUMZRs729M7EU/coicroCp7bts9Q+dV2z5bzvN2T/ouUbfaSu4t9dToy/KyNE1tF8aKRFQNsJlbp3evSV+ERR9eSUVpe6OlWZkNRHSWQupGqOBtvZeidTbj0dKj46lkEJeckSeSvx4PFSApjqBnYucEXBUD797ePM8PDy1Nvl9be41y2VUQOV5WhmMDoiCvFFhz8fKjZTR/b+Wkcp8155igBQshyX3N8GrkrErFPDPIJ2jN3bXm4V7ieb1Vg3BO9WCcR/ggGL3EvcZvrye4sB+B1SrhFgiXmj8u9g9wPLPWho41ZPIGuSp7PDlDmR0F1Jj2IKas4gQr866exdQLcLnLytDinUf59fkIofRHn/JznYZ8/JDTu06q84gk+NkAV4HsgG+E8n58ZbU8k96wQbmJft+O+se0/U9cw4m2Nqlu3Dt1hdZNkh3qA0m+nH9wnXxiACWKIqMF8CP7r57cNdL8pIE3iE01H8PTmyUyHDNvR+BVW9i8Q63xHYmBp/DN+cyIA70g5wN9VXUQ/1tRCPrMs9tLcIhDmGwbX6e7210GeW2HYVzD5aOE/WvWr50Z9p4X/Ey03FPk9UhpQ9N6OAJtDHRVASJ+2Bxsu5uqk7SAhDfqz3o7hX4vvL3Lu5eeHLpN8esw8eI7Vr/HMFxkd+YwSNP5S8l/m/NFU5GuT1PcL702SjNEP/lmhf+Bz+X5uR39Bbsc/ltvvvfH33P4tjfN5tgASR3ZuXZb2B4mGLzhOH0UD9ssLAuQ+me3f5rVDb4IdXWk5nW47FH2rWCva8Xr/cdKhlD+9iAu5B//JTju/M+ysoXvPVfTfTCH/Md79jpDX7cEegukgg/d9W2rHLwz8RwVvSgXMzVnIR2H/BkQAbp9+PPIssJ9+gxMX/w8=</diagram></mxfile>
+<mxfile host="Electron" modified="2023-05-22T14:53:18.681Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/18.0.1 Chrome/100.0.4896.143 Electron/18.2.0 Safari/537.36" etag="t85FlPIPGBBftR37arXV" version="18.0.1" type="device"><diagram id="t1d-M7BKujPft_ienzus" name="Page-1">7Vxbl6K4Fv4t8+BaMw/W4iIqj3XR7tOnerpn7J4z/XRWhKiZRsIE8DK/fnYgIJBoWSpYttZDCbmzv+ydfYOW+ThfvWMomH2kLvZahuauWuZTyzB0TTPgh5es0xJD64mSKSOuaLUpGJF/cNZVlMbExWGpYUSpF5GgXOhQ38dOVCpDjNFludmEeuVZAzTFUsHIQZ5c+j/iRrO0tG9pm/L3mExn2cwdTdTMUdZYFIQz5NJlocgctMxHRmmUXs1Xj9jj1MvokvYbbqnNF8awH+3TYW3/0/7jr+DbB7vb6T/bf4brX39r6wKNMFpnT4xdIIC4pSya0Sn1kTfYlD4wGvsu5sNqcLdp80xpAIU6FP6Fo2gt0ERxRKFoFs09UQsrZus/Rf/k5hu/ubOy26dVsfJpnd2tSMS76Xewr9LbQke42/TjN8VunzEjcxxhJspk6gmChjRmDt5BMlvsQsSmONpF2rQdJ2dhAoHNO0xhNWwNDRj2UEQW5f2GxLad5u02yMKFAPc1QKfjLpAXi5neY+TBFjW0EWYLoIvR9eBxHsb8asqv+lpfl3ZHGfvljER4FKCEYEsQAWWctxIZ5ovwaidZRK2V8ZMQIGZP3C833KhnLDYrcGJXq4mShkTJj4j4u+movTk66h0DuOa8lLQkSmbEm1B40CK9un/HNKtoh4lcuYcGej9YJfTJ6jOaj5wZdmMvgQPNOTn9cRgkDRKcCFBazAVLT6dLe0pIAYGjMhxhxOh3/Eg9yqWJT30uFCfE8ypFyCNTH24dgI0LngcOF4Gz5V5UzInrJhJVhX95h5xgC5iaVdoCbRl/ONhk/O268O9K+L8bfPlx6a9bFVHWlwHoKvjPrIv+veumf8eUj5JG6a+b51C+Dtd8+qfWaETXz5Qk4l7g1LErOGkVAFLVS/SqYJAv43BY+opjaTgT2tIwYHyCGY7DPThlfw5gGE41NE6G4sAG/OmS57UeWtYTHwuQTE++VzHhCRgn54BMcNl76mBGXZxj74TIg73n4/B6AVJJNl1rEiC9c2VnS6+MgN1TaNfNHi6ydv00eB58GfzAIPQrNo51dhSMN+Vf6b3kYOGGUIZxC6iS/B2lM+hCyX/RXWKcWrk4jntk2ySzF12y2G6aTtCceOvUOM1NT9HgA44eGCI+nEvaR+rTan3LgLVqc6gJU0ZR2LXZIgKGlYvY3gPG9JVdxsj5Pk22XNtJoeeLZ9Pxz4ZlpWsqXvyyZZbhArAYoiAIOeV7D3D1fyBxD2YahsIaDws2d7qe8hoT9QorShOa722f/5iHum6opFnuKC+Ks05t4kx2ZF2ZOOtdpjiTTf2MY8O174w2/Hk1zFX2heWa8NlMGl02Oz9/vSKNWS3emlWZZbPyqiAw9DMDYMoAPFMgz4yGMPV9GpA60BVzDow8NMbeQ65fFY6iYfJ3yBF1uDlkWrKM6zUJr21sVaqPDvg8xiwh1UUFdc60P/JcDFmb7CriP7Vpk7Z9Fm1SJBFkmQF7ZRBkGmiuju6XsMDREwuB870OhdS+UIVUO68lcbk4vq20Els2LAbzMXY5SlLkvZoY8YXOHcTF/iOQExGfR+u1nydwqsPvKGDEn/4i7ZKmEye6VSWps6elUFvahK5w7X7yuT/owx8f4f9nRp0k+qGx2PeBiKkvqkJ8yr1B0ZLCf5dMJjg9PbUAuOpCzMAiUxr1qlLdSuhYV0XA6lKVvwzotxUbOcan+eK/3c502iNP58znksimIO5WSnZ6uZmXhUr6DTKUkpayWtpQRteJKdmzGs3pUtLSlGj5WhXf6FxXTtdRm8CQNkFXl9nJNBVb4BRpXcotcHmh36Mg0DuSRLOb86MoEbAkajeWV1TRS/ci5LH5Qt0qALqmV0i7JWVIGsuo5B7JI6Wa/CmSj5TQqeKOw8vQx04hzqoxL01TOClqcssr8ZDtmwvIojhOnlmSXtFt0jWvhKF/DolWU9zxZRFZ9hcoCaJ4C2W7btuAd2DXIm9JFLckinMdKLpRFWZmo2kUauP9R0qjOIk407N3O9+0PNNlr8vFp1GcmL36qtTjRjW27JXWC4rin9j+VIu4Zt2Tsh/oykDoG+eGQPbDXHcyxXEA96uSzlYEgupKp1ADfBY3z0aLuLNto6xJdLT+C6pEcld9F3/fQE4euc+j9d+yYbdG7k+po1yEzaXIXAfWXpCQAEu6UDHmawmT6Kpy/zxzPqtPWXld1E7Bs+JLH2KSVq5IFCHdwS9bOVy7AyFullg8i7Id6qDMmtDJJMS1uAuzxN7LS6N4PaPrb47Rm0q9UE8uJwzLjF6NXFZDZ8VTX/PImCGxsuuRCr0XpILx5mWA7GZ7ezk4RylfXVsyMxXatdLMzJNlTp81oElkv2Xh1KqDd6VAX09TbINGrSxD5RJ6wVm8b07zEw4YBu7czseSC/hmuSkS+KoZEgoXla3YM1Zte0a2zF/cM9WogpnGEjrit9dLQwqaFEBpoyDwcDtchxGep42rMZO0rh0TdTClWjrCU8rl3Nf/qNv/TscUNMbk+tNqPcV+ev11HPtRrB5zSBjiBw7igZ19FvHEKHFf1eM99haYb2Go+xXHWN0rhPHaIRiokwI9C7yaJSeJihQnXuNTNkdeoW6BGEHwC/yCopjxjxjubOegYFuTpdiVvLIj+ELzQEXHrM3DXPx0kXpSFsw4cdKkqrSMy4O2YO37ZIxJVKghwLS+mEfLHjSpiRgMNYHRs3mEB5nzUPKNxcIkS8rc8rLyseBJxt8JDMfHTEVRW3Bhqd1B4bR0pS52KANNjfrtaEac78mHQJLuxCcRyahTbVtAcme7wnJK7SYeRVGVOC4JAw+ts+YeSfSDn8icn+/I3xprrGa3SUUDo9XXWrapaPvARZ+LJygGgZIQCCUSKXP0adh3xeHPv5DJFwRGQAS6c2I0AMb8qWe42CUs5UFuiTtypeYmuG6C6ya4LklwvTrT4cbPN36+8fOb5edmFZG2os3XEOcaROwXdQuH+hMyjdMH4G2428NJ1ZO0fVE3WZJoRuMoASEkDvyiGFr5nHP4AHevNIJfcFNVX/E7geVpVr1WliKbtavn9mnZb1Wb9an67G7V4+u79/zj6Rt/QIFSZeNeTbdD0sALRLF2mOOHOmIz67/6NcktCd1Sani/8g6YNNDBn6WE281n4NPmm6/pm4N/AQ==</diagram></mxfile>

src/autoscaler/healthendpoint/server.go

@@ -101,12 +101,11 @@ func NewHealthRouterWithBasicAuth(conf models.HealthConfig, healthCheckers []Che
 	return router, nil
 }
 
-// Adds liveliness handlers on the paths
-// "/" and LIVELINESS_PATH and adds a authentication
-// middleware for BasicAuth, for all paths that are not
-// in "unprotectedPaths".
+// Adds addLivelinessHandlers responds to the "/health" and "/health/liveness" endpoints.
+// By default, endpoints are protected by Basic authentication. However, endpoints can be accessed
+// without basic authentication by defining UnprotectedEndpoints in models.HealthConfig.UnprotectedEndpoints.
 //
-// Returns an error in case BasicAuth is required but the configuration is not set up properly.
+// addLivelinessHandlers Returns an error in case BasicAuth is required but the configuration is not set up properly.
 func addLivelinessHandlers(conf models.HealthConfig, mainRouter *mux.Router, time func() time.Time,
 	authMiddleware *basicAuthenticationMiddleware) error {
 	livenessHandler := common.VarsFunc(readiness([]Checker{}, time))
@@ -124,7 +123,7 @@ func addLivelinessHandlers(conf models.HealthConfig, mainRouter *mux.Router, tim
 }
 
 // Adds a readiness handler on the path READINESS_PATH and adds authentication middleware
-// for BasicAuth, if and only if READINESS_PATH is not included in the models.HealthConfig.
+// for BasicAuth, if and only if READINESS_PATH is not included in the models.HealthConfig.UnprotectedEndpoints.
 //
 // Returns an error in case BasicAuth is required but the configuration is not set up properly.
 func addReadinessHandler(conf models.HealthConfig, mainRouter *mux.Router,
@@ -137,14 +136,13 @@ func addReadinessHandler(conf models.HealthConfig, mainRouter *mux.Router,
 			return fmt.Errorf(basicAuthErrorMsg, routes.ReadinessPath)
 		}
 	}
-	// unauthenticated route
 	readinessRouter.Handle("/readiness", common.VarsFunc(readiness(healthCheckers, time)))
 	return nil
 }
 
 // Adds a pprof handler on the path PPROF_PATH featuring several endpoints.
 // Adds authentication middleware for BasiAuth, if and only if PPROF_PATH
-// is not excluded in the HealthConfig.
+// is not excluded in the models.HealthConfig.UnprotectedEndpoints.
 //
 // Returns an error in case BasicAuth is required but the configuration is not set up properly.
 func addPprofHandlers(conf models.HealthConfig, mainRouter *mux.Router,
@@ -168,7 +166,7 @@ func addPprofHandlers(conf models.HealthConfig, mainRouter *mux.Router,
 }
 
 // Adds a prometheus handler on the path PROMETHEUS_PATH and adds authentication middleware
-// for BasicAuth, if and only if PROMETHEUS_PATH is not excluded in the HealthConfig.
+// for BasicAuth, if and only if PROMETHEUS_PATH is not excluded in the models.HealthConfig.
 //
 // Returns an error in case BasicAuth is required but the configuration is not set up properly.
 func addPrometheusHandler(mainRouter *mux.Router, conf models.HealthConfig,
@@ -182,8 +180,6 @@ func addPrometheusHandler(mainRouter *mux.Router, conf models.HealthConfig,
 			return fmt.Errorf(basicAuthErrorMsg, routes.PrometheusPath)
 		}
 	}
-	// unauthenticated routes
-	// /health/prometheus
 	prometheusRouter.Path("").Handler(promHandler)
 	return nil
 }