From c11912bd6a516066c2dde6e0c7e8de09a735f042 Mon Sep 17 00:00:00 2001 From: "fabio.d.mota" Date: Thu, 2 Nov 2023 12:47:18 +0000 Subject: [PATCH 1/2] fix(Documentation): Add arq42 fixed to country risk backend folder from leading repository --- CHANGELOG.md | 2 +- docs/Arc42-Documentation.md | 14 ++++++++------ docs/Images/reportUpdate.png | Bin 5774 -> 4673 bytes .../web/rest/DashBoardResource.java | 2 +- 4 files changed, 10 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3c84fbd..ee71939 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,7 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 # Changelog -## [1.2.1] - tbr +## [1.2.1] - [Unreleased] ### Changed - Changed arq42 documentation to be updated to current application diff --git a/docs/Arc42-Documentation.md b/docs/Arc42-Documentation.md index 3ad804b..f64d222 100644 --- a/docs/Arc42-Documentation.md +++ b/docs/Arc42-Documentation.md @@ -287,7 +287,7 @@ https://vas-country-risk-backend.dev.demo.catena-x.net/swagger-ui/index.html#/ ![apiUpload](../docs/Images/reportUpdate.png) -This endpoint is used to update the report. Let's say a user has already saved their report; when updating it, such as changing the selected range to color in different ways, just press the save symbol and the new settings will be updated. +This endpoint is used to update the report. An example in the dashboard is when a user updates a report such as changing the selected rating ranges to change the rating colour ranges, the user can press the save reports button and the new settings will be updated. ![updateReport](../docs/Images/updateReport.png) @@ -296,7 +296,8 @@ This endpoint is used to update the report. Let's say a user has already saved t ![apiUpload](../docs/Images/image2022-10-10_13-32-5.png) -In this endpoint, it is automatically inserted the information from the user that is accessing the tool, and it needs a manually inserted name and also an CSV file that can be retrieved in the download template in the tool. After this it is created a new registry with the information inside of the inserted CSV file onto the database. As parameters it requires the rating name, year, and type (Global, Company or Custom). +This endpoint automatically inserts the information from the current user. The uploaded file needs to be in the format of the template which may be downloaded, with the file name being manually set. After upload, the data in the file is available to be utilised by the user in the application. Required parameters are rating name, rating year, and type (Global, Company or Custom). + Example: ![csvselector](../docs/Images/SaveRating.png) @@ -305,7 +306,8 @@ Example: ![shareReport](../docs/Images/shareReport.png) -This endpoint is used to share the report. Let's say a user has already saved their report; when sharing it, they can share it with users from their company who have already used the Dashboard and are available to receive the shared report. +This endpoint is used to share the ratings report. +When a user has already saved their report and would like to share it, the user can share the report with other users from their company who have the required permissions to the Country Risk Dashboard. ![shareReportIcon](../docs/Images/shareReportIcon.png) @@ -345,9 +347,9 @@ This endpoint is used for retrieving an the current user ranges. The values retr ![template](../docs/Images/getUsersFromCompany.png) -In this endpoint, we can consult the users of our company. -Our company is automatically extracted from the authentication token, thus avoiding filters. -It is used when we intend to share a report for example. +This endpoint allows the retrieval of users from the user's company. +The company is automatically extracted from the authentication token, thus avoiding filters. +It is used when a report is to be shared for example. ![companyUsersResponse.png](../docs/Images/companyUsersResponse.png) diff --git a/docs/Images/reportUpdate.png b/docs/Images/reportUpdate.png index 7df98f63f03e0326e75ed9abd5c3ad1d1e259acf..a9bf3d733aa0acecf3ee9067abb4829771355772 100644 GIT binary patch literal 4673 zcmY*d2Ut@{*M`-lh=76(X^UcTsY;9VB1#7V5f!8eic$?ouhJB$0um_+D$*gL7Xt}R zij*KF0Rjm%k(Ll4v=I0Z-GBd`=ec+8%$%8f=FFM%yzhy7KFtRev$wgfHWRF0VBw%~)LF||i;1ZsiDTE{&x1DmGrfD>OiVn_ ze?H9k$HM+hOeZn=I$F2=ZC55e-K?-7ogk>B{)mrtU8nVs$GH5Xl?#?LT5DaFm%ywi z4GK?pn@8n@Yj&BxEa}2ap5XDA&o~}m8XmcrOoj6a2?~9=ped!~*xUd941cfwvySDy z3|*J&=D^*n!G0(b-kZ{}=|`scIfiz0G$yT^F9-FjZBBTjlU^mkxh05Pu(SqX&QCpm z7FDi;HqO&CC8J`^Yqo>)9*6|CnkV<^{~Bg$cGQ%cZg_(=zFVqAJ!W_DpY9*|S`|n$ zBfaClJCa1!Zcg%a)mMnSglbtVkX=r}9b@|k>XzhQiw8eBfAaX)Co!$>7A!#qAA0yA+a(?e7(tZoha8%WQICDY>_7&i;Bf`Ry( z>@egecP#c&XxzJS|4_2vPWu0eYCgT?MgU-DTrGxmh4&D{Hw`7ma8v5$wT^^Y}6u)BXqyv^D{$@XARra<+N_TGY6N)i-Mf{?g`{0j<*j8BC4bIp$G&)$l zj+pTn>r>rPOebkFbIV#C?n_cO3;cvSLfY=cM}pXFhS8=%Ya8=}Hr^n-D72R&wnpaz zc{O*>k)s9yu%oj-YZolzp|*CWvNckN_rkI6F!Fn8CEJ=wJuQhIKx--?>N^-;i` z4WsRzb=-J+@p@Fdl6Xw}7h;{b&|jiZ<;JlI-Jxmm==L|6`RWFL_e30mse{-TkiK=NSp2)8T6p0UHJB2U!wOd>|HU_hS9n)pcSzCeDp`3g@gud~M+EsF)^v}xcszYQK7teo z)^Ne;XxWC;9p`+0!+p^y_EeWa{>HfU0E!;MpDp^!Zb_qK*t8g)gV zzcocE5^U^PFv`5CI{9+wtw9wfLv!Z%K7uin`c79n;lQ&T;c=_9pSNzo9SCyO^JqF*9blwA6U*R_41j~7 zYZ=P?g-#>nl#{%nWAkbdvHySRNn(c zE3H|piuT*Im3zL&F^v!9ANYA*+clJbaH?3|#bZtuELK4@arCOyM{yD7HJ>LOc=VVcONxSu7nvZ37k$SG%k$(m#Zk*r zbHRW|wJ51l!hn?3a#qVDqLQce8#FHu)@_j;uAm0Ej%ynj%=Rl1%Ptt%!O;9iO;3G& z8&u*&9910B^=(96y*JIRXq!w!u(r~Y1q}!CWQ4G!@DukLQ2>|&{zKCh3q{E?wA=V&~cGlXBir!1Ba zyQNo};_T+H9`-BJrN$t`wrUFIfvBw;e8C9#C)=c_kXq1@hmZF6iodAY#>y~Bw;smv zOVwhaW|sEFt8B5(i3+UVwqk+|6aU8x@LGg5Yx|&xx$*#2Fz)uTSUAnV@RnWbvA#4E zIwiS&#{Wp_f;)3Be7B&sbJeCNN~@(JC3%#yV8Zc8C3c+vxbE=^+_eA4Y|RU+h3rpD z77h>as-%86DyK1d)IC+1i16s1_|sLo#{JbrIa^B84TB?7QSLeCQ7nkSrjeGliv7De zf>~C|1HECG7N3t(wX^YMn-FId;Ylmw(}Q$MVB+hgy24dukH1{rIX{65hMbuo%?yL1 z^2rTFp_POJco}00T4CC)uyS?t<%z(uMqvXT^h6Wo6M8k&5aTzUJUZRLb!aROhZ)96 z-ao>oIZV4Va%df$G*`8JpYaYg-Ld03hP5yOJ0_bbxD1$>Y52r+CLZW^PN16pmr^Jt z_q)`b^>zLC0zqloGjU$kBJaE>b4S*0&gdax>}Z1lfZ!gljUW08>q!0VqnG5`)Ev%P z4T(F84Kkv&%x;0%14<{{WjqoM_5mvvojfsPp9yeA4MWteSRP+J)^o(G`cc`!Y(qZs zi3Twss(oly7W7eS!nSqU&$TlvG}XUQtr3&?gd^g@tkl`G%$>T{9R-}JuBR7w4=Bhq zBcMNrFsH1j303|k!fAHmDXGp$65HSX&DcTnGtGb1rhn!2hOqhxFWq%C-U_mb$m(TIcGtl1Y#uuc~AXxQ&ZL>?WXq$f?-={YSy?njMuyGG{KPD z!AgOt^*VXZ5Y@=xtaj&*D>r8tNfJ@0t2htq1(H}BDm0FR)G27Hc&aw%PaMF)QytxX z-T*s|B|!3tU69Zl7=pqiHzfI2dpDhM|p#SEd5WsQ@}BPSK>YPv)M${GT|(@lud{5+lLZ)B2yYUCS1v#!k3NqIl2`omaEvg(Dywlc~+KOmNs zZeS=RN7Ci=K$dA*=D1(@ zoAd*~p?+ND0QIH|Z+!i5Cgi4KdxeNTWLT%=&PrV0V1U~-Jh0xTe4gbowf1a*7yf&; zQ0g1CtX#V)cq+|0v1^3a;W97l_2|y5!h20-wPYnJi%YXU5ydG72zDJcc$u@Lt?r4B zDjHb*^@H5PttT@&FRMq(L|vBhK2#XSOstm7_@}Ox*i6ZL!>ltuRtzI24nWs>^ovit zPb{+u2Tr3US$XJf%XX(3OPAoIh)L3y+D<;cgh#|wPt*hq3vl_ry_ zVfY|Dp19I1{j@h8djP+jEvzLzksL5?))jYLazEda^;2Aq!*=$8_{Ps9O6|40LQXdo zSYkTSvOGy&Vi3Lw^c>n`PfK>EBl~#cu%ud%;*IMwQ^_*!XLM zwdrYXnJck#uXb?=Tiu799|G>uIQ~{?X^27e!rS0ud>$cJG@zP3>dX9vN;umoX3M9c zaYr#drqpMC+ajWejM2U!(^F41h=FqQUriGTsKW8HA*%Zjlt%Y{>LCI;;2pO4mAuQ& zghIDN()6*Imj~xAb3ZX5aEWSPtbmGYNAAqW|KbYa^Damcs`fXV)a3ftmAsAR#p{5p zLhJ`3frp+KuFEY#l?DGx6HoHUc>haY&;EB%Y9V@ojjQ@Diy~$E$~0t;xLI!sM$81%tBfu}oPG-rg!|Jsd{bLo z&Xi=7!YAAE$MV@@DFlYmO#}=mQL`ty7{*xF0$pe3U zo(K&}Egh&H#r_s#D&Ktve5Gp(^gM}3Kyz_jfn{s-UHTT1`{ literal 5774 zcmZu#3p~^P_vh(CE}=s1T@fL=?2%hYVs1sb-zv?0v9d8kB2SN7(p+K|a?d5k!ccjd z`zDuUX2@l3+hner@z+!7dA)xB&+E1Cc0Ql;Ip1^6&gY!-c|WnTFc##K*0+JV(1sacQQNSV0EO%}Z{=!4_s!WF4u6ihZSYeC?V=k+ zH)U-+cPT!TJI%ZA&>?#V_fwIod`89gc@|=EIG|#Z{U2#3{>+#6B?~?wpY*Xy7W{V6 zvHW0It53n+UA23qwnmNDf(RShXCYIR^f~q;A4-Y~UzR3hs#BB7dcQu=S(<@DiEgX- zbM!-~1R2L+V}u<4uPLsG*>BBS47nYet2lOH{|*Ja)HmFSaNMD}Y+O#`9PR9$uCE8D zXJqW!S+L?(LR)L1a$;Z)u>Ql(($gi>Pumv#JuhlYRg;aKB@iTu5%vvEz^J!3X*&+nbjN3LQyd|ghe3J?e+3i^9bf8j7RCM(Hj zplq<5a02&RtKw$`iw<=jR$>TFD~M!q4x;zu9@! zyJy*p*&AahKKiYP2Z|qZ3H{pa=4G93MOh#W27vY_Te*AlWVy%vTH~rXS7@df4r?jV zkUL`8g6G*;0LHXO@kK%Nh4=N}l03dMZS#3!;I_u%pw~<=)m(GsGq+~g(#ueF7)jS( z37yjZh?n90m)CFcR+_b2?CUFxVHG%O^Y~O3AWW&(R#l=LXgH}K1wH@Ixhp%83p2}_ zWy0*R(AAPfLN;K2E2O1QRlE0rSE2S_3uTYf@Vq;$$bj`8hT+lS(vsYjfaQ^`5Ozek zzxUVBdD1x>*~>6nL$lkve=$e2uWihiZ$!}N${Tr68PYN&eZ{WbW0s%MceWI%{eX17Cbbh9(X-jmau4LDsA75Xd`{xnEJqxjs#59dk`;j&;TY z)DDlUx~xwjMdhw4=4_V7XFL1}AUx(3bx(mWg!*(W^wgeJhfP!T7)}*9$YYdj3Yo*8;P-;WMGj1Vc#yl6AzQba=aT62fuEtewNdKE%x^>-yJW!zXm8f>d1XwMgRlsPau6HR&Xi=Gr@- zrCUSIGZElsr%L3@&A`Kgi( z-Ocval-Gy{+0y3$nQ8^Mf+!w-;Gz#N&PBpSC`LCRSu>{RfX#xbdoH)4}zWbCh%(gh-$AP(Yk?ERf($T~ziQ62@ z{1$q%I7?pCg&3mIm|F&Xk|34pz@yo_V+J!YA z>Wk=W!Qlg$Qh3oSrs}JAoZ{AVS3bV2AnxOt#Wu-}tf$l~id)Ph{pJR)KB}K?+!#FH zv()1v@%B}!;2%jf)}PO#R4U!0t2&CuYP)(qiEoCTT@E>0uj<_X@e_`A15Y$%By?4N zZrECU+~3nZN%jQ5T_D9cH9iN$V6tP0xk~N5eIO+3w3x5M=D9% zUtcfE@L)qYE~KjKtm6~vqlTvpl%+8LV4$H!1*l}?GfQ;N1Na(zFtW65HLw4^lgSOR z2qGmgD-We*v}|8YbQIBuh7!^+C_elZ^)6=jS%>hB5P^r5ujMwFB+$EjtXe4JT(|=B zvH6>)9U}gYufpejUf(WQ8jzO4cOKvj$Kg}8W`D}ocP?`bn2#vP<_D!HV# z_l0rDh~(@kf2SX3(aJ)BqH{V?Z&P7$AbdGhKrPcms?{_ae_IP$D^hMw4*Lmtftp!g|@bsD%eyO@wsb1Ca64tSQ>t}b_rpR+gH z>UNH$OSmqj+>{e*e1|MVI`Ba&yd~$shM$Tj&>38#+o3`1A)q=DDJO980#)l#w*L6CrvOo|q?dF0GFtP#GbZk1k+Jf@ zIc2cw6_y?;-%cub{MIN%+0*h2gFnG}>eo>{3FD@?Zmgp{HXHxE;o@9SX1ko$ekgW< zplA*Qs4zK}B9y!{{SAXIWT(cJmvK^r5gOyEA3UKWn)&|gW?xMGt831;y=cn`Jp6g4 z<16EYvW#!ZJvHq*o6V}}i?jWI@;9a&ip^agf?Fh%J(zQ-b`FUl*G#@1pUWK2wmPv~ zRpfko4iz$oZhRF=j3^hT)8J)L< z6MZl2vWMKbNOjk4y_QK0YA&<$eD!vDjmYRbsCrN+I;SayJ`R~}9|&)APaX@7qb2sa z^ENzdzdW~3&kz&toTRR<2jzal&R~erGrr=#cc|L~nH!1q=tyZphp~r>niMRM)|34Y z^7hjYebCA^7#lXK?O$}*XtmVa@y2zs7_oGMxA$6AWU9r$GGlenmfoev|pKui${={VlNvRXTl-DQ<`srTF zzQ4&A=UHFT4HNGaGzd?QUc;zx*JqBsZ9(snPnyeAKes{aMgzksuQW_Jl6?J{pugi0 zOAf1&{S>>R4YLSNYpy>_H$ZGx;_33g;?ivDonL(B841tZCw8Se;z(Vg zuUcm@WNHs2JiE60t7rC#JVn9N@%~Z3aFxA0E7IAtj3p|CLOEnJxPh}g)>1vIgA+qZ zPfuFfGhieT{~w2&|7a}xYqMH36ErzfRY~A+{QHP0|Iq{MOx**rYZpw7r|Shk zRuZcEAT6mm#OHlz?6EII5!6B1g7U~3Oe-rJx^39WLLMIWfEy))hK7j8!aWUlu z?8`(yvfIL%a{-H6!Lh0>ThW9l1X1N@bw_zzdv zJmUK*3!hildJe}zn%;CK?Sj*olLG(7R-8L2tR&9SslkG|sX(f=+)EyxrMmMo@ORwm zncnqCEw&(4W*n6vF!E81ciTtNQ>{6RzTjBLu;e8dz6AKj$6j1)?kSQFueh}S&{8yc zi8$3R*yaYR_jMdP+(@^l^@ly-xOp40bos@;2xgnQ`V_vtm@+wdo#%`Mdmw4MJQon# zb>-R*QwEpqnY3{ly+qw`1esP%Swf^d$jZyoYCMFPGFc8*Hn=YA0U?QFy4H2XC^PQK z9L5?m<`1-8#T~_i>|q&fYg(TB{tR+sqBIm=@ow$plKr$pgC#~|%m?*7j(Vzf!ITLv z(Cfsm|3r}kC4{L*<6?X=mP77hlMJaV)mxWkgC|7Tp_-4hqPKINPuj{0@^U+s-S!{` zI`1{0*0$h}>EP_Ii4R-~7o;M|CgItL$&MC}jTcY?h6^n%EWq%+pHS|Z>P~yx;&S)~ zm8p`D?*-mcg(ihJNXzsjSlSWC8gF%j!TF%GZ!es9MAQG$yHPX7{wOAL`6H`SDCZdQ zu2ROg?=G@u4J6+sKVywuPxXZ~fl3Q?mD!=ZF3u8q)Sg+txwDx<>SUiqgx3T1kwam3 zi?L?R&SyF};3ts$6EybLpB!oaiRX4#ClgFwjm%RCQe3qNI#PXasQ+-V!7+&EL?5br z>p-(SG}LfFem5u|6i4Z8OdJ60)3;L`1$x5`qzrD|J}6S(wCuEGjm!x1k)K$&-UW?Z*h(<*_DdPu{T&O>S*m+>(QeYMYIdaD+Ds%Wro*=SD#NX@yG@v4uR0H5-3#X2omqxvdKCR~b}z_Y7yL1R zBqJDUrtf@4K1}frZ&7BGyT05S=b6IB;uhU&;G_%(()tUddK{&@jk4&C%|-0M*{E3>>PT$oxA+CunFK zO5KaD{WUTEfTXK!Vb}I$Cd+g5U;}!2_5Dl}>`NXYV=6lLo-0)-1IPNXe3`Ai6z6j0 z?((C7M$dcHeN$1{vQSk#+ddQ-pRzR-=bQ%k4%E>8Sq5f`#(SBs0-3!S9_< z29bk#83#Hy=1nAgs^-l}DxfLX0`{PFV2jmF+j&lV*SRZRg^b$DN6)HxJjnNS@8q~9 zG-5tEce<)2Jx2knAsBAWF}IkcK{e8sByOLC2BwBAEB!#J0*Un=zTb?d zr@y_VsMmH^**au=2Ik6rII)_pvFw$KIbZs%S+rgdZh`N(3#&2XHha9;b+?WRsD9_>t@|B8}IMIxP`$^i4?bB6XMJR*3KS7mluF z>U#sd5DOG7e2Dok+`y(gJ%|d=m2|js3CO@HAD z{f3t!Ox?0PjL|<)oJ*zGgN4VO1=Zt4e!OJ+nX>nns2!-s&CBZlWfSFPWbKbOF3c~u zJ-!1dMdTTJ7_2wfAB<1p+IQo2eDr_dnSaqAFbujHd;6R4z8l&24}bm!Wb6*u$UoP^ zS=&T_81KeKUm!utwWI*!dpj6W#Y9nP;XT+6&GmBrmwUJMj^NonCbMJ3!jaba_U{N> zwa>tRnTjQ6QnZ@Z9!>;mZsUW=7m-sE{6Esn_pOR@)pPVU@AUPJLNiOtjt?Iq`-*lc zeLDWnj&)p0mnH*`4+q`D-V2FwY6=?;^O&LyVe>3b274=Kg{0=QG_-e=;PSXXEur-t zcjTk{Q*d64x_SsTq0ijhe2_;$L1D5Tsa(^Ms`gvB;!(9&>)OnAs*Oc~OX>`*uBy4- z5$oU9*%^m0$O{4ZlYh&$+N+fKlNSI0P#N32TFV_98#u&odoHaPg<4GB{~J3;*w5%w x`@LC-$WPl?P!0J#bLoLFW# shareReport(@Valid @RequestBody ReportDTO return ResponseEntity.status(HttpStatus.NO_CONTENT).build(); } - @Operation(summary = "Update Reports that") + @Operation(summary = "Update Reports") @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "Reports updated with success"), @ApiResponse(responseCode = "401", description = "Authentication Required", content = @Content)}) @PutMapping("/dashboard/updateReports") From b9e4c075076a6afefe551b6790264c509509578c Mon Sep 17 00:00:00 2001 From: "fabio.d.mota" Date: Tue, 7 Nov 2023 22:23:02 +0000 Subject: [PATCH 2/2] fix(Workflow): Fix pointing to notice md --- .github/workflows/docker-hub-build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docker-hub-build.yml b/.github/workflows/docker-hub-build.yml index 1613580..2b25ab3 100644 --- a/.github/workflows/docker-hub-build.yml +++ b/.github/workflows/docker-hub-build.yml @@ -70,7 +70,7 @@ jobs: uses: peter-evans/dockerhub-description@v3 with: # readme-filepath defaults to toplevel README.md, Only necessary if you have a dedicated file with your 'Notice for docker images' - # readme-filepath: path/to/dedicated/notice-for-docker-image.md + readme-filepath: DOCKER_NOTICE.md username: ${{ secrets.DOCKER_HUB_USER }} password: ${{ secrets.DOCKER_HUB_TOKEN }} repository: ${{ env.IMAGE_NAMESPACE }}/${{ env.IMAGE_NAME }} \ No newline at end of file