From 2e68cab7316744f18d59173ef0710be3bea1f5db Mon Sep 17 00:00:00 2001 From: NamanChhabra <57210650+NamanChhabra@users.noreply.github.com> Date: Fri, 23 Aug 2024 12:29:02 +0530 Subject: [PATCH] documentation update and postman collection --- src/pages/apis/index.md | 2 +- .../document-generation-api/inlineimages.md | 9 +++++++++ .../stylingformattingtags.md | 8 ++++++++ .../document-generation-api/templatetags.md | 4 ++++ ...th External Storage Postman Collection.zip | Bin 29260 -> 36963 bytes src/pages/resources/openapi.json | 2 +- 6 files changed, 23 insertions(+), 2 deletions(-) diff --git a/src/pages/apis/index.md b/src/pages/apis/index.md index 1e5df79d7..a8336ab5b 100644 --- a/src/pages/apis/index.md +++ b/src/pages/apis/index.md @@ -1,5 +1,5 @@ --- title: Adobe PDF Services Open API spec description: The OpenAPI spec for Adobe PDF Services API endpoints, parameters, and responses. -openAPISpec: https://raw.githubusercontent.com/AdobeDocs/pdfservices-api-documentation/main/src/pages/resources/openapi.json +openAPISpec: https://raw.githubusercontent.com/AdobeDocs/pdfservices-api-documentation/docgen_doumentation_update/src/pages/resources/openapi.json --- diff --git a/src/pages/overview/document-generation-api/inlineimages.md b/src/pages/overview/document-generation-api/inlineimages.md index 2321ba288..0c6455dad 100644 --- a/src/pages/overview/document-generation-api/inlineimages.md +++ b/src/pages/overview/document-generation-api/inlineimages.md @@ -9,6 +9,8 @@ Add inline images in the document through json data using the tag. Image url can be provided in the input json data using html img tag. +Image data can be provided either in the form of the base64 encoded string or in the form of publicly accessible URLs. + JSON representation of the input data: ```json @@ -16,6 +18,13 @@ JSON representation of the input data: "ContentBlock": "sample image - " } ``` +

OR

