From 10ce828971d5037bee0a467333a3ff595b3bce42 Mon Sep 17 00:00:00 2001 From: Sam Date: Sun, 19 Dec 2021 12:37:05 +0100 Subject: [PATCH] update documentation --- docs/_sources/api/auth.rst.txt | 1 + docs/api/auth.html | 48 +++++++++++++++++++++++++++++++++ docs/http-routingtable.html | 5 ++++ docs/objects.inv | Bin 1246 -> 1266 bytes docs/searchindex.js | 2 +- docsrc/source/api/auth.rst | 1 + 6 files changed, 56 insertions(+), 1 deletion(-) diff --git a/docs/_sources/api/auth.rst.txt b/docs/_sources/api/auth.rst.txt index 7441626e..9195d865 100644 --- a/docs/_sources/api/auth.rst.txt +++ b/docs/_sources/api/auth.rst.txt @@ -10,6 +10,7 @@ Authentication auth.edit_user, auth.edit_user_preferences, auth.edit_user_sport_preferences, + auth.reset_user_sport_preferences, auth.edit_picture, auth.del_picture, auth.request_password_reset, diff --git a/docs/api/auth.html b/docs/api/auth.html index 5fe2db55..3c627be6 100644 --- a/docs/api/auth.html +++ b/docs/api/auth.html @@ -686,6 +686,54 @@

  • invalid token, please log in again

    • +

  • 404 Not Found –

    +

    • +

  • 500 Internal Server Error – error, please try again or contact the administrator

    • + + + + + +
    +
    +DELETE /api/auth/profile/reset/sports/(sport_id)
    +

    reset authenticated user preferences for a given sport

    +

    Example request:

    +
    DELETE /api/auth/profile/reset/sports/1 HTTP/1.1
+Content-Type: application/json
+
    +
    +

    Example response:

    +
    HTTP/1.1 204 OK
+Content-Type: application/json
+
    +
    +
    +
    Parameters
    +
      +

    • sport_id (string) – sport id

      • +
    +
    +
    Request Headers
    +
    +
    +
    Status Codes
    +
    diff --git a/docs/http-routingtable.html b/docs/http-routingtable.html index 98e13b7b..1eab8a84 100644 --- a/docs/http-routingtable.html +++ b/docs/http-routingtable.html @@ -290,6 +290,11 @@ DELETE /api/auth/picture + + + + DELETE /api/auth/profile/reset/sports/(sport_id) + diff --git a/docs/objects.inv b/docs/objects.inv index aca26a69f093e1d166e945c59d2dee345b7e9aa6..b7d38f0974abfeb6b219fc79069ca0e49f917f79 100644 GIT binary patch delta 1151 zcmV-_1c3YA3GxY$f`6Mj6vy{G1v9scc%d@gW=9g-FmVC{xS6|R6i_fz3>4%x=>zl) z?)tvseS~|2ge?Sik;h#)fur;Pog*E6APd*Ig?Dsg6;+m(=7!Sxx~^Jkelq)}j~luz z{$fUiz=oI&ad%``GN9T~PRPg@0Jfo?dCPzrx9yLrNv(#o;D6hYZ#&Y``6=~!G}KRq z*wrbfoyrucRSmLfZ4tNG2Q&)7Di(&y66&Q}AwT3A%OF{g3l>p;>zojL%aJLlR65+>k79 zDQV_+Wv>vJq<<=3^Gux&+`4Np&8t$G7(y|juQ5$F#|d5Y6r;{dtqeMUp>0S43$In> z!mJ2;XQ7p+!9mKcigH-=zQTD)uazp#;vl9(qmrJ$%0nxIr7=B?rkIg;EotHsZ^^=X zd5=4Z4Nhc7?ZhpOi~`-B5qn?~Var zXQmBoA=knXx0~Y|^$;#sxo<%NhsHR~z_W+sav|l(qKxBVzFab_m25CP!DkY_Sf`Q1 zJSP#WC4bqLlvM1z{N0pE3JN%MTOIg=79E8y=4A; z?O1ZNi?+qJbp?OUNdaVNublwHnFt@5SM9>O`U$@`_`NSa*5i+-8G$+$bb5h+g@A>6 zmKwOM;{ANn*maT6A;b3lc;$UITbf>z^80t(0DmGc;hZiC>GO^^p$|e4I=6un#ShNk z+QKMupFW40vS%-NZ~`6GogLXXcId=+ZfM`EoY?og6+}JF3gnB3BG_sI^;WJ}ez6~Tw@w&3It#JC@OF~4N=&3&f=wHqV8_mr4q%Kfn5uGo`!sK5Q%A_l zl)S0R&M1QVt_dwWc2*oz{T)=%$rn~L;D0ZMbV*g*r8}S*cF)HCJ~Z;(Uy{s_CDOt; zaCd&;QQQyT_U4*B8iS8-#d&ZFn9t(PfX|&WBSn?T{(GYs(C*cQcjJ{{c2OA6dmDFN ziZ>%8qh_wXk0Rd;xY>-D-5Awb3V5~5 zY1H84D`9SjDLV94rY_`nuo&Aao#;^gj`{|!d92bMbb)tGYWNPLO(sAhBXAl-ibDi$zD%7b? z;h;cXNkhtnwCACbOgI^)t*eHf8$pO=ctf(hrKDL-JSqexsmj+pQ-_6H4-KYyRVw2n z6f^o7(`0v=(0^6WG3vb3%AoTX+J+=B|65fq%!;sg7Fu~U1}V2H%5mTGlC{c9dfk1; zd3vS6K}?AT<>y$rYh|$1ryrv!X5>Rlnz+P!a%H`|$DP+CZRV+F&1^_gqoevGKF#;! zY6xfX`F-Hq1TXo$yfd6fGa zByebo(+s@0OD-2uo-9f~4)f)bVXb6`;R|jn_+pJl67!rytd?YZQc|(=^1?-jMamEf zzSyXxV1LU~&+50!rN&@dp{=y~Sr!#eFPZ~7QuUJg|HqCcw|LO@xVBdCcTNf*Lr3il z7|ukvNUqu|YxO7m-r)Cs^`)L(o)!e^SkUMz1S|wB)U(vUWfdRio5rq-gbo?D@5dYO ztJ%`@nv_3&;06$R3FmZCNY^`Fg?<%^(76qqD1Ux%e%BU8k^A&D)RaAY!Gja%sP62@ zzOh3mzH>wSX5+-Z=WQVJIf!kr(UCc8d%KC^FtQ`}_R;pufB*UG?}dP=7#Yr^?QS%a zSa0m`A%?Eg(A;}rq~Q+9#dZ`0?#(uGy(bN&?*%%60td!Wv;Cp-bms(d*L51Q$c32_ zI)A}8(CP);y1D{?)8oF;=hm9-zbR#}Hc61L7V@kc1E0$mE2i~m{hK|lc z>>s?HB&`w?DUV>&hA-H$^P~e9lLw}%oW4HITiMhR@-iiFs