From 669adddc9dc3590df997b234e274b849c708d715 Mon Sep 17 00:00:00 2001 From: Heather Cloward Date: Wed, 22 Sep 2021 22:17:19 -0400 Subject: [PATCH] Updates per reviews and adds new logo --- README.md | 13 ++++++++----- docs/images/redoc.png | Bin 0 -> 8047 bytes 2 files changed, 8 insertions(+), 5 deletions(-) create mode 100644 docs/images/redoc.png diff --git a/README.md b/README.md index 5647e2fd..7f55d8af 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@
- ReDoc logo + ReDoc logo # Generate interactive API documentation from OpenAPI definitions @@ -13,10 +13,13 @@ ## About Redoc -Redoc is an open-source tool for generating OpenAPI(aka Swagger) definitions. By default -Redoc offers a three-panel, responsive layout: the left panel contains a search bar and navigation menu, -the central panel contains the documentation, and the right panel contains request and response -examples. +Redoc is an open-source tool for generating documentation from OpenAPI (fka Swagger) definitions. + +By default Redoc offers a three-panel, responsive layout: + +- The left panel contains a search bar and navigation menu. +- The central panel contains the documentation. +- The right panel contains request and response examples. ![ReDoc demo](https://raw.githubusercontent.com/Redocly/redoc/master/demo/redoc-demo.png) diff --git a/docs/images/redoc.png b/docs/images/redoc.png new file mode 100644 index 0000000000000000000000000000000000000000..15579760928b664b526cc89aedceecfb72460154 GIT binary patch literal 8047 zcmeHs_g52L)HMmAiwPa1#n6O+(gc(iFi3CGJE%12N|hEsARxUXQlytqLN^rYC?Hju zBGQYYgMfhWhUfbaz8~N9t~D!b&dfb??>*}Mh(P6<_{g1#?cJ3A_!;r{o&b?x^o{kyN+AAy*dO;R*X3LR%p0w+jk z6>d2sC?V(}5QUC31BACjo=KLSW9N|Hiyq(jZWLuMf_VCA&ok}xRo==4b`i+vo zbe`M@;PtV9Sa7=;v=I(cL0umpk~iW1ov3s~5s~yzu*xP9Q6vyi=pc+q|KEuBSgJFc<<2BmE5CmJBz2i*M8Z4>YqMebn3Y&r_ws% zR>=HB-a;d*P9O8L`4OAkYsGq5XCHwZN672!sgkD{BC49^Cx9<+SpwPrXnq=TMCu5%@EFAPA%%LrCTL1AW=XL4a zp-53g7-D9f>A^PyrsH$r-T^IE=I!G!VKKbTd4XcEYvVjcpLkrh6j%G%>uLw%TEiG- zF|*dA$H81wsd<+zKTyycwiJu1v`_%;DCABn%Dm0HTgrOgXHUvw=fYO=V9@7mwr+i? zr|cCl|7_>{PgKwIqn^L{m9cuLK_h_-813gs#3Bg@&#CV=DP<&YljD1Eu3VQ857RI9MOcBS74aO4)!c$x=8TD zKhN`RHXl~ptxCsHL*zMRIgW>SuVXP9h4?@M3cOluvj5Bej6=@L%xl1)J8DY$1VlQ_ z1OK_7TYbdP(k|^l9u-Uo|EX5qC{Q%$9S(+JmFzzWh}FCrThq%w_wSBX1l}%2_vEjT za4!gjC{n46faP=zQ8j@|Oxi@mYq=U3CC~4e@j?;<$>RFR`rw2Ywv|iA0Wik$xYd2L z+=pfJ-NLWnD+_T67bXZL|E;m*E3bcu_h+lEc%hAWkV;-5h*AhT7Oi#J9{j1Ya5mMd z_LxHorV+tsqfJG;{~u&PDN>#wT<2PaCiHJ~k@jvByG z&KtM&H_hzqCff@MZ~Mv@b4fqiScEAO5Lj}8H=~f56~??2JL5Xvs4UG9>Ls~;?`2F` zUv13T?T~WFog!50*sIcwjnhg2#NbQ43CgR>M|_kw+9$4qqnVci4DIyvZYYG$#OKN| z>{2sVx&}Ezqamc$OL{*+#x;E zB;?QmSi}I)_ZEgWJMDf@wAX3i0-u}MERqNRs#(o?p&Wn02cRv5g*>4`W48JMRsP5SHhAcGO+nHo`3&V}qZwtKJUwtgqTSUf4l#9%^BnB1WqXd<#UPt7N#W2(r}V}rl%E^$lD#p0gE71h%-?Wr z^()h`NUw_7+Ft7Z6mJ<{b2qRA(hjQ!DBpS)f3*a86x^nRxcKUyc|h>&K2}yZt7@2| zrBMy&ttZEUe)mND*Z(3+Rg?pbeOM9lkQjJR$1axz*b=mOb77HH{TYGjH? zsBT_QF44B#U(|hs0_Fpj#~km0xHW^Gl8%=~9rDA15pPs|_;VJQYbUeDt*6c^BT!I_ znX<&=_WD`c3k874;r^l(C0gmO9`f={z31fPB2-@2*KPxK1QdpEzjzqWoyx00sp42W z{@^w}MBS4<@hYV2a$_+q^5W7kmnMxn*}{%C!A1InLjS3%+>9ShWzp3Q<|2(q4RGAd zz{#4Bt5)%#2qii$Mt+?iN^$TG1_K>ufsJYpq)EpQg`J+#CRp7wS55E_ZlnLHXRLIk z7T-B=^x3l$Bb)t>hy?kyx1^3f;mybG7PNJ4YH;hEvdL!Se0x@c-NmXO1-kWc6)v>Y z&?K*4Oa=?3uHTvWhu&KkL85@Pp^KYFl;}r&=XYV%?L}4YBbTqggcQ%J&jUkSo{?rc zdz8j$W;uEpr>fIK7#Kbc>mt|=f7sJ>`bL)LD}^UDRJ=h!hq?NO42vl?*^a-&V3G}@ z_wGQ8KKJQI<)I2Y)+^A2Z-JJ{EXTu_G9;P}(`poG*Ox?~m8+IxrjgtU=RonuJ5XKN z<-cN7;m|8iC6Hm1flvZx(8U9uufy|j9_UP$kz`|7y=9ws!K)P+`A2~LRwDA-cc3gO zfM3YM-36=~fd3^EW3)o9!f#InM6>M6b+T~acxIHFJz>ylvo>tJpy~CEm7~lzaasD%pLyHMkI zj;ueg*1wl>Gv3zD96LV8egP+(R;I#wz=66onn|8UK@Be+9RR`{; zcyu$4Qpvf|&qN(Wf56{$1AO#c#dSQ@Wk#~gHz?fr7skHy!1cF%2)lI8{zY#EgQWDU z-AiJ?a=vj&bU@EwLlEvBigg-b}XjEg(FiyXs@_xZHbzk2iT{jL+A z^H_Q($(@bo9uL5PPSgBexFovie9ELB?9t;rNv%E|m6lc6IGb{cE76wjId(gK3&t1U z>L1L%*y{?ftdAGZ)d(0dJwX7z+>RU&g!vZ4$w5zJ2SmYyu#IWnM4a8^l%>gPO=GPD zy6phIF6}OtWUq6d`i!aQ~CG#(S&I66S z$w^n;cBpH&1-VLZ0n?hqm|3`ea`^YVt6ny~3Y@~lL>9~p zuW2(%!V6n|3)rfc*rGPuGTfDvaG8!s-#LK^BvTWewdl`E^^Ch?3 z)hgrFJo)E;WZ>SG-Rbow*2{v8ibx%b3`!FkQ<$(!sd|`Wqt?5U546D0wo$LmF25Vl z3O2iijEgT(_hr(W&@Q=T z@foy3+_$6xUjDvYBn6mlUj2dG$4@yKkEXskK>0o$o#VAQxHaTm=hd&Bt;x-C&x;kB z(2r)7BQ(FF-jM@RHu*$3WiV+s5U7$Q)5DK#nN)V4^nu^ndY{xc96A6SlqGuUc4_bH zI)WfT7sFa{r*1~sr@(c~lA{m)-SscoZJn2n!n^E>Xa1eLJRLhIo>5!h7%6$!`^XFE zpEHxWf{&M}yph27HG6yFI zX((s8q<7{!jeNi^cIMr|^(TBPpQ7&jmS8opCa4=tGjN~xCjC!8E@<(C%VI_Qb1Pr( z=qeq03*>7@fuzjCbbQkLvj9tAXyoM&S+ZWZTjmLI=dGyHM{jBM%)D$12D6C6Hk);W zJwA!(QM!G{xsQeRwQ25*E%RX+pz|3%0q1SCOM2n4JHq5&KebSg_6gmx&qhHp^Tf)m z-JPh1q#XtfbpkRRr{V21UwBSQVEi*{r91`{~*FfEP(t z)Am>`Vm06_=3M-%)3h69_QwGCcz<1!2JZ?9*S+{EfoWGd{WlWQ50>N}0zx24gW9K( zrtCg!B@0h~-@SC5Yecr|W2cA}NJbjK)yQ2*qj>cd^8 zSi8E~oX*quJGIsF)lntJ(0Uuhswg9tm2A(&kEjbsw)( z?G!k6=i&I5liKh+1EYW!ycKlXq=wMg66OuvPO5Wfo)+!ZZjb{l^W#M0JUObUAKt_JujaA~iMa&oB3Iw##-cG5C!& zy{_r-PtO{S((YEN8}mRjPR~O}rk}I4Sw{y-UF`Y9yh3J|IcZA9O5ciz|HKb9 z82)3*L^Cl%_J+refXgA!{G>1%WOnz?o5cZ@AmwS@Bn2yr(*v2VaWCZ$(z>e}%XAXO z#`-qDhiw{@9C=d-+koS2NO{#GPd82JGfE*|!st7PqOU#KPtfxPF@zcJCsZ^Dz&7-z zzh-oHm*LgE&^q#fKwTjWzl1}X*R8<;Y-6vH=jfuKf4B~W9A zCm1?EBd~Y?f!ruua`8Pbf%gvoB*UyPcW=FkBP-5%TJcLz{vlTJD(IVyyE#)+>#?V# z*SZo(&-2~~_r#=(OFlfKWry@bKmPuXX}Qe*Yk2gFKH=6trztJX(K>$K!A5*-*6fO_!QEaH`zC~;C{=l>(jK3G>|Cj_s zyo+=4g8%E@eDya@361lAdhph>n2Fe!ym*3cPYtmmh`~79%+3rZO)t2RvyS%sNuCZx z*Ux|C!?jmPT4YZXR|^#L0z@hg`tmSU2OWNxa_!&3E&cR%JXiiRmmBxSBu)C1ScbYk z$l%A>7$7UDJErcu4IAhoh2t%o z)*pVV{f{}P4pd-JE7zZ? z%11zTVq7bhA)&RTY&~g@lJs{hsz+1$8$-R!aQ6-G_Z1Q7Jbt(GnlZ1`^f4qmST8_B z2=az3MEEOxXl#kp1mmKwP0=fk)lQxv2d1=5>fnp|2zOD@^UGDkHie#2R0i(q;Ps%} z_lsDGPhH-oZvhl!tZ|BcR$dySsJA=H*->soDqZcHsb@%*te)*QKtVye{Q>KizJ|wL0cgfp z39H_q`ho`jY5qOMhs4qUBDIFz7?=?6KSsPLCrPsIG~q#l8YAVHMHS3g@)SFYRVUpY zNkDz)ON}pk=fRCy_K&FQaOK;c(y;ucDU&%(I{W0*`BKz^+(Wu8X1BMjte#PP7_$n{ z&56d_4mOcd3^=EWcSaPyN}PYS(ImiPLy%M^IWSs#03(>eTk8>9`QkVw`BF@i=1+0W zLhyvG%gJa?p~#nbS=sz$+SE1Mr$yzX6FuPb*A)Whep+7g_2Mg6W6!2YA86X??J3fD zG2_vFs+WE9Jf1Ir1O!XEXK!O`O9pq8lBlcsHp?AKDKq#Fxz{({Y}3-H{#Z_ib4qja z-Jj9k`-6wYY9g*TxY@v-tOMd@abC-7#%&~7#S!@D?`*|sYr|AvStX8M$Kc`FTd zZO@(*?8`O(2cHY})ANr^klHF5oILn zWgPZqwphagPO);)z!V? zi6h@t_7HnaQjp`=z3Q+FU|=wTL7UuuHj*vnHGCS1+S7a{#LTxn9+;3Md$AO@b8kiW zNu-Fx&_<}O)m({S9Pr8L`+Ay0j@>}P$8lLs0oJQwAza0!`MJ0>^C@6xeXoldr8N)q#WbNeAPyBH%W=YVMn@+G+@ zn+6d<@*7BIw=IdA&$85wf?0mla>(Bgk{w!eS;LAJx-9H{S=y>jcg|;QRk6NGtg(%3 zI*a-2yh~T1vf@ia!mZrwM@DF+$H>f1Sf^B6IHOx97;egg0gnDNu5 zCCNT+XiA0+@3OVOI0gBePH__BdE&|tKdMg<=7q;O;p}~DHP9xTFW+YZw`n*?y9yY6 zyBELgIy_h^Qt#{Z?CFr-3h7L+Z8iv1~qse{RiSNX1bCj zu+H%g0?&kntKi%anr=(dVltvDn<9z%<9v9QQ&Ha9ZKw(>PE^BLXR+t&mAvy06=ie zeFf{}InI1?`O<*oGxev9q<`aj(^Ypurlglh$Ldz&@VBxWrw0nw=)r`(_$LKU$y$|C zt*Dw^%ufM>Mm*Q32=(&lLp;C~PSp;oBNFTc7SNCAjeMB#h}Quo1!w)T*&@DPn{GY(^!d0?rC4uVBf?$ zwTA@cbmYMa$~5-ZY&u%lsKa2TDK>2l!;o~)O|El>&ZOR`<5JpFv4aIFUPW^If`(p<1ip(MC4{mn6idPbZ(5aGfp)m zdC|_JM;&Chn`tTWoXu0&v*g2|Kt*q{Ng>>Ynb3x3_9ODc^E6i_%J5cIzY`nK*Utx)7UEqVbTp;5Vxv~$mHwE@0AL;+vQ`;$lzxfawqvl z=U;Tv{9LLsFIG(nb=9#dh$)o7lzX*(6%@2k5J*OEj2pi>boluGldqC>4Z9Fg3QxW7 zl*=5A2B24?>P6<;&Y_m%l3?mSzbSDSs-=k2PG4wo##7?T7cGQVx2LnaA2el8AQfqA z9E$AZqok__B1w{DT#=Jn{Y*y9D`2RLq=yf#fVXSlLJtyY_IF`iWH)shbD#) zgoQT*o<~u5;4&5VLZ<9gTTVS!K@TKREb8(gl(o? z%MO{Lny&i5&{u!x)^w3JD~fquxBvO=-9qlO>BA9 zpOC69WtOdxf72}oOaz`k@mk%f!Dl({Iwv>peVTu~pBg~;M47F;9Bw8oZ3U4>4+P$w zVXP<6dWNYVF!X-)bYSD*_@JWU(`K$DdI46x4V-4& zH-(ad+sBQ>1ugh$?!NgiS^6L~I8+o1{?0);)Avp)@WaMraLOo)_4A4XpAOPx6#_5A zl)<4%VEGY1USJUuL~rTufAUoVN*X|kmX