From 9c4a43146126ccfc0fd40f568056fcc058e10b62 Mon Sep 17 00:00:00 2001 From: NamanChhabra <57210650+NamanChhabra@users.noreply.github.com> Date: Wed, 21 Aug 2024 13:44:40 +0530 Subject: [PATCH 1/4] documentation change --- src/pages/apis/index.md | 2 +- .../document-generation-api/inlineimages.md | 11 ++++++++++- .../stylingformattingtags.md | 6 ++++++ .../document-generation-api/templatetags.md | 4 ++++ ...th External Storage Postman Collection.zip | Bin 29260 -> 34050 bytes src/pages/resources/openapi.json | 2 +- 6 files changed, 22 insertions(+), 3 deletions(-) diff --git a/src/pages/apis/index.md b/src/pages/apis/index.md index f21695d07..c8fe61902 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/develop/src/pages/resources/openapi.json +openAPISpec: https://raw.githubusercontent.com/AdobeDocs/pdfservices-api-documentation/docgen_documentation_changes/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..f9c6862b0 100644 --- a/src/pages/overview/document-generation-api/inlineimages.md +++ b/src/pages/overview/document-generation-api/inlineimages.md @@ -7,7 +7,9 @@ Add inline images in the document through json data using the tag. ## How It Works -Image url can be provided in the input json data using html img 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: @@ -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/legacy-documentation/document-generation-api/stylingformattingtags.md b/src/pages/overview/legacy-documentation/document-generation-api/stylingformattingtags.md index 5bb3f9629..dd0abc69c 100644 --- a/src/pages/overview/legacy-documentation/document-generation-api/stylingformattingtags.md +++ b/src/pages/overview/legacy-documentation/document-generation-api/stylingformattingtags.md @@ -45,6 +45,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 ; x=dynamic positive integer, 1pt =1/72 inch ( point (pt) is the only supported unit for font size.) diff --git a/src/pages/overview/legacy-documentation/document-generation-api/templatetags.md b/src/pages/overview/legacy-documentation/document-generation-api/templatetags.md index fb65fd961..ea9aedf26 100644 --- a/src/pages/overview/legacy-documentation/document-generation-api/templatetags.md +++ b/src/pages/overview/legacy-documentation/document-generation-api/templatetags.md @@ -300,6 +300,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. + ## Conditionals 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..c72eeb106996e597a3d6a1a0b75c0ad1708416e7 100644 GIT binary patch delta 9129 zcmdT~c{r5q+nyPFvhNdPCX(!1D7&)n8f$h@_AR@Nv2PWIG}bW4nk7jklx!hQNw!Eu zkzQLQ;+vU%y_u=+cz@qt-`hAI$I;<=&igv=Yo7DEuJf+{EigJ6L}#o=M$QVrf4r?X z(&@~k&z&rE{c#0`&;o$u>p%d2aL@O9sR7jZdo2kM;eN3K)3e|#KOXVMJ^r7^Pz)A) zY4u8&Ns8W@@X|8!C_?TvO<0-Au&mTHXak(_lsVLI?8iV!x$}10rnNIVIuG7D(fO7;QJD+cG0+Z8 zP7@aF6W1Hi>(?`+=&d57p<&&8fbA^qyqD2`4^C+wuTWi8DmoYH;^ps}yVfu6BkT7` zlPY!p{+-!xJ3MC#Y{Z_+Nz_T)RF;))l#nxOlxYYW6zqFq(Bujrkg^v*=v3iI;e-E~ z1ox!%zmt$h4*-Oq{Fv3LG(yh%J3607Nz%z795f1C@fSWhB)J?mp9~n2XGC-%;(z#ha*tgzUYm4{)APih0*V@rGy~N=#Okt&-+SFmHD^L)8+#G8c zbslz;=AuF&g~9PyO(sUJ%8}2F>-LK(!Wp+-)G3$OIc5sWa71j3P92_HZG^0VtxnAy zftjxu=~~QLBf7T17=#)%HLUAA#S2@q4lwhF{dq|lnnh{48fYCxY-LVtNDoH1B)y$d z+p&fsRzUqLH~A^?>9#eiiNQ8~uu;MNo^NdPFFRcxn6k6Tko6<0ICd{TFdG*#D1A|R z#~9#Js_X=ru_7-PRaHh`OM#0WVQ6z~l~)@O%G}p^4AIit3JZPQUe=nP|0Lw1ZC{Ym zYO=jYw0wk4VBAW^HBQ!Rqv)!Ql6qPeQ6N=&U=cTK&eQ2zBK*m24!)-#YUV1BHX7oTGUg&Vs}-0yiee+z!t(e~!UlGznA*2>Y@rk)%vC^;kjN`gd* z+HRPHGCjg&*XQ28TEk{jj!SLUPb!Bq#}_U?+;RB&`m61gz%#v0wvIw)N|m=nxIOQW zCOWoM=U65*UA=cuB6D@fvv{uaGkaBPoYs8p(b-5=fvWub4QtF{wSt3Mneum3F1(&< zHqm5$43C&j_hzOu@p!f+r(4u6VO60ccwTulrs=Xp3Bq---#R-R22ZqlCU`w9;KImM zS)A2NEbmstH@Vi^V8bc;9r14=Su@=3UIyD9Sy5cxyy?iu>nnKOu_O%)jf zP~-9L^e9Bmf&|P2+^+pfXhw8>L6y9I{?O4D+ibTcqtf_ctY`J3#m@K-p*>$)Dvrr5 z+yZ20c3X~#$fdvh2uGe^j?FpI4f0D2R!1kKWbO*GTcpaxuViOdmP8^n`0e&HN29g* zL|~k`&o^TI-55QhycYy?B#W3_1ghrO>iI=4BdHOGQ{eXAtN{aY80D_U!UJzIfpWH^ zz|%(T{R#}nUeHE0p!G1O>%uW@ZR8Cri_{k|y}KxjtXW`4*(VF{b>&FLjRRk9P_;d| zr!rk`#A0SY3SOw32#n)OQ4g057NUczDACIp`YC5OS1Jvd4BwF}REn{6t}fkhyz?>R zT~DBmLxRpFErFZWuS~YUZ;>4~cRYfDl`aui?ca$Nhjk8Ou5a@MZsm82@LQba_D6<{ z2ICc!zKbfGo*V$cOUm!XW&$Tg1P$FQHY`8HhFDYiP`p4P0p~BS!V^n>HI~oqbV45<@`zKC7R2~Z_%9Gi4FEP|}=4pyLTn7OK+`1ByYeU*p(?KXKQMR0Es9_G=NGjE^|LD8Wd;DE08oIjCn|_piN*M& zCRD@I#reFykGGpM^puOEC#oJSjmWhqaK&H0DU*v9UOr>mj62+saZQERJmSDGez!m@ z%vVU5m9gw;zU~>(b^hDSr-M1v={MV^YJ|@Lj=f;hrlVrK+624vo|4nggWylH02u&6^2s;+S?Wy6qrR%zJ>Y#S{T3 zv#A&_n)+h+@S0;nLEXodZnLUa)rB19^XlqjHywE5VoNHZV>MGMH^s$kjo*pXCWml+ zK}38zkj*AJcOOAn7U*?Au=Lpy6Q)I)T$uW*sj*PRaKMo_2W>6_T})+Y5^pn|Ixiqx zN2&0Poi>QmxQyu<69TZvAiA>f;WTsC-Hk%iaJ0PPw(i6XSXzckKWd3;vAG{^yU$8r zo6W#CDzDYzi0P=_-c+qwcuNv{6c037kRoojXf=-|X?sY=H@h>YeOBC1 zGtBYG;V@L(F7*TY2BmCXjCOJ!nr;0`((pi;oW$De=Tcw&Y#0SKbN!ht?2*?TSRAMj zj{2=~Ps?wd=xqzm0@YGCx6^hQVWq^Cyo3Bb*3K_1oMG&yyK=VPK^{}x{zQz9A{Qc? zEODCE4AYTel+`bpIqT@3$kt>dR$udCDMiRLE@`%<TSjB` zkDR3XudE3#pDdzIG_8Qxi=b6w7qwo|Au19ND_hZ+>3%@Fo~^(JaO~@~%ILwu1~$CH z7r>V$azaL37R0L*WUCK+`^#c+?Lic;OqBtJmAJuc!4;cO^Ij$6d6^qBv?kncGnhCj zTA7{P<#2IpspBjWy@!^^-(IFT0=wD77o6S67A_6B0VCfkYF!HzDcfRoG?SL(eW(%$#dpK8j__LAnE3;EheEM}p&3QBI$G!+Mci(O;UvDwG zcZb?0p|e~6;ANk%*+;Y-XM0ReGKBoK)TJ7cjm2Dz!+t)u^5~8%C7JV=(RuoQkG62E zucRJ*cH9f%AT!hIe0yz9HP&=h^iyz2B15x$-RrBI+}WCtNU_AoyW_|pcyNA^Z*S1X zGgEP%L#7E~?>lxXhK8HI%vOk{M)iy%7#rMlmtM%f!(=1ha`wU3p?3L^vyTlVfH@=`&hNW`>eM z`JcJX8BZo4fIak4vf zohUy{0$09siX(8^Jfi*Qae6IOM#L#YSc80z_Yvv(uk$|s`8{HgB+k|lZru`H#M2UhbjqH7)bUpsS7fMXMnTXSpx-*dQ<;x_zP^Bj={=63|Posi}ld)#( z_dLZDIOTck{CS)h^oT{GUGL?0PTvjEd80p2B!-M@Y5kP)f7qRkNhagu6u~&(l+dxD zZkZeYE>Cyxrf+@TPt$iBIO8sJNW|C=NJ&}o)AY^joXNn>JkQMR%z(d(a=6Z=sQMrV ziR3L3lao9~b&vzZf18W*B$Gdd#->X}Xi{iz1#~k63PT>Wx6HB3ylRnw&h9flryxgn zrtia1U>Gzf>oq-M!QJg~sGU`A-l%}m>f_vju6FE#=iN<={WDNaXw!?W-FlWc2u(^# z#A@X3C21ouj`;(emYmkPXsfHah=E|(4zuPHuNMD5+T!)6|{Ih>+i2FGe zU#9~Af(TQw<9Syfe^fZLJjE$rPq*)$v6V`JEB^Y;Fg$F2+UJ=BYovFi#@lj(wFWx} z&%}fZRyfkZnill5!hf<+Rwn7!;$~1xTaT~?7FvBK3tk>Fce+D03ED0(Z$qht+#e1tqqTbA@-pPMOgKjdh74DJ; z)kr!yLcgub`FyiS+I)?oF{M2qm0x*cghvakob-)Y{4`5M!nle?#bJ{OA zF0dbM%+h%?y=3Mpp5V-qO{3?gKeS(hs@87%Y)eHMg+ZximVqFZM(KSA$g~x8@ex&s z{*cwd>`bb*`d4|^!bY?9b#k@zSHnUF+7URjxQ3Tt7OQ+-v9F4j-_}1L*N}0II`c$; z)LfyaGlzgRsDNxF&cAjjb?`=tdU4|5#i`f?MwX_la~k4F$?86Oq}a#oFd?LPEf@>Arwuk(!gTAr7A%FW0GT3~F`>;c8h~tx{ zw(>hJqE+UnT*dG2--`J#m%`vSmO+sc7*~;2`gNl0^@MA}Mb0aa8; z01Gp;@v4syR5bCak=%F)wVQk|q$gHXp6nE%oy52GT6p)qmsEzOz>G9QV9Gg;EP+-; z?pr{7ukL_a(W(w_P3XOSlG1kOVfPT!MJFHcJ9t>VYb|$OmaacK-fqHmVPWlKg!~1S zFXk_obsvq6yv*qtH93nZ=)4~$Fz@P=ly~lsa6LAb%39V$IRPxOk6p5Vn5(qnc&U`> zOTF%5yjz^>rWByc5}J@;M7hi$#yKm`tRNQaP17d=6Anj@fy8{PuNF7ASu`U)H%_v- zFgbdgx{qwAK?@GFKNW-4B#Wh#j+-Dhzo^RsO}q`m;~%B&H)Bq^zd78IGk)jz8*IXW zd|%W7>@9uR==QuMm7RAhH0;wXZcu1l28L~}CtNx`zMBhK25 zyfeZ7m}le-oxm{&dI;;THTeR1`D1_S-5_4_tkjLwDtQg~#g`Rtv!;;af$WWGiisRO z6f>m=f@3D9D{Ov?3;@6@!0)wT0yp^qkoc1JQxaHyNWyQ%Il2F8oFf=?KoBe0-zSZz zZVTtX&kXlS4GQVNN{>HX+;fg+Z|U^+t$Rbj-HLi|2?5muQBR%KP*Xt7y%idd1U(cj zWwH10ECwfgKRy^FA0-OtY=E+*B<`{B58}_(_8Q?KL=P5H;aB{v`%S`y0QA%0#`)$% zKmq$ves=o51tMjNu!ew&=m<=wt@VFlYD2;_iD;dtO!#$vG12imc+ds{I>kc3Jwm7T z3$8Q?ZY&XQ3I|~ay_kqQ1w8IuTL_4ni-60G^Mm&s#1b;Yhr``#;GQDFH3sA2bt0IH+w;@5A9X#OP?4%F@?uX%b?f>L*;F+)3K|tyU zaj~eQ;P!gIFgGOGQQ}PX2oN$Qh{4l>C_vnw ziISd4w3!+Pgy2XAEqrhi-sC6`FE9veh{M&$(EKGn{2fHl@kG$erUYoxc?S?H^mhA_y4b7g1{345-EyZ8ijGJ$_Drs!6c!?Bj@^An zh|1n5k?5wR=^`D}usdBSqM~xvTFRa^^E~G{f1P9IS@S&e%x`_>yT0#ly_c1i3*6>o zrQDowcv%emnuzBYNO>8Lhh;_lICdsUVzBs0ECz$DnOiG?k$~53L{5S}`Y{E?o}?eA ztO(DF_I*gVOIpm}C}Fwln+6NeO~gKkDH;C=#KQs^%^*!Nzl zgmJ|uirK&c3WX{yzp+zZm1ytLhL`&o5;Ex8eV6B?uieGq-C{a-r*_R^H^mYN?im48 zceZbI(59drx;VY|We<7xOD3Ann_AQ}caI!0D>vU&iL)mVI1}vI1IDffI7F&I&gM48V@S1i56(O*15YiJTOIfk4xYG# zWOl3h8iA{e5biIV$HyKF9kEX0dn608=S?6H-H zQId-cF2N2v8bSI&J(Dp z!UtR>g^DWA+iCk#b7?F8E4G7YI;NMJ#q~Bkwi|5BtfP~z#n$iBU9Awc?Q98cCBwo+ z>g&g4xesm~%q!5`JDs21p3MFd(RG2R$~Fn-x3pYTk}}FE%ctaNUf!#=BXRwSzxP{i z{atHI??VowX4iv1j`j9F?8*7lWvJ>Yi`A#j3|HupF6!WQILu^i7^DnK&Rjnf&#G+; zr{P#D6i*r7BeYf6ITqgtxVf=;ETQ4JB`&HkvPu8V7is-hjrtO;#a3*Cfrh5H$8wKX zn>5^ARJG~4;bF$?r?>xV+VzZFrxfKOr%R!|-{tAm!6{*IfGBR0fdu9HHf*1NdaI0D z)Z+b%HsFFCJ*mcvY@>Nq(+0*2ig-a-~26Ua@uaR z#_g1Ekgs3lQ2x4qsF<@Kb7ar;`9-M}d-KEy+Nsm_zq^hB(lOZaV!LjV#g_hA2JfWZ zVV+xQHYaXJIZJ(4s8jHbD*V|jMXBjW>F+r&DnHEnpOx_`_P?6h%X+KGB0dY^ zC{KxlHIKNx4eCzvdKqQ;aw& z_rbMV7fDY(#lK6-CF!VypP>7_F*I9LKvh=WZ9H_ja9wGSTUoHeaDnx{)^^a@WBo0r zUgdV}7>l)uj%V^s&(@8_>jtZoUb}PhYA>mWn{34)hUQ!YE)AZ+U%72EMekRxUcA)9 zrTr}_yXWO$`>xFwCR_S{Q?CTvj)p&uiG5?k*ZEvtJ^f(pVu?oH=H{75ew$0}32uXMU{>De{g^5k@%o~sSV1qXLlZ20rRs{NMBJOXYEdqg{UcwQim)E9T0 zGxY9dSqGZl81Iq{NoQm^_(n&y97|l&Wh`zyY;cEBe#-kjn_Ya$@s*-72z*|-v!y#; zzHp{ze<`i%gEicI98zumFoVNj3WUHpaKmGz8^~lyk!t-xT3r;RaG4lJU{b6*YAPC9wi}yg$GHPTN_6P5@ZoBS53qS z=x4l&pj@;O(+UW8wHEqG0L=A>Cj;(E2=|n>m55#^A%j^cy}QW}H&?`iz63JRz8qn$ z+esH;nhG(~P|T$(5UmwP=mG$1-JVDWLNyTXy+lV5u9pxu6U8miLAb)B6U@Drga?U9 zN&sIMVK-TbY+!f^%3t&bzPbuw3(q((yE2&!$QVN091*<^|55MCH3(C90D+jQaQiP< zyLY25bdTwGhlB=#`GPHUnGGu#W$-{=-+io<#=Y*CQIL>7voM5xQ!0 z^oMLfN=kvqj_OGv1BSNX`;<}<7bAsuMJV-_G{nVfrjH0SmrVw^^dDY*mpcdc9SYih>PA$X|4!YxZ=Uw%c*3b*A3w=PjeA0K1iCi sfVfb$pHKGtP