+ +```json +{ + "ContentBlock": "sample image - " +} +``` ![Representation of sample json data](../images/inlineImageJson.png) In the above example, the tag ContentBlock contains an html tag. This image will be downloaded and placed in the final document as shown below. diff --git a/src/pages/overview/document-generation-api/stylingformattingtags.md b/src/pages/overview/document-generation-api/stylingformattingtags.md index 5032a019d..143f64ade 100644 --- a/src/pages/overview/document-generation-api/stylingformattingtags.md +++ b/src/pages/overview/document-generation-api/stylingformattingtags.md @@ -13,6 +13,8 @@ Apply styling and formatting in the generated output document using the HTML bas - Underline text. +- Set height and width of an image. + - Create [Hyperlinks](../document-generation-api/hyperlink.md). - Create [Inline Images](../document-generation-api/inlineimages.md). @@ -51,6 +53,12 @@ Styling for the text tag can be provided using the json data through the HTML ba - Any HTML tags which are not supported will be ignored. +Formatting for image can be provided using the attributes of the img tag. + +- The img tag supports the height and width attributes. + +- Any other unsupported attributes inside the img tag will be ignored. + ## Inline styling attributes supported - font-size : Xpt or Ypx ; X=dynamic positive integer 1–1638 pt, 1pt = 1/72 inch; Y=dynamic positive integer 1–2184 px, 1px = 1/96 inch ( point (pt) and pixels (px) are the only supported unit for font size.) diff --git a/src/pages/overview/document-generation-api/templatetags.md b/src/pages/overview/document-generation-api/templatetags.md index c3be60e30..6202b6155 100644 --- a/src/pages/overview/document-generation-api/templatetags.md +++ b/src/pages/overview/document-generation-api/templatetags.md @@ -384,6 +384,10 @@ Dynamically generate a numbered or bullet list by placing it inside a repeating ![Template tag items are replaced by numbered or bullet list](../images/simple_lists.png) + + +Only JSON keys should be placed inside a repeating section. + ## Numerical Calculations Performing numerical calculations on the input data. diff --git a/src/pages/resources/Platform PDF Services with External Storage Postman Collection.zip b/src/pages/resources/Platform PDF Services with External Storage Postman Collection.zip index de02dda862ffb99923e2103b9a8b13716c75a1f0..cf79fd3b5d024994a378d90024ff0732eee80c87 100644 GIT binary patch delta 11735 zcmdUV1yodRyY>t-lyo-?(uk6h3eqv8beEKLBPavX0tyTw-6;(cill^63I@{BN+=>J zb!NuTR|Y-*`~7R3boGWyJ_`j41Z#sv zo;niaE;F+By z4nX^%>X4i&_l@^>|x?$t&VVkzu&+97e{#gM#1|R=u z@$iVjF4N?~8xg)LzDJV6g0*}i8nr?-K7*XSFV*U70Vt)+*$8J`pJSyn-f&y(~MxOnD{%_eWoU9D*vc(xH|pty8%Dfi1q`z0Yw>X%&p z3!l>!Kx$;Y@}YAM)Jh~9P0~Bdxe|`11Ggq%Pa0SIjs1LXj4lsKjEJ@c?tHHaN$ut9 zCgF^3SKwR4+xff}yMLY>s(&V^E4h(Hn#L?hYw3veY#Dx%4C{ezlQZiSMkqo1H-|Sz zy$%!GT+AP$H3KWm{du2KQA8C9;V+U4OR-(xnoMEi2g|Csy90Dk=3i z53>%$?pWKCbQ|pP!o;cwwjijk!g?pCqWnBeC*BsLk?)~6GbMXRk`~kg6lhrvmW+Mu zMzby#7_^_3CTG?%>~JaINWACVo9esJ2)6U=_E^b4IMZid%tX7yLKz2L=KPSFt66+_ zUt<6}qLFrFZ=hWXHS4Zr!W_kh-fW<12#iRKmUJAfIz~5ibZ6v!q0_ct(XOK^aY*Y` z-JGYaoEV=pv-&3^hTexqB?W;j9%{a$NFA~;rX-aYdKIXx0NGwR%X!C)y(N+|7Yj;1J<ReQVXaxv-b`-iHTxVMN2G){D zs{pO8rfi^aEL>tPot7mq`I3e)p-E|JSu;W0GFpleB8o#1F^Fk(nK4v=h>B}pi>IEt z)vQ}SZg%Tk+jA4^Uuuh%jyfUo zz@$FMs9Gw9ADqbL0={XAK%4-;WwA@qh<*<{0R)tSlhA0vC-GGOX(SK%JCcXLz%N46 zCx9U9N8k!Y1uiEN#ebSk5`U)?THsnb5xBsda2HZ-m^;PGkTZlbHM_7&D)p4S45@&ZDdM;=p7WdkJ%Z*+hxs99T|kB}ek)EnN2rNN^|Z zkjVXuqgyREUT+0@&0+9ie`{#Ef}efnWgT53x$fgLk)f_%1!AzDe1t*r-t#B))sdeG zlgZIc#GfniZ#JPj6E@2fYRY6a6TaS28^0g#W^=xfogPmllqxg!QFQ3J4&9klH=YS% zGruJHzUMQ~lx$fz$hFDthS9ZdojXUae`b622w!b8&MHBowP-gKxI)%%@Vfi`edkhs zg))Ywq%Q{QlZU)KUeIlMW({`%Sx?%bjy%g3nw#KstCGc~LznBI)szke}J z{E+A7J^8~9(Ve|A|4MvCm&J?)`paFoW*@}9rB~e&6Lg&%0{MR}y%Ir#wVO(}lA|y@ z7+z}nbbd8}!mqwu;=LV{-(>R3zGZ@9sUjmo!8M)+N}epufPxP@7)>j?m!CJ`i0!;% zkTemyKKEUPU zmA&ITS;w#+iB~i|t|tZ}{pI|{YB+$C`?m@~LE5O-ve}G~?B_N{C$qCKcLw5+UAmxT zU}1-J5D?o99~bwwfV8+Rpc}?-5vGW+g4H{?P1KLM)rp5*!?sQ zL42L3f>xl*!;2u4XxkngdJc%ikplcATpWP>-CsFj2^jzo1b_fEo!~yCm&r8c6d>|W zHr8Gqt}YJN5N#VvCwMijAZ#D;%Kf}fzk2$HuH&M_fp=kH*+rCeOx5G`=P3n_or4JfGH0l!9;vB?EDkjKex0p7xUf`aO{S`DU<-i-8 z$1XnWpOmMMCLpmT#7D|)qkvnp@o8ueklOuAs#`-giH;lyi zxcl1UmkXnnkhl0RLqg+l{cjIX#1m5S6{<*=RK4YcBu4RFJcD~bw}Y9URVPfltc`8+ zjC0F}oMcS`*@P9yt#dFkm!|>8Vh#F{AomOIJcayk?T9TRM?`j`DtiCJDBpaA6cVwvpR=ap_ zn;CM04zD&IgC8?Y;(?Ns)b9ug;1L&gEcZo=Rh7?l*6kbWkrex<^_-QMf`O#7BbX;~ z=L{BOFOCwi9Z!pJH%^#3L{rcSdU@KVB?SZsKCh`)YStXw_y~20Y!iO7!M!%pyG2zU z2&|&S`udu7+GY&5(zm;d_{N>^FH(*Xr0;Wr3g;;!(x1{>72G7`aAS@Ge2Mbr>^OWe z74t5ZqIW*Vu%u-JhoYlQi4WExq$k?w;yMaeel^cK?sT|7Ydzjve>COTBgYRFa#r`N z5>^Xl#Ra9D8%ooE2-5&sujfGsVT&AT-L(5DHLh9-R|OV~Jd`i&KZmmTq}LHVPMHm= z)JTB|>wh_C$>A51^U^QgCWdCkNG>ouzwmY1a={fJlP>l$_En{*&zLY@k540ceLV-n z+6)DWG*gkvm^WBimx&#RR3gC^#LnRvO_C~p2_rjiBxSGFMa-~ukYo=Z?T&d3);Fdv zxwVNyMZ-nU;E)sy-oKzIVm=8C;H!$zui#&;ou09`Qe7Q-HEPwzk{OlrvJA6Hy*Lz4 zdHf}dt$1M{ty@-|)i^aQval7HClfMs)`IQQwaJ=?ms@BiM{likGtios8#!y9H`CJY zb7rmJOk|qoPPI%;nrnm))m@yoNLwD&I~ewzQs}-k5T~Z#-G21~Hs<#GiV$N{BgL%c z#GqSI$~XEJMfX+}LvVy2%ogF=W+opbXQaMw>1{|{=MvIj1I4>>z$T~k$V-H7#JGV3NJ`+7?} zyvq!sAL-y3uqCAJ;~?5^9mA@to*q^ zD2|!$t-Q)_xXSGPLRcZZ;WwJgvp{DEd7Y(VbC;5^JKVYpODQ|ZJJU9v4*0{U8Nbj$aO7BOM z{+i53O($14De=m(NT~QPAiY6Ja>#( zZs!I!9@v&*R>vB-;ulVs7LPC9>Dk)kglAV~8kCT?PZ2-(vX_F}C4Ep_8X{D4jAHLh z)|x6+OaP#S43*9zn=r_}%1Qc0rpwXD$nxJYH`!0tMvpeA)S2zyN}b{Ea`=HWN*k9oiJ6F7b@_{_}KcV?u9Txj`C!Q~q_frRd@JT;W+5hAG z#Qe9_CtO;B8lEJ453ic@ulf?vY2^ZAsv;`W9~-b#;*W}{0FnLRh+qBS3E(USsviu* z!YcXI4^Ho#O&FeilbG0v+RA}>b7bt?H^&>O!yrbK)zyt0a?Jkh?LuYX=9_m%~2l;$g2 zAwI2KKABk4ppdog`teZQjaJvKu5K*P@r+Arm-u}4baY2bUQgDQ=&6b%YkiBYF45y& zWX&hpQRZ`J5K0;0HP=%v34}FVYTQ%;p;58HQ23^{6&pQKCGN*zg(y&kz2XNot4PJCRrf zY5t7wC%Src`>q=eq<4|xP>9{oxJfPN`6?`lZwRbM^V>dfrsWMGdwk(B&n9)6HUytqlDgF{hX*s&Ex0$L4QyN}Nw%0!f*nr* zgb52v@SAHc9qUD?4C|6fInP z{9cLq&UwLevt0tqwyzmB17NZ2hrY@Qp!rg@$4b{ZuF6>meo%akA28W81^ej5y>*;d5Bi}rnRGn9`4!@f zQRR09HjB$Cb`Q$kD|{l-*F~S$Wxgs`(t0npG;;L!G}%TCha35#to zl~F&33BF!n6gTbi)H@^8#T525vFp3Qr-^M2rT}w|?oY!2x`7oI>34ygq~V#R{%rRa z$c9wTPWXqu+eaBkyp*Zt7CSwlSi#+$inS+cF@^Y;7WPvN!>0eDM8 zQ7mEcOevXNwGbzI>Rpj;D1XeJfhbpWO?N*ao>u~$h+@nrhk10{sT@`8c^R!K;I>ZzY z1AXWcLY!X_$V5way-dcn$5CY%xz0zJF&aiD;|ts#)_ky*A}AC2x&+q3&YMhrwD8C< zAXj?f0bvu9|MAF+Y&T3hnE_jojO{r3(&0LYXu;q!tMRq1sK>5~I7V0=i|Tjia#f8q z(p4Wc4Z~e>W}j`m7jEaNFlf4V?Lh~>-Nij@WJ{QNa_+@NL`xXSIDh6MDKLVjexx)i zj+e=Pk`a17`@cAqqkAS|JQEJfx_o(u1B>fSm5CWNMv9uBhWcP&|4?G^(qofiR|^YE zduLl)OP5Srhihx;T8UX{*9VXaV&jOd;2J(fkgpW{f=mNm#)(j~E@KVE^hGF}h{|;e zpVe@9;?%Tg_;B4>~$eF9!>ZEcc`JcbfqICIG8Etf(XAD_E{z^0&UUf$p~96{n`XeDl{B%?dO>MQM$LQCk*OgTm|e)c@qC|IIC{X)hr{aIN># zMW8=w%fkL=x9n1|n*?ghqNPq9CuS9|2mk;d00hxcwe+%e^?(PEiehTJIXV0owqqjt zs91;#`F$#tLJZsCW5WL$wqH9VjFQBG-eE%Yn6D4H|zY-qq?`{c_>>7|X_ zfFT$Sep2&bsfF0bwmvH2&47?TiyOgXy?kA`oY4-HiWAL&`)T{&ZpLtUcx>=Bj{< zjZm6@>yFhc*wzNA*!dwnT@R)FgXlN9_w{ICt)S0@ApmM?!5ZLPMVJL1R|9g^J{Rd; za&|zJ&qc>uTBx@X6ESPYmUbuy1C?ofxvEqVv-apTHnZws8^o-=a9#hQb;bjAs8RnA zDIX@c)I^qwex{a@TY;`GGe}42R)JU>ds-h%lHt+lliL>&z`o zRu!eQ-HNYlX;ASedqOm^R7|cFq3eiQyR}xf zYhzBZcUhzIevMXEihJa?;#uZ=44?<8V*^cn(fzppT@%k`#s_*I;aJMF5(X2Z${p5@{$*%nC{Z}>wS^HjUQN_W)f^+=B&5D?qP9;xTu2GZjbj~n`M=H#TcC4Y7 z3ZAeFQUwoXZZAD|y5mC?V&j_W0}diV-_^$$3@r6;2V*G%)Z>Ns-)v;(5>&Rj3RHRV~?d|4@0v^l-XLI3ThYA zH+7`sKX@E;NNb*^FZbg0##o)D#?a7EAwdU?Pp0JBvsy_{8z$oR;VZ34a<$BivpYnD zwtbUhiYj@tuQ!Vcffohq*)OrZS6sF=o$nWo9j2&>5}lPmrUcJkxea~>0RTwq_>}{l zBo$mp?!G!7NyC zptTy@6brq7g?tcsQsCqv0zb3|v#^mX{_)@d@&LiV_!cDr66n|A0K}04G@ufExVxF^ zAAwG53NvEF7$HDu`oT!`H%(1WX&QyL4mK%ro!`zMAT4;-gb^c(428=@p!gfE;3?ct zG~9M7lm(qh&{GVg1(9P(^AiJ0CA0@6X;3TDpO{jf7`CG-tw$`^V(*m*ce<5Ua}*{bBz2R~H-E%|7WzB;ZLuMx#mN$bz)*|5s}qY5NT` zMvNR*ge)>}9dqb!wpTx8dvu?2aG`w4ZGnEKB-la#ql6n}-3nUCQ<&8BC*OtuG#!R7 zpzvBPCDBqVq@46tj2H@hC`<@M{uCxTMEI1Px6yDDg%Eor{x{5OYeozrVFYH>Z+N<= z@WRmWq{LBjp6<{hR*vSxDS8H%5$QYZNY@miliS zM+|{`GSNpT6&nW>?&(?w>0o5YJ{ioBb->S0elWxlx#Axp_=#cw${||`(@UO$zm{>>wI1xV@OaQ=<8}hIJ0)DU{C;$Ke delta 5744 zcmd6rc|2768^>p1h|DG12*ZeEscc26!7z+W_BGkEE3Oh*%2>uyh@478LaBSZxr7^D z-HMbbw2;zbr<7X=McdqS&O~#@@AvQT=gjNOKj)nH`8?0}`98}TD#o-8qw%&@SUw39 zbWBAIyB@VEJ`4VXV8qlHmuz8N$M1>eNESr8=%-wZzm{=GyUJK-ok|A?}GYQT@j zfQNEQfVHxQzW*t&*kQYOYRz?$i8Vc)!zV)ng0AJ343^aP1%7EXEy7#kB>oZ~!lP`h z1O&GYHWY@zSb&5h0L|zu;Q-GCX0;dQITkGdR2tg>-Vx@)Jg;L+Iw|5l$UKut#~dY* zOhlzzo23--<_?W~lApZ2`)%$&=(5sW(_-1xx}APMv4xG^6^6svF?X8S#k+-g?(*EH zj@7s&|D>zq=k})X()F}XZXTdQ* zzeq7cZU#OVl1p4sxa6eXlNJGr#E&B68b}mj`5}v#Ktk|#K#gFr)MT$ftxD2y0sRgi zd;}DV2KZ=EfC3pj;}3N~f9T|jm-*0rcWN`fQA^Y;FiY48HB z>7iAirI4KqL5A=^G8vfM;W@sgxB>o|QCiLpcm6HY8vTQki@v zEJ-boQ3xy`D4gD4umMCx180=W5Fz2DG73d7S#9Y>@QZaKK)rejLavPlixa_da0DB! zCoi=K25hug2+31gwH(Pwu;j0L)FmgGu<VB!kkN%Kac5#iVOA`enD|+IJm>?@;T5>cqtbyJBAUA%_v2=2D zvUNp;{cGw@s;i&aWsQCziJsYdXWK)U^eoPGF%<y+dlG$u2S2Q4=W^zQ8K?_cE=kymx7D6Xq3UyGknK~K4tdzr7r=MihFwv#0c ztW8WSrk9-7h*G)rAd=*!bgOZETT_lutl*`y`euz8Q9W22vR(M! zMr}4M$Yh^tSFQMPt>j@_O&PVfXNZz)o4_6oFeG|p27d8iJY)ajd8@**)=s*~$jxu% zhNSD!`Z8Is^P~e~$PM{T7aHw-&yoMuJpH2TndVU4o_yB^XS$~(K_kXh?@`3y$Mi1u z0acNw`5Hz?I||%={hyt0-$A<9Y;RCw6#u60fc1rzz310E?FqPD7qtBiLrc{&BUy#t zeP}0tx1YDwxwkP4%eOD03y2TSo{8yBnTd~&C9~M%?-A?o(=I%=|EHbqb|YobP0FH1 zqp7MdxduD1%MPZ zbG0_mj&)O$<&F=|`8+K=`g^-Gfv`%Wvg5>&OwHm(>&!;Is|;(B^1YEw$I35W4E^dH z_gT;Tqkr#O`4-9dlM^)$XVKC!E?XY;)ftxu-Sc!%HP|s^d!&7BxY}bGn~HaFw79%Z zAtRdni5qb}cb6ac&-sRFX>2lGS1)wqg894G0#SoO%Leb%j*Xmg*FIO>_h-gX9!AcePWzk790Ogx-K_Lg%HQ$nRkh1(nDFJU#kt6K}Vgj-%= z4M#gNPu8l2Nb4(fv#buhBjb0-^tD%9%_x(v)V-))?@)L!cFqNAM!Nh>QZ8aqs1lL? zw)LSFHHp*pn3&oChl9<4`)OOn=kowh^Yee73RsSp5Q*K!$rlZ`*~j7X8F|=c$tCt+ z*FuD3F*hcs7N!2E_?AmfvVbSD+Lw8D&yR{%Gnd||IOTg*_&C>OTkQ7&YEBLY7yWNM zo8^=J&7Gg$tvRMuXEpopQ`K+vwcq>sc~9t%e;PNK8rFda13jm+gM?#X4d%?bXp98* z=l22tzjxQdUt0F@CEc<6%y*D!yc>sIdl3Em2<+egGCp@D{Y3Xrpp${lwQiKGG+ zeeQ8P8Ql5vM`_|TKMJVSqXU^ZWZw*dcSaI1Q~?ld0$h)zF9Pr60Ut(yBZVQb74Yi{ zI$}j2FguEfXj6jO$PIf$htCFo#$RAAFXH(DTIqy&O2H!KAKI|le1v<5;Fk>5+8NO_n@#0;y0 z$TS3wbBPb34;j}t*K-WUm@JACATXJTS)mPkvL%_u3np3ccoL~~?FJ5*cbZM?M_a@yEoBBqE6 zJMD(+;?=O{0jDCsH!SC!hODR%I6VVgW-C~+yXWF8W5xqU#!r$B2h3ahAh1Ff5z}c4 zgA=l>xyul|%$q B5UKzG diff --git a/src/pages/resources/openapi.json b/src/pages/resources/openapi.json index 2d1ebc2cd..afe2213a5 100644 --- a/src/pages/resources/openapi.json +++ b/src/pages/resources/openapi.json @@ -2,7 +2,7 @@ "openapi": "3.0.1", "info": { "title": "PDF Services API", - "description": "

", + "description": "

", "version": "" }, "servers": [