From d761c994d0d145e5ab7300961fa3a31603e74d6b Mon Sep 17 00:00:00 2001 From: michaelbirnstiehl Date: Tue, 8 Sep 2020 14:21:25 -0500 Subject: [PATCH] SONAR-13860 Update Web API info in the documentation --- server/sonar-docs/src/images/webapi.png | Bin 0 -> 15016 bytes server/sonar-docs/src/pages/extend/web-api.md | 15 +++++++++++---- 2 files changed, 11 insertions(+), 4 deletions(-) create mode 100644 server/sonar-docs/src/images/webapi.png diff --git a/server/sonar-docs/src/images/webapi.png b/server/sonar-docs/src/images/webapi.png new file mode 100644 index 0000000000000000000000000000000000000000..46488a6cca0e5924705e4afb4864d4a57aca5dcd GIT binary patch literal 15016 zcmb7r1yodRxBnSHN;(zkR!};n8Bq`kk#100O1fs0M#4f+X;eg7K#=Yb6c7~CMRVgMG%Bs{R;Xzg5beRlngN; z{F?cdjC)7oe#Q6>f>5;J{zoMWP@I8-L|*FGE)h+W5YrN|a^9!p`+Mk;k(aW!mxG%p zl3Un)1rCvU!6EdmJGP#V?p}^=t_Up&2NxVC#T{35bNBajw0H1A@+rGz;V8x5qn@{{ zai_9-Io`g7NNiJ*z$YZQPxRdEynL-aZz1OH$GFo^{=K;49a|S`IMoxWXedj7!^F75 zhSr|0j;{7d!B<3ciIg{FPB@$ zo24%>CU!&}t$f2TWpM;!q-TFmXvHl*K24_Dry;G(K z$Z;ArUC6J_FD)zIoGdCdF9_Hdyx3g!YO(a&hhbg2?|q+q8k{T6npXcVurXnyD-tMp z^U^l#d<6O|34`bHcv^qTgY*YsVe5x-+G%0yQ}S+Ko^J<^Zp-tL78uMEP*YQPYW%!u zh>ePh;!HrnuPYI!5O{Ml>R-KCN?stPYQ6X2&a6#Ontbn^*JE>fPR;~bSy>%Z)B8eo zJDeGd^fk2X4>6IHY-$!3tgo-VkQ~zI;9UE?wK!bqx5~+iIatNMx2HsO5x*I2bf4>w zGDqcLLk|jsn))G`2tox9M}`0Iy>TNzi_Ct$xZGl!ARi%fXNFx&j25wyeBm+og{S8D zXn$wsg&XgO2sFA6MrreLZ*zWi&^CeN;>F>qy|-`A;ZE_Jij(3rD_tfdC!hG3C{XFY z&Wo@M2wWvQ2j99^e?m!Qs^cM7<#OFV-jA&=q575>dI1%mh5L*`gk>Z4>A?|qW((Ob9z_yqQw5B~iezr9MYHJw7v&L;aM|dzaH?CX1DS ztVEv``z~7yF8X*FYiUuuef#!7aD||6c=0JBB7#uRtdfd{hlfL8;HK!r#$5kSUqT4oJ5hB7JaU8?FXK%`$l;zy z9Ol|J^16eys~$sWPs14RiP?hP<{Udf~FpLZyqo;QsM z3nM_3EG^mMSuXM_Xs0W%7#kZaCyw>?-96mjw*B;6;t|`vgNsW`PsmnjvZHXVOvr(B zzJY+G+bFZ%GM9t|eR+8~$NByV_lyr8PM=FW_wpCbhbeu8?pqiMrqJxn@xp?Ohk}x} zHsyQQ5z@$J4%dBH$_ZF}GG~^^hzR$kpE5{x+;RFrXL?keBGR2AL;LI3uVjT_S!`dM zoRNJ`+NF??qh!mya{>bRNQy#mK+QKk&Sy51$R!DF+9NnxV&B7>Z(K?^{QfpR;xbr_ zg8BTtxEO9x)SiGjutl;_6D94e%|)2Q`QmS@5G*!Q$M0@+$+YHaWDX@{#>pN+GN}LBSJbC&w>*dRqWe*q0Gh0g|CkqVjfB$a4pQw>< zUd_N1XV-1tH#8ItQ&aZ-eSlzIcDAbE)MV@ZM?Fo4rF4JzzBcw#Vdn$a41~6OFt7w2 zpFcmXnO$0PyToXajRna-TCE;m{IC{V->_jKu?U{i?I&ohX=m8uYI^2Lwj7Cj^5{afW_ zWf_^7sBhoCA=sm%kQDhq1HtN&5^7ikcleM)#ZwBsJ%#4~e9P1j`s4{SMv+ruQu%#;$0dw18v6-P!!Y*Ha( ztw45&A%9O*Xg1IF#MIb0dNv)yy1%s;s`0Ant$tq1qW-x=ql)-=3T9a^;&X{kn#Js- zbdd=E+fQlo!&9D_tB~_s;ZCco?QHnSQuVTe+(xe|Dv{c0N$hy!1I4wMFJBVq`>3mv zXk5M8H#U}FUhR|l{yhT(x`U(RLl^tfA@{uvM>-fid8k^pvWJI=R=NWDi%*2GRbi2E zA3P?~)6;vHno6Gc?Obk-L0+P`aB6C5M@Pqlpf=dXZwdYf6dp25UOCXIXRPsxrnR+oa*X#e30&(>Spfms`Ir5357N^UU=^jADK@sYvg+$Cud~Ieg)R(>5VWB6;=oY(ljgj|Pk74mbLDehFcs%gV~4zN=QYVH_NYgM))DD#TuVLewJh zgEr~>^sZmOCm*;qo@i*H3^@#GuoAX{X%~K`iKtb_F8b^z3y_zYoKMl>%QwiAc47CL zT^=eWf?0dC7UsitadjT2i zWlm1Q*}R;bcIR3M6(rVQ$fV%AbH?1lLfG|OW-*t<^mL(!yw9Jt_~~M>id>n6grO+6 z+RdlawY1j=aI0)yA2KpuWqJ6=u-Hft!73iFE4I&kdJ%eoi|*aKcf!GYUO%h6PqxRi zsQUZwCKJ{b6;Y-KZ=FWQkM@_-dsk^_X;%#~n}$f;{38ey`s$@cpNpeG>z_pS&n9ZD zme23pfx)L?j{KPwf{a`?f=FIAl80YmX-`@WJDr)-mg+3L$(Z$%q?sEY46|Q>IcX(+ zqmp8P>co8%HtTuO{4!>*Kiy_^vK6U2Lqq&NR%f?a@jx|bXCm_V{Cx97bL8rHD5cFz z_cM2CX5kl~Y^EsLU;3W->LA|hRQ{+i(CzVO0u`xEKfZ?_(j+1uS4YgUYC&rl9UX14O+Kwa*n}yvQc+S@kG?q?-e{$yrlxjfSy5@Ni35poTCP8?8z`9? zu*9%vE9`Qo1+A&q9PQ1sR?ICewe2t0vwc2?x3lyEW94;yyu`NMeP_j5TuSOH69%!- zA%4<%vk8i0u!RD@c#KN+bOQ+@%2 z0RaKM!@~kc=LxU}2SG*qe*1#K-V^pWZ$@P{>R-Kje=vCY_6w^gPoA(VDk|Do$G+wz zgy$TCnGa)HxpE}^z##9EvGGvy@F6cZ_jn@_8`{|TGz|@nu(){G>({Tbs#y1@nBTn| z9{H9~ZQVEj=zFX^7gqn|Z3^3RX2#CrU5du5dn2w%npkI7S2YZ#eypvwvhtL?yu5VC zL1kq=WMNTC4!W=@+`?YJY~}UEvUtJg;`0|TTDN(BI@mA${9v)Yy7A$KCNC~+r~19= zpUe2>Anp zL_GEYF*ReYJp>OP*Ykwg66)=)NS?~c4 zJ2^Z1ODS>2I57%Y&|&1osA}kiahSM-=>LMy|34s4r>>i?Z^p{3p0m| z54+WeYrJ|s&7>>1vROM-bl09LBbWOniv0m$>I7D$al*a9saz%Zh7I6(9EyhYt%~ga z%3Jk09JS`s)-%5{gX{=24ezZkU0$1Um$oV$%D8bZ(;yEOyG3Xu$iU6Z%PAq@{mA)B z-$%pjrQ0KZTO2VbtjUqIr`1BX3CM}&3HNcxzmM81$C>c1U%$?q8$ovs?{v7g-tD zsg^nz3)w#ppbYn6$XPudxWwvW#TcQtfzSp6l5P1Leb-$!^%OHR+Quf!&k^u0iVQ_} zRfPcwk~q@Jp*=i2OqOu|?l-TFrW2`f8;fY3P_nU^OtwHQIk3Q0IxAgIFn3he&aYRD zg>)4LbHuth{F|3$Vt6=q&m(TfN-)px1NWz9Y)@xl&l=3o;TIMaz4!1T z^=cp)@dYxfOVt^sw=ktUBWExJ7&$b$q@{n`C}Zp{y6?hGUp%jL{D!vlD4W!rWub7D zMpL~0Csa2OV(#5{5O%Lg-NwvSnwPy~Tb0I{2!9^)#;9?;z#pG)QzS#sbj}B<4J(0h zHs%fT$lasfgbE^R-TYOFp@dq5ZoW;PsG&A*tUo~V2u;@|cLI@I6W0&(qG1n2q8#3? zh_8=%<7KQ!>E@GmweHp!JdJvNPpQ6Z$NX{$e+DwXOcYX6U`vTmw~D%LqgEv6hWd}t zeNIjCNL>hi!=VJVuHXc{mUv?LfvD0JLe+PJx+4{dw$V451qOMI=fE}lZ*YF8z<+Nf z_~z|f6-URpCmHTv3NqK%4=*e%bia|nZ?{|ZJX#t1 z`rZR`LjL4f%&BVMWi@N-%pG4tLqRchRgVDK@yRGIrdprvp>$x& z?u!D3_4V5~6yka3PKn!Cox8zf2aSn1jKf=EV@hoO3)CgiQ`0juS%3nGD455eou`g7 z%^0&>V978NUrNW{@}29tdCUd0x}&R0H88NcvfH)7w(IHnNnvGu{lr1~CCA`fw_crM z-w2R@?=pl}J#xWyxk~f5hMS8EvtCGWaBXFNU7f{s?d(4O(^b9mo0GDc-9X!@Ai+PH zAfH&MFDM{~|7_%cj)gkQ$EtBj-u^-GxHAmcW|M<>05hI@LD9VZ_+FZPt#(#!cmKAD zc+dcK+(1|WlI3rZe?1o+5FlGsU5$$U%!s3!@Q#cSAAU$lNsFzUar?ML`2_a$YhK_4 z`4+WI7k!t=Dm_YvT%<8aa?hVX2XYhE-L08#_JQWorAxx6$oytgeS3fWIQLl_9@oLa zp`kI9$XfW6`^vboxP*kd3igv-GhcepJs^?IR>B!oRZQ^wu&-L)-ySY@=;H(?Gxg2T zGW>dO%f;myF8>4~N>&1-W_vV{Ur?}RX{0){&jEL_&SH`kbL7wBVqy^C87bE%Vc7TY zCAoQc8m)w*me*^yN6#E%1UWflDvQldP{my^uOdMF{^aIBMVf~SG6BU3FqBcX&-o`B zJV-`X79Nf$m=sX#NYm5P>zqr3AKVSIF5S=QpF9&a-FL&3MJ*c^|94bE$!giP*NqV&AhcGlvbi zw1M{0mf!CnK6S1?vA3F?UqE2Jx+m_86mmroKl3hQz;z^cmpS^isN4Dr>4^lJkuZFv zGVzrq$oN41f-O$4yF5-!WodjK_s&SLc*w=J(8_&`*JyKd)4|o1p?de5(`K?iQKRSW zgXky+r{s642n!1f%n}q+3T$7gQ|VA_W23UinF&ENm<0QwM)4|I$5Y`G$iQf1G+ffb z&8;04s5SE>$237xzrFA?j%a=p^n5f$A3AJNP3dtiY|p^01!aH#4}+=a2~Y!_PEGST znMXk2*;)1S<;cpy@^bH=-Z%2T@e2vD-O05H4n9oIBd_sD z|IP1CPQP5UPVwW%kCyu26D$*AgVnx8eh1l?6DEN%qk6d5IkN_-zRMsFNeR;0`bMh1 ze{+&xVqz+`ZKnVlj(2L2{!LyUt!fhl9{0TdIeLr0MG4r;oKjMZKw2kD7|xr7u^s-t ztUMOplPD}#;yNPhF$D2Ye0x~ZgC(4z?R+#8b+(wBmR>_5MRww_UqD0cvGK_(?`N*Y&k7A=RRRtE|9k z-D*}N#@toVXgX36P^WQ`Hc(`lB>p@}$WjfkvzIK3R;nz|g^J>F}^# zUS3w4f4(JO^evp;Ig;D^osIjr5Qgx659C%78(HLM;BqbU(ta;TEA^gQb|VBGPc43v zWRrr5RCUe;zs6TrlU6qRweJt_oS~8Sm?S`~Mr-_yimgx}RkS@(heslZtAO^?ohE-~ zpwJwD#eDntV0RrL6p#H^IMBQ>RGN9?98PIqv<#v?$skBoJr2(u53#1fv|!sFpIKMO z8c@p$GNfq8(R%t6XjrWCoMa-uy<}g$dX)*%9#%ZX&$eQ?1almMyG<#`X5%?99n+R* z3>p8|FnH)Mq$lwkN$EZp<@v%y_}90bc1|zs~toA2`04{pazPXj+@8 zTAxJ|xIPMD5H!NVFegJP6&fs$ep$xn-lvlMo^OngT)BERR4b?XA=hPLw^6yyn$Y_F z>iRRK$8cs8ZZI0J9<4*@@-M&?APq2TkAoeLjqU9zcnP(V_KYb9GiV=VWMo!H2fK(` zAil!>f|%TD3$5)(Q#S-2$>**2%VR{Gec&OZ^TguG^MF8`*N$RpS9`ZPHvegAI62s zU<^hvo>e|(?D%M#Rkans1rJV1cX)R#8hP;eaVXRpWbE1+twqkum*Z0jiV#Zirw~Z; zu(on(ohMyKYe??5aynLC|PE)^j^1oRyTsVb(K6e7Nl{WTwo z6uu2G0M5Qp@{mYvmYAE5FT1>)o+(bv?1Fe({q85XmRp8}W{v&Yiszrr)q`qWB840J z4g}fi@9czlnWJ32oMNxJ>k0O|I3;=+bG(n`#iyaBzNFE;jUd_U2vn33zg3$~PwPkH zunZjW$N1T`gizF5z89G4>gsY_U~HQSSHldwyY(hF_wFY@J8 zq)&dBOJxi2Id&e@z={XJ(JOPM<&DOGFSdxWV!ri;5gCfk{H6xtKaEXWz zY3kHV&wS&+5fOQLrMpz3GI(F|uWRv*lQT;gm|bjaEH0BzkVQmO1*4ck&r>UeLO`Q|Wim$mYOTZ2~8#kRjr2Yrhi4f#>afE279+@9H{r znzb=T@qA;m;;B^T4q+uU-9Bf)X)6s44anjrTKX|d`PJ)v+m?(dM9lt|y2bJ6*Z89P z_g1?xY*5_$#?*{fa}qLU+(JYPr`8|w$D9BgOCe2IfQU-mi+S#<{q+%3>_>(T^DD0TH~%ARYfSG4MA zXXa}ko3n6oK4-T$p+wV9Q&&wOEPq(2o=-we9Zrjn)dU3QZx+%v$XR#vdn`nt?&#O( zUhzOQm`RZ+CA;Sdr&j!aiFMR%qYg&mt3;H+l~D~!eZDvH@{^)TTe=u8=W~ry$jzCg zdY6{H&7Q3Frkqn{!>hFm%i2DPuxV(}E;In5S|Dw4dP}d_^t!f}Ig(ttcCB&Au)=B= zBha`mTYGAh4bgIT$Cp>Rz@x@YqZM zfL&SCCc;lgs+q1Je?5{*D9vxuBe_m=s^0LB{Akni2smH=z2}RH8vp~Nq`U$A&Ux8b zSy{cyQ>HUmKt0He6DnxmJ~?B%{?ssZw4!3$*@E>7TKt4C(($#>up)L8c8}Yk+rni3 zV>LnJ1FK}GOK9}NCWPGw`%! zt4TslcI%3Hm}Q|e9`&xQPX*7$DlJ0NOM%&1;_E3??qp+}no!&mE2~J~uKcvJBJ6YA zW0~R8ua$O4OMQ*{K!m-iYglr8G_bU!#)UpD#EFM>eG=03IqxcEvJ|jzh6IIbGKjysR{UP3?dbqf_PO-8wq|=k0u>16!zRp*L zR#MubU9on%XUDw1zR|8ay4vnDcIn9fO;8OPjNzKkW)x@JoL5#(4iRh>fFG)6W+~I< zDw$O2BW&1>2*a9P`b&TH5-Bo-nNb)1qzS*x|+o^b$4lm*+0VkxxPX>@n zU^p8;-VD1)25t0RmiAj=2a0A;WD%Eo(U(vz2PzZ4j))>rL+bpqnvDE>G6@L@9O8g8 z&c`nc{NpY`l1CdFCbe4-Xai=}v9MV3NL9;52{UOC5)!U_)zgliCp~#m*UT&y*j^DT zyQ<10zkTgjm$f*P$HJh2(l~xiwblfsaEIfJ)jIEDa21N`8L*dZRm8MD@Tl_XelDJPSBC%HI+| zc1usDK)_$@=uwtg#$XDGm2RJWYyvVH24WizC;Bg4BJAQut z2JMhF+Rka&`>prDHwM)%t?0qkSoVLgH0+2WH!~?T`;T{Y?!>o0K3Y+ozH6f4$qYBs5n;!yw zG1k@`KFgzVV4z2L{j8oldGcgmZ!gtX@-R8wbBTlRZ=Zpn=6ELj+nE@IGx`L%wJ2#f ztST{-oeQKn{c{@?59fKCoOAkRX8vc&pdLH_=T8%W@e=QOgVFE@4v%F1R|2uKaP*x2 zdCLJ6)J*CV|Isr5bpt&ep$eOM0rl_dpZ|+Y8Z+2~x|pg3j*0+eXHKRHWa)tx-8znM z;6%TNa?I3yl~C7k0%p^NEEK>wo=3P78FTuh!HUxMk%($KXMeIi=Q~qTe#DCD4EJY&b{HISDKC*_H{V!j?j@YcsWQgg>0|OE%cKY^KNB=$)OhG4nC0koAP*?#q(Srtxhx~^#X#;*O z2tmNRK^0MgU?0T8x|1bp@Z??vQ~79u?Z{e_J=*T!P7Um4N%Su&P)byNeWhaV-)|*k zL~s$fzV5NLFckIe)n7-Q6#5GuRe>*}l=m$Qj!;B$*=%xfa*~F>Swtb&v@}+r0iB|m z!^YAt7MGXXj}G@Af)xn1YvWB(>*di}z|4~hO;!IGqE|e>yFxDl@C2~T?YfOisL&rj ze&mj;4>TtLI~LTDW>Csdu`Ik)Ri9B&9K3vdm&q83u7zbs zqn6;xtgrM|URj$V)t25LAUU7{OW zAk8vU5J6&7*!#@|#bJ7O_9|0qOA8uaO#S?D2aHWLc&|9;9QrR5_e&LPqT{`yozd;O$jhw$=r#WnCZj-OSDH==S+&N{+$2FcbICS(ml^2^7fRK&rtN;^@Sv99$83MArTt7$=XG@>1 z0dfp0*1qu)Susrm`49RIbPWu6x0G=9dPisH>b^e}wXWCwKO9J=G9$71Fti$N$>5LF z3XJN5e?`F}8wOPTl?yrN9H#T$xkD`-%;}QGBkA{=v#ru*=K?M~i1;6L! z8e!aWbwYm|H)6m$PWL7+lgs-CS@bN464;=q6JYYhxazVXKNFukL6CoJdP%$5`5K%D z38eS3882}E3t*1pylJbA*o*S=BU7t4&e7A6h7WYjX!1Um&S`jTb>=1p{L3JVkl%A+ z&#w6MK6d=+&BK}Xn;}sZfz4qvwfNc4_MBHatcmdg2h7wXlDjGu0lvN!V@tgwpAs{V5#lL9$?`m{|#7+=%ShxrFh=#O{EmGCCyq4c@j{|Nl$E}OKw zm1ZcE@fe5{C>GyrLuY?v47o@$OS>!4AP8iHNoZt%nOGe<6#ClgRBkg?7yPJ-SZpg? zfB^OgD%L`hpUUFoJg>&@TKC$GUb|9j=>LK?2I}TGXUgd2i3U@*TAo7R!Pe<-NSOm zF+|nTF;`k{a_^a+$?}muiukSEKo{cAr}X?Sm?JRbRBUVsm6g&!5Y;XAtIi?g&{=dQ zOBM;c-x~$8fV%2sG=VVkKo0V#QYA@JJ&7tg06b4xJwsI3z23xnz`)7-9BhDRbRPbK zBKS~<87RjC+)L_*KmTuCYyW0*+drpW8$#UIoD`1^?<<+nF@GaRTclwpFbG}d3#(f{Kklmh#@1- zB$Am--g zA!9l2DIY&-cmx6>0?-WBQ0M!?_QiiF4=hv5Hpi1+bwbqC*SeojAopk%H5W`WTR%8U zmHfKGM;HVzyK3#3yBHmDp?7iT7mY!@rJwjHpI}vGx*^SA21y9&_--15#?ldg2KH|b|))w zf+&>RQ+Hy)=gBNAqySEUi^3R zN6);xy{$i|$RJp_K=g7!Z7oY}ZLN*};^HFkla|=iVk_I2<85#x7`x5^l>ix-ab=&E zlXL7QHG)LhAG+h2#(TwdrI~w5{ZagYhwNltVBxuAPiXFAYI+7703Q3H7m~M`#5^tt z2~h$N1XoED<`m%7{i$ULa--S+2>>oo=D?1O0C!E$vW^*n*oO8B7Wdj3mZ{!M)v4!6 zIMUYWA{od`TIsXM^q(xQ>%UkW&{wdfqEtDPE|@n3Z;wPyPu~POdM)1>s0ifIZoAT# z2e88R9N|$>c#Qpzk#jWb-SJFOVA*0BS2BAy@5q`k{6QwaFYSg6RfA0zVW z+S-g2r~jH#5o*~FUG#Kxu+S|;0IUu0)6)ffM9i*R3Hnx*HrIS&S84D%pmR@0M~B_m z7g$+}B8FAKu#mab5*l^>HlV_i`Bbxj61_h235R*XQvnqm+7+?)?%}~Go+KqfUO<6P z1;n!E3pR?s^B3q zms-cieIN6J7z-jR1*;st&+tjgiSFRG*wer=E4}7ua2>pGFFJbq%=# zuY)8?5r{MZg_WU%+lJj_M6i8SI)zu;g%nPw(j})o!a^#ct`)Poew{{COw3wTosaeT ze|mW&0JI*7cs5{^AYLZ}+}e}htgU&P)%a1@A1=DJ-ug>dKiT7_CMJf%I^+76C&%v0 zbSr}_un};WJW63zHed~<+lGp2hKh>1ucbp2bljvP8Ib@kcEl(sf%N$3(lj0xj9l=v zZ`uWeNI}6Yjq6?o2rOv&UQ=|&wZw>9iiL*BFVmC-0n65^+=Qnch%?O@JL`987Da5n zN>nrF%qrcL&0a&dU{Vs_Gj9IwX+~ZN(#_qSsf33qDP+KfUcT((NCMs4qv_>-NP{nV zz3{UKps1@E+(FEE_*$lLX>_@>Xr%@JnbD)i5w+vfGm;ZS|1Nlc53PdQ`BR*4j*FV)Zz)Flx&sA-S0OIVN395-DE)! zD-SIut;6Fy6!7|Kl`RxI7Y_ySpb)>w zyP9&V4K4}8-kao;GKZKwK>>LlR6p(H>J*V^3HN1sFLTJ0Af4QWpvS3Hwe=T4)*(M5 ziEAzZjfg`iJ*wu8Y$~8(<)9!rKrd8`jC}qDI{Yp6+e8Q;WC>mIXQGc0%;AUAJ#)vj zFfVQS^R*JwzQ?BV)=zr0*$k(&0c<(j1Q3rObuu zvWE5mXzx^o$^dYlyP06AnF>r}8_K)Tr4Ha;7;+$Nx=vZpSt>vzLsk~PRF`!1@)&>r zCKXj!SJYCE|Lkkh!$(wWRk?rD{a=d?A2ZoPGUy@+MH=q=UlJr(^h5~G8Z0dQyiA3) zD7vhtM+*s&7}^yGDUeA?Hq3ztPNXul43?N)25HX5P?HjsA~x3KrXaOn`^3%4L0UzE zDG#hgsE3nbb->JU?x>CJ*yw0H7qGc(95G31_}o}xH<3@#I{i2@1>^zCpw z(YU4ai-Llp2?}2gsWQ~fB9Q(bK4}SLp`w0xLz4cY4tByFD%Fq0wx9|o7p{n`}4 zhy+C>2rh`LmlrJSV&U=`UFCn9AqHy$E2L{cwWfQM%!-Go2_5fGeV~0&v)z8jK5TJD z@gKc$XZo?Wl{k~Gjt&C-9~&E9(ErhBR~l`;)2Ng84TSmd&YPsF1<*h7_WmxYjaQe{ zRik|l;{2k0?4q2x^`TA{)$Nhml^VM&l$MtE{ro9Ni07-Wt`5k8?u;L#S-2)NeB+-Y z$2ELPyN@GPRdp{2j4dq_0H`#$Rzz<8!vp6y5M@slITKm8Sm&`;nYUOs9ytq~gbIyD z0RdHmgN$@^O0TYi2i!5GpwgoZ4WE8Pmb$vs&>@6NuF%yKEp|9iV9K{t0c|&{G|I3y z-E8)>u!V5Vj3dQD!t$O}lGVZesok1wMQZgGEi5;YUKSC8Xq1UTM)4{O>WkdIcyw}X z=flSG=Pa*#fQCcM>cI=nc_>c`>Y~xF(c}JR0jGY{`pj?-Y-M5+e8?K**7by<^h9z2cT27 z-h&;`;6TjZ_gTqsj2%*VpLN|?W6W~*MGttO_)S`B>JL%72s>5Vx_<<0+3B$-&k3$T zTDxog-y1qfosn^t;wXo6BZI%;8m(!?Jt!+B_AH~Bxr?!5 z&f@f8+{g+WKJ~RrxIQ$&-$(<73XL9{@a1fMOR|ah?X!&?R+L2lZMqYma2xn_Fq&;7 zvV>4|C=yJ#g{$0!*8Nr17$_)!y0GI~c7rQ=`OzJ5SV%@K7#(mPT>bn8?J0BS#h`s| zE&+9xjx?duI8z7bQ&zZ+sNh)F)NWT09c!WG$E8d?quH~u0j5%E!C~H`Dn%9EnHPG- zsvL6dUmjHx>>am3kKsuK*c#iq{7kN3mJ$6^OZ<%uO7l#e@fU7&jU64tDOx!@i119g zz!o!AA9|PRofn1$vZBJiKqUXua5;n+gg;Lo?Y=^ehJMvSwFY)2bmN-W_oeyj&aviN z%`77Z9cY{^;B#L*+Lok)gc=DtK&P`?`yHXkD1M{6VaP=Om|^pBt{`UY>cME1gJdQv zvTZdU;Io|T{AtrIbCr>oIN;*`>@!8`Yftuvs&mvvEs0meUB*pb?>lEXNEISfzgsxB zp}9zH%yf#)1%dV8Z19~ra|Ll{JKp}fxV(7EW#=qIxC;fgNL>=CkvwX0N7|30`OV-j zpGH-%MXc9g;E#~;+{+DmHa?X2P0jP{nS1YjxXFB6iAa~>U0|OQ>Bu8Uh7NQ-p z6s(;lC~i*l$r_@uoi(Y7o^wey1c3f-rB zq)1%=3hy-Oir4q$Dob{;>DN+Q_(tfdyY1^u2?=)$YgWSE-Ig~Fm;qO26 z)UV)Ub8a1dUK`rfMn9Z!W>$P)eB^TAcrIB7{si=*Gn;m34+KM|c-kmpS%iQ71;5EP zX#}||H8~|SY){3Wr9(W^Cf}GgA%^G(lBy%fy?USYfj!#3o5b%q?3=aq^gHkns^{rT zx1gpz6z((KeYcup#P|haw^G$cm+&SNrp75=I|2R5_f{D`xhtV3g!>|1kSku}Ii_Tn WJL!BihYOcj5%o)2=t32%d;bqz1hDV` literal 0 HcmV?d00001 diff --git a/server/sonar-docs/src/pages/extend/web-api.md b/server/sonar-docs/src/pages/extend/web-api.md index 310eea605d7..ab142a176e4 100644 --- a/server/sonar-docs/src/pages/extend/web-api.md +++ b/server/sonar-docs/src/pages/extend/web-api.md @@ -1,12 +1,18 @@ --- -title: Web API Authentication +title: Web API url: /extend/web-api/ --- -SonarQube provides web API to access its functionalities from applications. The web services composing the web API are documented within SonarQube, through the URL [/web_api](/#sonarqube#/web_api), which can also be reached from a link in the page footer. +## Documentation + +SonarQube provides web API to access its functionalities from applications. The web services composing the web API are documented within SonarQube, through the URL [/web_api](/#sonarqube#/web_api). You can also access the web API documentation from the top bar in SonarQube: + + ![web API documentation](/images/webapi.png) + +## Authentication Administrative web services are secured and require the user to have specific permissions. In order to be authenticated, the user must provide credentials as described below. -## User Token +### User Token This is the recommended way. Benefits are described in the page [User Token](/user-guide/user-token/). The token is sent via the login field of HTTP basic authentication, without any password. ``` @@ -14,7 +20,8 @@ This is the recommended way. Benefits are described in the page [User Token](/us curl -u THIS_IS_MY_TOKEN: https://sonarqube.com/api/user_tokens/search ``` -## HTTP Basic Access +### HTTP Basic Access + Login and password are sent via the standard HTTP Basic fields: ``` curl -u MY_LOGIN:MY_PASSWORD https://sonarqube.com/api/user_tokens/search -- 2.39.5