", + "description": "

", "version": "" }, "servers": [ From 1da20523236b0d37e6cb6e26b4442d75a82a2e02 Mon Sep 17 00:00:00 2001 From: NamanChhabra <57210650+NamanChhabra@users.noreply.github.com> Date: Wed, 21 Aug 2024 16:01:21 +0530 Subject: [PATCH 2/4] formatting change --- .../document-generation-api/stylingformattingtags.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/pages/overview/legacy-documentation/document-generation-api/stylingformattingtags.md b/src/pages/overview/legacy-documentation/document-generation-api/stylingformattingtags.md index dd0abc69c..bd9bb6be0 100644 --- a/src/pages/overview/legacy-documentation/document-generation-api/stylingformattingtags.md +++ b/src/pages/overview/legacy-documentation/document-generation-api/stylingformattingtags.md @@ -45,6 +45,8 @@ 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. +- Set height and width of an image. + Formatting for image can be provided using the attributes of the img tag. - The img tag supports the height and width attributes. From e58399f04e2532318d486d0fe54b95de90f7f474 Mon Sep 17 00:00:00 2001 From: NamanChhabra <57210650+NamanChhabra@users.noreply.github.com> Date: Wed, 21 Aug 2024 16:42:47 +0530 Subject: [PATCH 3/4] updated --- .../document-generation-api/stylingformattingtags.md | 8 ++++++++ .../overview/document-generation-api/templatetags.md | 4 ++++ .../document-generation-api/stylingformattingtags.md | 4 ++-- 3 files changed, 14 insertions(+), 2 deletions(-) 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/overview/legacy-documentation/document-generation-api/stylingformattingtags.md b/src/pages/overview/legacy-documentation/document-generation-api/stylingformattingtags.md index bd9bb6be0..85fd8be7b 100644 --- a/src/pages/overview/legacy-documentation/document-generation-api/stylingformattingtags.md +++ b/src/pages/overview/legacy-documentation/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#how-it-works). ## How It Works @@ -45,8 +47,6 @@ 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. -- Set height and width of an image. - Formatting for image can be provided using the attributes of the img tag. - The img tag supports the height and width attributes. From 5c807c112a890b84cc1f00161c3b09caafd2b5c7 Mon Sep 17 00:00:00 2001 From: NamanChhabra <57210650+NamanChhabra@users.noreply.github.com> Date: Thu, 22 Aug 2024 12:19:23 +0530 Subject: [PATCH 4/4] correct branch name --- src/pages/resources/openapi.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/resources/openapi.json b/src/pages/resources/openapi.json index 25c783ca7..10de65fa7 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": [