From 22e41feb81654f36e25998fe00ddf3028983ec6b Mon Sep 17 00:00:00 2001 From: Evan Sosenko Date: Wed, 10 Jul 2024 06:45:12 +0000 Subject: [PATCH] feat: Rename name to title for some types (#15) --- src/lib/blueprint.ts | 9 +++++---- test/snapshots/blueprint.test.ts.md | 6 +++--- test/snapshots/blueprint.test.ts.snap | Bin 996 -> 996 bytes test/snapshots/seam-blueprint.test.ts.md | 4 ++-- test/snapshots/seam-blueprint.test.ts.snap | Bin 2002 -> 2006 bytes 5 files changed, 10 insertions(+), 9 deletions(-) diff --git a/src/lib/blueprint.ts b/src/lib/blueprint.ts index 674db154..5b35903d 100644 --- a/src/lib/blueprint.ts +++ b/src/lib/blueprint.ts @@ -8,7 +8,7 @@ import type { } from './openapi.js' export interface Blueprint { - name: string + title: string routes: Route[] resources: Record } @@ -30,7 +30,7 @@ interface Namespace { } interface Endpoint { - name: string + title: string path: string description: string isUndocumented: boolean @@ -114,6 +114,7 @@ interface RecordProperty extends BaseProperty { interface ListProperty extends BaseProperty { type: 'list' } + interface BooleanProperty extends BaseProperty { type: 'boolean' } @@ -135,7 +136,7 @@ export const createBlueprint = ({ openapi }: TypesModule): Blueprint => { const targetSchema = 'acs_system' return { - name: openapi.info.title, + title: openapi.info.title, routes: createRoutes(openapi.paths, isFakeData, targetPath), resources: createResources( openapi.components.schemas, @@ -189,7 +190,7 @@ const createEndpoint = ( const endpointPath = `/${pathParts.slice(1, -1).join('/')}` return { - name: + title: 'operationId' in operation && typeof operation.operationId === 'string' ? operation.operationId : `${path.replace(/\//g, '')}${method.charAt(0).toUpperCase()}${method.slice(1).toLowerCase()}`, diff --git a/test/snapshots/blueprint.test.ts.md b/test/snapshots/blueprint.test.ts.md index 804fc4e4..c3b18e82 100644 --- a/test/snapshots/blueprint.test.ts.md +++ b/test/snapshots/blueprint.test.ts.md @@ -9,7 +9,6 @@ Generated by [AVA](https://avajs.dev). > blueprint { - name: 'Foo', resources: { foo: { properties: [ @@ -39,7 +38,6 @@ Generated by [AVA](https://avajs.dev). description: '', isDeprecated: false, isUndocumented: false, - name: 'foosGetGet', parameters: [], path: '/foos', request: { @@ -56,13 +54,13 @@ Generated by [AVA](https://avajs.dev). responseKey: 'foo', responseType: 'resource', }, + title: 'foosGetGet', }, { deprecationMessage: '', description: '', isDeprecated: false, isUndocumented: false, - name: 'foosGetPost', parameters: [], path: '/foos', request: { @@ -79,6 +77,7 @@ Generated by [AVA](https://avajs.dev). responseKey: 'foo', responseType: 'resource', }, + title: 'foosGetPost', }, ], namespace: { @@ -88,4 +87,5 @@ Generated by [AVA](https://avajs.dev). subroutes: [], }, ], + title: 'Foo', } diff --git a/test/snapshots/blueprint.test.ts.snap b/test/snapshots/blueprint.test.ts.snap index 7bc4312789507a5a7719914e1974ac73d40b1129..f7352604a07fc1e39a217014c6eea6655d4f2da9 100644 GIT binary patch literal 996 zcmVesf1oPw1S7EoWu^I-7g+|AOZ6=9z^2 z%c+fETpx=F00000000BkS51fzgfqHD2cG|0NgbRur>jo*zW-TtlgX!rHnVpt5@A_ zw_-^Z6_4&yv4-U_VP%Sl4$~}uixY5;fOp9_+A@!Jz98UB0&e{s@-qQT%n0!p!G$vtQTkJ~`s2F}~Shc9pH!qoN<5)juGaXVd2LP@Tmjbbbwz=cNcix1=d~QEf;v-1+KaVOt=8^ zwF}&K0rG&SJ)rLaBM-Rb0iS!o4G;LV1z{1FzUafCO4VA}SZ-{huH%7ZDUbm2Z$fe}z$tre!f%lKC zn~kFQIL>vJY~?xS^T4UZ)=upH`OrqI8|4Jw+`+9=yEWnb`izEd*SFK{?w)kBPp!SS zOW|g&{}<(aVt++|-Dy9QmfFqVvMrlWs7E`%69&NQ4gmYj2NZ!iC26#~Z!1eBFCWDN SKFS95-->%X!|pP73;+ND2Hh_J literal 996 zcmVC$u=V0_BLXj7k^qz&+ zKKTR_J|Bw+00000000BkS51fDlg@-Oa%2 zA#4f{UOUmnyFM~Q7*T*l9zUpBvR2! zty3mk6hHFFdJMo50A2?0I)D{&mdM%YZnIbsO_!Zc2ebe(L2ay%ajaO`OJrryfK?yn z8t0%zqPGE5o4#O@4@JymDY{k@If4&WvG0-b9e^Kn|3=flN5<~}{;bsOr-X<`Jej>BvY-@&M32xUeKR3on}9b-b8YIb?W+WQOu+8HCO;FY}13GLK@WS1XUy zR`p?@>~TIe{;+N=huyupn4cNI=LT@yXp(Lk`uuPGY88Ne-_yAvAS z4T!rM5JAanNOZSZRxu=c)|bbhF^H4eZ#!bsPBA29_P*aR)f>02dwLvIBhLXfVMH z%&r4`;{bmH^y?@Qw>yb%8Hk;3rpu>CAMjt#P!Ruw1Y>QYp{QGAW}ARc}Jm z3=<|}k>-Ww^nkB%et(+iou104C#WnbH;v9=W5wxl{>luBrE2HIkxHc5h5sQ1uSlVY z=7>pH`(PZHg8yHppsUOg`C=+x$Pyk82P~T}y`VTf>rAaPRZbMstIxbhL<6Rn&}ZI3 z^XR^swJX?bLngi~0lVcni2k16Vl(;F$h=qQd_Q8EAIjev*=2){nZZ SpLVPN6#oDQNOfy;3;+OI8{_T( diff --git a/test/snapshots/seam-blueprint.test.ts.md b/test/snapshots/seam-blueprint.test.ts.md index 1c476020..24bb6443 100644 --- a/test/snapshots/seam-blueprint.test.ts.md +++ b/test/snapshots/seam-blueprint.test.ts.md @@ -9,7 +9,6 @@ Generated by [AVA](https://avajs.dev). > blueprint { - name: 'Seam Connect', resources: { acs_system: { properties: [ @@ -204,7 +203,6 @@ Generated by [AVA](https://avajs.dev). description: '', isDeprecated: false, isUndocumented: false, - name: 'acsSystemsListPost', parameters: [], path: '/acs/systems', request: { @@ -219,6 +217,7 @@ Generated by [AVA](https://avajs.dev). description: 'OK', responseType: 'void', }, + title: 'acsSystemsListPost', }, ], namespace: { @@ -228,4 +227,5 @@ Generated by [AVA](https://avajs.dev). subroutes: [], }, ], + title: 'Seam Connect', } diff --git a/test/snapshots/seam-blueprint.test.ts.snap b/test/snapshots/seam-blueprint.test.ts.snap index 359fcd71d092d3d098767f3191fb0bba64952a4d..afa2b704696ccae43cb9b3aeed8deb0850356b49 100644 GIT binary patch literal 2006 zcmV;{2PybLRzV_plon%50FzP#jI^X^ zE4~pov$LnSLuY5UGqbm?5Mzl#i1q_uq$H$bKd6ZY8>&%EB!CIA(L@X;rb(3#6b*`B zL}KC_I#c#G^ntz(XaGa;4|AT|;`|rDyssC0wWN2j>fnidgsTQ0Qm(D7#zg&G`>F zwk-`m@F?~Q@CVhC*q|p#5gQhe6HBzA?XIgI7Vqw&LZJ}4D?*>f#d)97y5ZHl!=5jj zh;+!v2yvrW8V{{4;BEnr2*m?U^Fw84UyrCh5p+`4OIxXq? zW@MbQ-GSY6xFs*>ehv{24SuW7U`pDJmSfs}Cm%2LU$XV4^jf+hm0QJIy1%b?-z~b~ zZRy;jW8*LVHoSJdo7SWl8P#AygLN8Qt--Y#+@!%S4L+%X)S#uo-5T7d!Gjt+rolHf zcv6EOY48(mFpKelEG9+lMGejU=+Wer}{lnh*>ByGUNdj?FT5v8ye(($ksGD2*R z(=Cug0gQ$4I|0-}_}c)+LpU=8Vkm@r0+7!P)WnBX+<_1k=beR z({MZu&!*vA8fG$zEE$n)&%g&Wa3BL;&cOFG@TMwDMP%!;uptY(v#^+jN3-zLtRhQC zWUpo6Pg$7G!L}UKbMQb;k!2#XZ|C629GuO;n>n~F4>#u(Syq(|@6Cgihp*(}sXUy` zL!tmz78GeNa>s22xVZpM0Uj#A_X_ZuDjSc;3Pl(z!nPvRi|~aaoGdD`YDD&85zZ7r zE5Z5_e5eFYNs&!NWDk|#SP7mh!7C+5j=+WyMK&23mYpN;krB9O1YR0}*eGlqg&m`c zbSiR3V-(DP(;glLtqkkS@TsyQyCNd{Y#BaZh9}DKi!%JV3=?CDY<)y_-5A_326v6Y z(J?qV24_^+m8vZL_c4f7;HnDjs(@R8M=Eft0%t4mMg(zWGJkSk8dR}e8b=oa;kspX{xb8TX)a}(5+;|vV z+jp9}FKg0v9m{G;+h3c}Ob5|)-jm-c3EC8dfpWqSVV3nbmCyhcr5_VHP@6J0{OuH&w7eVtKQvFUXp1`88i2TAPnasuM%o zwbrEj@k=S5xAiF(+tTylZ}aBOOQ_NF{JQzJC+7#sJ;MGEBhM_ohpv2%_}qVEju1O9 zZCD0ofwy~%s(oX$_NSZVLEW`YdtoiUO=J%`?*6c+cL^U(ssC{VdDHu--EfR{@D0&N z$_w%AczUZ3>PWUo*9)yZC;^!dqNpY)HDojz&LczLR8{Q9Y$ z@%mKH_ybct<0q$j#(y={Gyc!1p7ATDJH~tM@}1Lt<KBv*Cn*-A;DZWC>m3yV@ z%EoP>wpWz5@7ldbt#nT|b=xp` zD|swLworaB4Nt4IVubecG`yO^eKYVSl~#_>emDcq zsI;*N?XNSytU{|qXq#r?8kIH^q1`bHcdE462<^x$+^^E+BD5!F;kznrK0^D=ESytm z?~2eapM#Ba3hlB8?c;OsX_dAvLOV7G$5q+J7pJB@-SV9k+RfEnbJ6KG9xl#bx6f<@9j1n~eN(q;P2JWPq#Jmq z+vaD&h4$iBN{gmvI<{rnvVYHSSm2{aSl>cGtU`CL|;cX?RGeL6EdGAeuf> znt;>@$;{d}yOY>6?#y`8qyiez2-NU_fC!anRkafRz@t?Vs`4SC6j23%P*EhLhyYSU zfr@;hl@N$3&>62C`%b#qhzfQq{ONDc|9|c|_nf(R?ioM1f3{)Q4!TF5lAh@`q+N5Q z;mMCS+Op-CmS?(_(Q@Z)&prB7y>58MeKQv|hVeflE}|a_q~9J{IZo zr{&l!>3F6e{lLtoyVJGza7$j*{R|=+82nD3!GyHxE!(ub&Md#wf6334+cIiWO=8RN z=6mCAHEQnG&KMmVf9tp5wr8&-t60=P*I=y%TQs;?gWEK?TZ8*FsB2(ra72S+8hllQ zZ)xzf2B$PQqrq8iFpJTFEXGCToCfC=(v2$Vq6V*ON(SDiByGUN`v*)U5rv=@649U* zQbODkrCT6}qCt**_>2#=0RGX3(EwJ4Knw+Nj}K!3e8h*t0er!S@c_Qz!$bf-5F;2m zCBy+ArULk+57PlW@54+0M}|RU1GvkFxd0yZVZN`HPY3t*V)egunxlT2{h5pXYZ!*& zur&_%#-SaDC*sOX4yolI`$-&r7Khj3P)@+j33xD}$YLSc6AAcs0$xhMYY8YP;r65= z8xF~uNpO?!coKe`gg+#ql2T;xknENed^`oMH>qDw!E-6NtjZE0+1fO0OvAltXs6-P zH2gfR$dV!1r8N9C4U-wzo&h5RU(P79R7m#S44lfqg$!KIzztd0nN?(IRW>ZMa4-ws z$inF?T*$&u4mRWzX(lw{_8jcYft7<3Irw1?E~&DykSv>rQXaPF!N|kId3ZLj$n=ox zTprHnAyR<#1^7e(tb!sN56Mmx;F|?_p#ZNGV7Leyi;8R_G%a@&;gdypun4~|f*65K zBd}{kkxqt2oE?Gr5%}5&L`tx}1p7*gY<)=fxe|P_1m7>guS)QG3G}ie+Ypj%E5nX5 zm}U4%8J;b}c~$mqRhIl`8N?`T9)-I{;r>xLISMb1!pozO9D{XZikZ!!t!PMD9Ex?> za%9c$OxwCkx~?(T-E>fxsk(G)j@j~=Z$U|$?#@MXvL5^x$uITbkh!w0Rn5A}^!hfy znCm&FHMjCY*ibX9s!^|3{ZQJjblj?E2Vaa@O}cJ%&avAqb(0^6ZFttU8`7{=UT|YU zaBa_S8lJ35%ds1crnJ1(8BN8Hrt_HmPD#*aKO{#s?FHFafcqW0`A&(jTs2-t-L^zoyx0MjU{iN6}!;Iq~qAmGG{)vl047I2R!LmMx*LGyJP^; zYBz(k&qv1kPN@q0ZZ<9nP zhPKmKmF`Ecr+D7hyIkx@t_eO{wrp8M^`7S+TGMvrnt^f;vH!!!Q;W}`%U>ft|KC_6 z#GThSEd#5-+dW5m-yE&}=|i@2FzD%B$H6J_KaL=4x}UP@cCGE7 zA(j zq}#GBSNezW#5Nsv=y1CZdv&Pla6pH)4iD*YTpw&#W|ekj;-n6b>F~4;r*t@@!&x29 z>F_%pUR4ZK1`P~cdyis#=ye_bp+j*TZW@Pu<4QYVi`rGtj*Y|daX6(?-#bW6cAJ>L z8Sl19#YC@7x^be{Cfz;JYm+Wa^xCA4PxRWPKb`2cNiR)w+N3?>#mTPmZIeCYpPlR( z|I%d7_%o9|>!6PcI6r!D;f*+~0a)|c# zDY&fCMnkks)39|~p-qKod#7QaN}CSRzAz2PRN734_PuHNfl6BwqWyLnE~>N}LbSCr zuyIDAtqsvWJp-RnY3o9?lQZy`N_$s`c6J7SIWxFk-L%Adwe>2m>6X}?Tb@~UO;0X^ zYBW5fYCCh+rY2pZ;n~Zyo0)aY1-sjKxHf;?yjk}fOm%5_rqQT24a=C5j_;XanMZQPp|0};GHB*M`8dYPqVIS^yz?IH|SzAV=*@ofO=Bu-9vr+FpE&M+_ kD>gfwmwstq(A&9!%|$khS=lgWyZ-|CH!6&<7bYM806F;L>i_@%