swagger-typescript-api 10.0.2 → 10.0.3

package/README.md

@@ -2,7 +2,7 @@
 
 [![NPM badge](https://img.shields.io/npm/v/swagger-typescript-api.svg)](https://www.npmjs.com/package/swagger-typescript-api) 
 [![CI](https://github.com/acacode/swagger-typescript-api/actions/workflows/main.yml/badge.svg?branch=next)](https://github.com/acacode/swagger-typescript-api/actions/workflows/main.yml) <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-30-orange.svg)](#contributors)
+[![All Contributors](https://img.shields.io/badge/all_contributors-31-orange.svg)](#contributors)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 <img src="https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/swagger-typescript-api-logo.png" align="left"
@@ -120,6 +120,7 @@ generateApi({
   enumNamesAsValues: false,
   moduleNameFirstTag: false,
   generateUnionEnums: false,
+  addReadonly: false,
   extraTemplates: [],
   hooks: {
     onCreateComponent: (component) => {},
@@ -222,46 +223,49 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->
 <table>
-  <tr>
-    <td align="center"><a href="https://github.com/js2me"><img src="https://avatars1.githubusercontent.com/u/16340911?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sergey S. Volkov</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=js2me" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/commits?author=js2me" title="Documentation">📖</a> <a href="#design-js2me" title="Design">🎨</a> <a href="#example-js2me" title="Examples">💡</a> <a href="#maintenance-js2me" title="Maintenance">🚧</a> <a href="#ideas-js2me" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3Ajs2me" title="Bug reports">🐛</a></td>
-    <td align="center"><a href="https://github.com/andrefilimono"><img src="https://avatars0.githubusercontent.com/u/7794526?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Filimonov Andrey</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=andrefilimono" title="Code">💻</a> <a href="#ideas-andrefilimono" title="Ideas, Planning, & Feedback">🤔</a> <a href="#design-andrefilimono" title="Design">🎨</a></td>
-    <td align="center"><a href="https://github.com/Fl0pZz"><img src="https://avatars2.githubusercontent.com/u/9510124?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Rafael Fakhreev</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=Fl0pZz" title="Code">💻</a> <a href="#ideas-Fl0pZz" title="Ideas, Planning, & Feedback">🤔</a></td>
-    <td align="center"><a href="https://azzola.dev"><img src="https://avatars3.githubusercontent.com/u/1297597?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Lucas Azzola</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=azz" title="Code">💻</a> <a href="#ideas-azz" title="Ideas, Planning, & Feedback">🤔</a> <a href="#design-azz" title="Design">🎨</a></td>
-    <td align="center"><a href="https://github.com/JennieJi"><img src="https://avatars3.githubusercontent.com/u/1913045?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jennie</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=JennieJi" title="Code">💻</a> <a href="#ideas-JennieJi" title="Ideas, Planning, & Feedback">🤔</a></td>
-    <td align="center"><a href="https://github.com/jomarquez21"><img src="https://avatars1.githubusercontent.com/u/16705169?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jose Enrique Marquez</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=jomarquez21" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3Ajomarquez21" title="Bug reports">🐛</a></td>
-    <td align="center"><a href="https://glassechidna.com.au"><img src="https://avatars1.githubusercontent.com/u/482276?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Benjamin Dobell</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=Benjamin-Dobell" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3ABenjamin-Dobell" title="Bug reports">🐛</a></td>
-  </tr>
-  <tr>
-    <td align="center"><a href="http://fixate.it"><img src="https://avatars0.githubusercontent.com/u/1510520?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Larry Botha</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=larrybotha" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3Alarrybotha" title="Bug reports">🐛</a></td>
-    <td align="center"><a href="https://github.com/nikalun"><img src="https://avatars3.githubusercontent.com/u/13102962?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Nikolay Lukinykh</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=nikalun" title="Code">💻</a> <a href="#ideas-nikalun" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3Anikalun" title="Bug reports">🐛</a></td>
-    <td align="center"><a href="https://github.com/Mvbraathen"><img src="https://avatars0.githubusercontent.com/u/16756739?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Marius Bråthen</b></sub></a><br /><a href="#security-Mvbraathen" title="Security">🛡️</a></td>
-    <td align="center"><a href="https://github.com/xesjkeee"><img src="https://avatars2.githubusercontent.com/u/17751886?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Evgeny Vlasov</b></sub></a><br /><a href="#ideas-xesjkeee" title="Ideas, Planning, & Feedback">🤔</a></td>
-    <td align="center"><a href="https://github.com/kel666"><img src="https://avatars1.githubusercontent.com/u/2040661?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Fabio</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3Akel666" title="Bug reports">🐛</a> <a href="https://github.com/acacode/swagger-typescript-api/commits?author=kel666" title="Code">💻</a></td>
-    <td align="center"><a href="https://github.com/Fabiencdp"><img src="https://avatars.githubusercontent.com/u/6182473?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Fabien</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3AFabiencdp" title="Bug reports">🐛</a></td>
-    <td align="center"><a href="https://about.me/julienrousseau"><img src="https://avatars.githubusercontent.com/u/3296671?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Rousseau Julien</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3ARoXuS" title="Bug reports">🐛</a></td>
-  </tr>
-  <tr>
-    <td align="center"><a href="http://sebastianarias.dev"><img src="https://avatars.githubusercontent.com/u/9751266?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sebastián Arias</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3ALarox" title="Bug reports">🐛</a></td>
-    <td align="center"><a href="https://github.com/Styn"><img src="https://avatars.githubusercontent.com/u/6705137?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Stijn Lammens</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3AStyn" title="Bug reports">🐛</a> <a href="https://github.com/acacode/swagger-typescript-api/commits?author=Styn" title="Code">💻</a></td>
-    <td align="center"><a href="http://emilecantin.com"><img src="https://avatars.githubusercontent.com/u/885486?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Emile Cantin</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3Aemilecantin" title="Bug reports">🐛</a> <a href="https://github.com/acacode/swagger-typescript-api/commits?author=emilecantin" title="Code">💻</a></td>
-    <td align="center"><a href="https://github.com/armsnyder"><img src="https://avatars.githubusercontent.com/u/9969202?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Adam Snyder</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=armsnyder" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3Aarmsnyder" title="Bug reports">🐛</a></td>
-    <td align="center"><a href="https://github.com/jnpoyser"><img src="https://avatars.githubusercontent.com/u/7920428?v=4?s=100" width="100px;" alt=""/><br /><sub><b>James Poyser</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=jnpoyser" title="Code">💻</a> <a href="#ideas-jnpoyser" title="Ideas, Planning, & Feedback">🤔</a></td>
-    <td align="center"><a href="http://ru.linkedin.com/in/lisikhin"><img src="https://avatars.githubusercontent.com/u/475367?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Alexey</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3ANihisil" title="Bug reports">🐛</a></td>
-    <td align="center"><a href="http://imaniu.com"><img src="https://avatars.githubusercontent.com/u/50100681?v=4?s=100" width="100px;" alt=""/><br /><sub><b>江麻妞</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=jiangmaniu" title="Code">💻</a></td>
-  </tr>
-  <tr>
-    <td align="center"><a href="https://kspr.dev"><img src="https://avatars.githubusercontent.com/u/5294519?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Kasper Moskwiak</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=kmoskwiak" title="Code">💻</a> <a href="#ideas-kmoskwiak" title="Ideas, Planning, & Feedback">🤔</a></td>
-    <td align="center"><a href="https://github.com/baggoedw"><img src="https://avatars.githubusercontent.com/u/92381702?v=4?s=100" width="100px;" alt=""/><br /><sub><b>baggoedw</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=baggoedw" title="Code">💻</a></td>
-    <td align="center"><a href="https://marcusdunn.github.io"><img src="https://avatars.githubusercontent.com/u/51931484?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Marcus Dunn</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=MarcusDunn" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3AMarcusDunn" title="Bug reports">🐛</a></td>
-    <td align="center"><a href="https://www.danielplayfaircal.com/"><img src="https://avatars.githubusercontent.com/u/1217649?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Daniel Playfair Cal</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=hedgepigdaniel" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3Ahedgepigdaniel" title="Bug reports">🐛</a></td>
-    <td align="center"><a href="https://www.linkedin.com/in/patrick-shaw/"><img src="https://avatars.githubusercontent.com/u/5153619?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Patrick Shaw</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/pulls?q=is%3Apr+reviewed-by%3APatrickShaw" title="Reviewed Pull Requests">👀</a></td>
-    <td align="center"><a href="https://www.linkedin.com/in/jinkwon-lee"><img src="https://avatars.githubusercontent.com/u/1798916?v=4?s=100" width="100px;" alt=""/><br /><sub><b>JK</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=jinkwon" title="Code">💻</a></td>
-    <td align="center"><a href="https://github.com/RoCat"><img src="https://avatars.githubusercontent.com/u/3562317?v=4?s=100" width="100px;" alt=""/><br /><sub><b>RoCat</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=RoCat" title="Code">💻</a> <a href="#ideas-RoCat" title="Ideas, Planning, & Feedback">🤔</a> <a href="#design-RoCat" title="Design">🎨</a></td>
-  </tr>
-  <tr>
-    <td align="center"><a href="https://github.com/ApacheEx"><img src="https://avatars.githubusercontent.com/u/1918108?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Oleg Kuzava</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=ApacheEx" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3AApacheEx" title="Bug reports">🐛</a></td>
-    <td align="center"><a href="http://nikz.se"><img src="https://avatars.githubusercontent.com/u/7352072?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Niklas Frank</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=nksfrank" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3Anksfrank" title="Bug reports">🐛</a></td>
-  </tr>
+  <tbody>
+    <tr>
+      <td align="center"><a href="https://github.com/js2me"><img src="https://avatars1.githubusercontent.com/u/16340911?v=4?s=100" width="100px;" alt="Sergey S. Volkov"/><br /><sub><b>Sergey S. Volkov</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=js2me" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/commits?author=js2me" title="Documentation">📖</a> <a href="#design-js2me" title="Design">🎨</a> <a href="#example-js2me" title="Examples">💡</a> <a href="#maintenance-js2me" title="Maintenance">🚧</a> <a href="#ideas-js2me" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3Ajs2me" title="Bug reports">🐛</a></td>
+      <td align="center"><a href="https://github.com/andrefilimono"><img src="https://avatars0.githubusercontent.com/u/7794526?v=4?s=100" width="100px;" alt="Filimonov Andrey"/><br /><sub><b>Filimonov Andrey</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=andrefilimono" title="Code">💻</a> <a href="#ideas-andrefilimono" title="Ideas, Planning, & Feedback">🤔</a> <a href="#design-andrefilimono" title="Design">🎨</a></td>
+      <td align="center"><a href="https://github.com/Fl0pZz"><img src="https://avatars2.githubusercontent.com/u/9510124?v=4?s=100" width="100px;" alt="Rafael Fakhreev"/><br /><sub><b>Rafael Fakhreev</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=Fl0pZz" title="Code">💻</a> <a href="#ideas-Fl0pZz" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center"><a href="https://azzola.dev"><img src="https://avatars3.githubusercontent.com/u/1297597?v=4?s=100" width="100px;" alt="Lucas Azzola"/><br /><sub><b>Lucas Azzola</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=azz" title="Code">💻</a> <a href="#ideas-azz" title="Ideas, Planning, & Feedback">🤔</a> <a href="#design-azz" title="Design">🎨</a></td>
+      <td align="center"><a href="https://github.com/JennieJi"><img src="https://avatars3.githubusercontent.com/u/1913045?v=4?s=100" width="100px;" alt="Jennie"/><br /><sub><b>Jennie</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=JennieJi" title="Code">💻</a> <a href="#ideas-JennieJi" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center"><a href="https://github.com/jomarquez21"><img src="https://avatars1.githubusercontent.com/u/16705169?v=4?s=100" width="100px;" alt="Jose Enrique Marquez"/><br /><sub><b>Jose Enrique Marquez</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=jomarquez21" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3Ajomarquez21" title="Bug reports">🐛</a></td>
+      <td align="center"><a href="https://glassechidna.com.au"><img src="https://avatars1.githubusercontent.com/u/482276?v=4?s=100" width="100px;" alt="Benjamin Dobell"/><br /><sub><b>Benjamin Dobell</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=Benjamin-Dobell" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3ABenjamin-Dobell" title="Bug reports">🐛</a></td>
+    </tr>
+    <tr>
+      <td align="center"><a href="http://fixate.it"><img src="https://avatars0.githubusercontent.com/u/1510520?v=4?s=100" width="100px;" alt="Larry Botha"/><br /><sub><b>Larry Botha</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=larrybotha" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3Alarrybotha" title="Bug reports">🐛</a></td>
+      <td align="center"><a href="https://github.com/nikalun"><img src="https://avatars3.githubusercontent.com/u/13102962?v=4?s=100" width="100px;" alt="Nikolay Lukinykh"/><br /><sub><b>Nikolay Lukinykh</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=nikalun" title="Code">💻</a> <a href="#ideas-nikalun" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3Anikalun" title="Bug reports">🐛</a></td>
+      <td align="center"><a href="https://github.com/Mvbraathen"><img src="https://avatars0.githubusercontent.com/u/16756739?v=4?s=100" width="100px;" alt="Marius Bråthen"/><br /><sub><b>Marius Bråthen</b></sub></a><br /><a href="#security-Mvbraathen" title="Security">🛡️</a></td>
+      <td align="center"><a href="https://github.com/xesjkeee"><img src="https://avatars2.githubusercontent.com/u/17751886?v=4?s=100" width="100px;" alt="Evgeny Vlasov"/><br /><sub><b>Evgeny Vlasov</b></sub></a><br /><a href="#ideas-xesjkeee" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center"><a href="https://github.com/kel666"><img src="https://avatars1.githubusercontent.com/u/2040661?v=4?s=100" width="100px;" alt="Fabio"/><br /><sub><b>Fabio</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3Akel666" title="Bug reports">🐛</a> <a href="https://github.com/acacode/swagger-typescript-api/commits?author=kel666" title="Code">💻</a></td>
+      <td align="center"><a href="https://github.com/Fabiencdp"><img src="https://avatars.githubusercontent.com/u/6182473?v=4?s=100" width="100px;" alt="Fabien"/><br /><sub><b>Fabien</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3AFabiencdp" title="Bug reports">🐛</a></td>
+      <td align="center"><a href="https://about.me/julienrousseau"><img src="https://avatars.githubusercontent.com/u/3296671?v=4?s=100" width="100px;" alt="Rousseau Julien"/><br /><sub><b>Rousseau Julien</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3ARoXuS" title="Bug reports">🐛</a></td>
+    </tr>
+    <tr>
+      <td align="center"><a href="http://sebastianarias.dev"><img src="https://avatars.githubusercontent.com/u/9751266?v=4?s=100" width="100px;" alt="Sebastián Arias"/><br /><sub><b>Sebastián Arias</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3ALarox" title="Bug reports">🐛</a></td>
+      <td align="center"><a href="https://github.com/Styn"><img src="https://avatars.githubusercontent.com/u/6705137?v=4?s=100" width="100px;" alt="Stijn Lammens"/><br /><sub><b>Stijn Lammens</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3AStyn" title="Bug reports">🐛</a> <a href="https://github.com/acacode/swagger-typescript-api/commits?author=Styn" title="Code">💻</a></td>
+      <td align="center"><a href="http://emilecantin.com"><img src="https://avatars.githubusercontent.com/u/885486?v=4?s=100" width="100px;" alt="Emile Cantin"/><br /><sub><b>Emile Cantin</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3Aemilecantin" title="Bug reports">🐛</a> <a href="https://github.com/acacode/swagger-typescript-api/commits?author=emilecantin" title="Code">💻</a></td>
+      <td align="center"><a href="https://github.com/armsnyder"><img src="https://avatars.githubusercontent.com/u/9969202?v=4?s=100" width="100px;" alt="Adam Snyder"/><br /><sub><b>Adam Snyder</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=armsnyder" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3Aarmsnyder" title="Bug reports">🐛</a></td>
+      <td align="center"><a href="https://github.com/jnpoyser"><img src="https://avatars.githubusercontent.com/u/7920428?v=4?s=100" width="100px;" alt="James Poyser"/><br /><sub><b>James Poyser</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=jnpoyser" title="Code">💻</a> <a href="#ideas-jnpoyser" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center"><a href="http://ru.linkedin.com/in/lisikhin"><img src="https://avatars.githubusercontent.com/u/475367?v=4?s=100" width="100px;" alt="Alexey"/><br /><sub><b>Alexey</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3ANihisil" title="Bug reports">🐛</a></td>
+      <td align="center"><a href="http://imaniu.com"><img src="https://avatars.githubusercontent.com/u/50100681?v=4?s=100" width="100px;" alt="江麻妞"/><br /><sub><b>江麻妞</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=jiangmaniu" title="Code">💻</a></td>
+    </tr>
+    <tr>
+      <td align="center"><a href="https://kspr.dev"><img src="https://avatars.githubusercontent.com/u/5294519?v=4?s=100" width="100px;" alt="Kasper Moskwiak"/><br /><sub><b>Kasper Moskwiak</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=kmoskwiak" title="Code">💻</a> <a href="#ideas-kmoskwiak" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center"><a href="https://github.com/baggoedw"><img src="https://avatars.githubusercontent.com/u/92381702?v=4?s=100" width="100px;" alt="baggoedw"/><br /><sub><b>baggoedw</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=baggoedw" title="Code">💻</a></td>
+      <td align="center"><a href="https://marcusdunn.github.io"><img src="https://avatars.githubusercontent.com/u/51931484?v=4?s=100" width="100px;" alt="Marcus Dunn"/><br /><sub><b>Marcus Dunn</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=MarcusDunn" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3AMarcusDunn" title="Bug reports">🐛</a></td>
+      <td align="center"><a href="https://www.danielplayfaircal.com/"><img src="https://avatars.githubusercontent.com/u/1217649?v=4?s=100" width="100px;" alt="Daniel Playfair Cal"/><br /><sub><b>Daniel Playfair Cal</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=hedgepigdaniel" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3Ahedgepigdaniel" title="Bug reports">🐛</a></td>
+      <td align="center"><a href="https://www.linkedin.com/in/patrick-shaw/"><img src="https://avatars.githubusercontent.com/u/5153619?v=4?s=100" width="100px;" alt="Patrick Shaw"/><br /><sub><b>Patrick Shaw</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/pulls?q=is%3Apr+reviewed-by%3APatrickShaw" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center"><a href="https://www.linkedin.com/in/jinkwon-lee"><img src="https://avatars.githubusercontent.com/u/1798916?v=4?s=100" width="100px;" alt="JK"/><br /><sub><b>JK</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=jinkwon" title="Code">💻</a></td>
+      <td align="center"><a href="https://github.com/RoCat"><img src="https://avatars.githubusercontent.com/u/3562317?v=4?s=100" width="100px;" alt="RoCat"/><br /><sub><b>RoCat</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=RoCat" title="Code">💻</a> <a href="#ideas-RoCat" title="Ideas, Planning, & Feedback">🤔</a> <a href="#design-RoCat" title="Design">🎨</a></td>
+    </tr>
+    <tr>
+      <td align="center"><a href="https://github.com/ApacheEx"><img src="https://avatars.githubusercontent.com/u/1918108?v=4?s=100" width="100px;" alt="Oleg Kuzava"/><br /><sub><b>Oleg Kuzava</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=ApacheEx" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3AApacheEx" title="Bug reports">🐛</a></td>
+      <td align="center"><a href="http://nikz.se"><img src="https://avatars.githubusercontent.com/u/7352072?v=4?s=100" width="100px;" alt="Niklas Frank"/><br /><sub><b>Niklas Frank</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=nksfrank" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3Anksfrank" title="Bug reports">🐛</a></td>
+      <td align="center"><a href="https://quentinbrunet.com"><img src="https://avatars.githubusercontent.com/u/20137632?v=4?s=100" width="100px;" alt="Quentin Brunet"/><br /><sub><b>Quentin Brunet</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=qboot" title="Code">💻</a></td>
+    </tr>
+  </tbody>
 </table>
 
 <!-- markdownlint-restore -->

package/index.d.ts

@@ -123,6 +123,10 @@ interface GenerateApiParamsBase {
    *  authorization token
    */
   authorizationToken?: string;
+  /**
+   * generate readonly properties (default: false)
+   */
+  addReadonly?: boolean;
 }
 
 interface GenerateApiParamsFromPath extends GenerateApiParamsBase {

package/index.js

@@ -1,115 +1,115 @@
-#!/usr/bin/env node
-
-// Copyright (c) 2019-present acacode
-// Node module: swagger-typescript-api
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
-// Repository https://github.com/acacode/swagger-typescript-api
-
-const { Command } = require("commander");
-const { resolve } = require("path");
-const { generateApi } = require("./src");
-const { version, name: packageName } = require("./package.json");
-const { TS_KEYWORDS, HTTP_CLIENT } = require("./src/constants");
-
-const program = new Command(packageName);
-
-const options = program
-  .alias("sta")
-  .version(version, "-v, --version", "output the current version")
-  .description("Generate api via swagger scheme.\nSupports OA 3.0, 2.0, JSON, yaml.")
-  .requiredOption("-p, --path <string>", "path/url to swagger scheme")
-  .option("-o, --output <string>", "output path of typescript api file", "./")
-  .option("-n, --name <string>", "name of output typescript api file", "Api.ts")
-  .option("-t, --templates <string>", "path to folder containing templates")
-  .option(
-    "-d, --default-as-success",
-    'use "default" response status code as success response too.\n' +
-      'some swagger schemas use "default" response status code as success response type by default.',
-    false,
-  )
-  .option(
-    "-r, --responses",
-    "generate additional information about request responses\n" + "also add typings for bad responses",
-    false,
-  )
-  .option("--union-enums", 'generate all "enum" types as union types (T1 | T2 | TN)', false)
-  .option("--add-readonly", "generate readonly properties", false)
-  .option("--route-types", "generate type definitions for API routes", false)
-  .option("--no-client", "do not generate an API class", true)
-  .option("--enum-names-as-values", "use values in 'x-enumNames' as enum values (not only as keys)", false)
-  .option(
-    "--extract-request-params",
-    "extract request params to data contract (Also combine path params and query params into one object)",
-    false,
-  )
-  .option("--extract-request-body", "extract request body type to data contract", false)
-  .option("--extract-response-body", "extract response body type to data contract", false)
-  .option("--extract-response-error", "extract response error type to data contract", false)
-  .option("--modular", "generate separated files for http client, data contracts, and routes", false)
-  .option("--js", "generate js api module with declaration file", false)
-  .option(
-    "--module-name-index <number>",
-    "determines which path index should be used for routes separation (example: GET:/fruites/getFruit -> index:0 -> moduleName -> fruites)",
-    0,
-  )
-  .option("--module-name-first-tag", "splits routes based on the first tag", false)
-  .option("--disableStrictSSL", "disabled strict SSL", false)
-  .option("--disableProxy", "disabled proxy", false)
-  .option("--axios", "generate axios http client", false)
-  .option("--unwrap-response-data", "unwrap the data item from the response", false)
-  .option("--disable-throw-on-error", "Do not throw an error when response.ok is not true", false)
-  .option("--single-http-client", "Ability to send HttpClient instance to Api constructor", false)
-  .option("--silent", "Output only errors to console", false)
-  .option("--default-response <type>", "default type for empty response schema", TS_KEYWORDS.VOID)
-  .option("--type-prefix <string>", "data contract name prefix", "")
-  .option("--type-suffix <string>", "data contract name suffix", "")
-  .option("--clean-output", "clean output folder before generate api. WARNING: May cause data loss", false)
-  .option("--api-class-name <string>", "name of the api class")
-  .option("--patch", "fix up small errors in the swagger source definition", false)
-  .option("--debug", "additional information about processes inside this tool", false)
-  .parse(process.argv)
-  .opts();
-
-generateApi({
-  name: options.name,
-  url: options.path,
-  generateRouteTypes: options.routeTypes,
-  generateClient: !!(options.axios || options.client),
-  httpClientType: options.axios ? HTTP_CLIENT.AXIOS : HTTP_CLIENT.FETCH,
-  defaultResponseAsSuccess: options.defaultAsSuccess,
-  defaultResponseType: options.defaultResponse,
-  unwrapResponseData: options.unwrapResponseData,
-  disableThrowOnError: options.disableThrowOnError,
-  sortTypes: options.sortTypes,
-  generateUnionEnums: options.unionEnums,
-  addReadonly: options.addReadonly,
-  generateResponses: options.responses,
-  extractRequestParams: !!options.extractRequestParams,
-  extractRequestBody: !!options.extractRequestBody,
-  extractResponseBody: !!options.extractResponseBody,
-  extractResponseError: !!options.extractResponseError,
-  input: resolve(process.cwd(), options.path),
-  output: resolve(process.cwd(), options.output || "."),
-  templates: options.templates,
-  modular: !!options.modular,
-  toJS: !!options.js,
-  enumNamesAsValues: options.enumNamesAsValues,
-  moduleNameIndex: +(options.moduleNameIndex || 0),
-  moduleNameFirstTag: options.moduleNameFirstTag,
-  disableStrictSSL: !!options.disableStrictSSL,
-  disableProxy: !!options.disableProxy,
-  singleHttpClient: !!options.singleHttpClient,
-  cleanOutput: !!options.cleanOutput,
-  silent: !!options.silent,
-  typePrefix: options.typePrefix,
-  typeSuffix: options.typeSuffix,
-  patch: !!options.patch,
-  apiClassName: options.apiClassName,
-  debug: options.debug,
-}).catch((err) => {
-  // NOTE collect all errors on top level and shows to users in any case
-  console.error(err);
-
-  process.exit(1);
-});
+#!/usr/bin/env node
+
+// Copyright (c) 2019-present acacode
+// Node module: swagger-typescript-api
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+// Repository https://github.com/acacode/swagger-typescript-api
+
+const { Command } = require("commander");
+const { resolve } = require("path");
+const { generateApi } = require("./src");
+const { version, name: packageName } = require("./package.json");
+const { TS_KEYWORDS, HTTP_CLIENT } = require("./src/constants");
+
+const program = new Command(packageName);
+
+const options = program
+  .alias("sta")
+  .version(version, "-v, --version", "output the current version")
+  .description("Generate api via swagger scheme.\nSupports OA 3.0, 2.0, JSON, yaml.")
+  .requiredOption("-p, --path <string>", "path/url to swagger scheme")
+  .option("-o, --output <string>", "output path of typescript api file", "./")
+  .option("-n, --name <string>", "name of output typescript api file", "Api.ts")
+  .option("-t, --templates <string>", "path to folder containing templates")
+  .option(
+    "-d, --default-as-success",
+    'use "default" response status code as success response too.\n' +
+      'some swagger schemas use "default" response status code as success response type by default.',
+    false,
+  )
+  .option(
+    "-r, --responses",
+    "generate additional information about request responses\n" + "also add typings for bad responses",
+    false,
+  )
+  .option("--union-enums", 'generate all "enum" types as union types (T1 | T2 | TN)', false)
+  .option("--add-readonly", "generate readonly properties", false)
+  .option("--route-types", "generate type definitions for API routes", false)
+  .option("--no-client", "do not generate an API class", true)
+  .option("--enum-names-as-values", "use values in 'x-enumNames' as enum values (not only as keys)", false)
+  .option(
+    "--extract-request-params",
+    "extract request params to data contract (Also combine path params and query params into one object)",
+    false,
+  )
+  .option("--extract-request-body", "extract request body type to data contract", false)
+  .option("--extract-response-body", "extract response body type to data contract", false)
+  .option("--extract-response-error", "extract response error type to data contract", false)
+  .option("--modular", "generate separated files for http client, data contracts, and routes", false)
+  .option("--js", "generate js api module with declaration file", false)
+  .option(
+    "--module-name-index <number>",
+    "determines which path index should be used for routes separation (example: GET:/fruites/getFruit -> index:0 -> moduleName -> fruites)",
+    0,
+  )
+  .option("--module-name-first-tag", "splits routes based on the first tag", false)
+  .option("--disableStrictSSL", "disabled strict SSL", false)
+  .option("--disableProxy", "disabled proxy", false)
+  .option("--axios", "generate axios http client", false)
+  .option("--unwrap-response-data", "unwrap the data item from the response", false)
+  .option("--disable-throw-on-error", "Do not throw an error when response.ok is not true", false)
+  .option("--single-http-client", "Ability to send HttpClient instance to Api constructor", false)
+  .option("--silent", "Output only errors to console", false)
+  .option("--default-response <type>", "default type for empty response schema", TS_KEYWORDS.VOID)
+  .option("--type-prefix <string>", "data contract name prefix", "")
+  .option("--type-suffix <string>", "data contract name suffix", "")
+  .option("--clean-output", "clean output folder before generate api. WARNING: May cause data loss", false)
+  .option("--api-class-name <string>", "name of the api class")
+  .option("--patch", "fix up small errors in the swagger source definition", false)
+  .option("--debug", "additional information about processes inside this tool", false)
+  .parse(process.argv)
+  .opts();
+
+generateApi({
+  name: options.name,
+  url: options.path,
+  generateRouteTypes: options.routeTypes,
+  generateClient: !!(options.axios || options.client),
+  httpClientType: options.axios ? HTTP_CLIENT.AXIOS : HTTP_CLIENT.FETCH,
+  defaultResponseAsSuccess: options.defaultAsSuccess,
+  defaultResponseType: options.defaultResponse,
+  unwrapResponseData: options.unwrapResponseData,
+  disableThrowOnError: options.disableThrowOnError,
+  sortTypes: options.sortTypes,
+  generateUnionEnums: options.unionEnums,
+  addReadonly: options.addReadonly,
+  generateResponses: options.responses,
+  extractRequestParams: !!options.extractRequestParams,
+  extractRequestBody: !!options.extractRequestBody,
+  extractResponseBody: !!options.extractResponseBody,
+  extractResponseError: !!options.extractResponseError,
+  input: resolve(process.cwd(), options.path),
+  output: resolve(process.cwd(), options.output || "."),
+  templates: options.templates,
+  modular: !!options.modular,
+  toJS: !!options.js,
+  enumNamesAsValues: options.enumNamesAsValues,
+  moduleNameIndex: +(options.moduleNameIndex || 0),
+  moduleNameFirstTag: options.moduleNameFirstTag,
+  disableStrictSSL: !!options.disableStrictSSL,
+  disableProxy: !!options.disableProxy,
+  singleHttpClient: !!options.singleHttpClient,
+  cleanOutput: !!options.cleanOutput,
+  silent: !!options.silent,
+  typePrefix: options.typePrefix,
+  typeSuffix: options.typeSuffix,
+  patch: !!options.patch,
+  apiClassName: options.apiClassName,
+  debug: options.debug,
+}).catch((err) => {
+  // NOTE collect all errors on top level and shows to users in any case
+  console.error(err);
+
+  process.exit(1);
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "10.0.2",
+  "version": "10.0.3",
   "description": "Generate typescript/javascript api from swagger schema",
   "scripts": {
     "cli:json": "node index.js -r -d -p ./swagger-test-cli.json -n swagger-test-cli.ts",
@@ -10,8 +10,10 @@
     "contributors": "all-contributors generate",
     "cli:help": "node index.js -h",
     "test-all": "node --unhandled-rejections=strict ./scriptsRunner.js generate validate test:*",
+    "test-all(update-snapshots)": "cross-env UPDATE_SNAPSHOTS=true node --unhandled-rejections=strict ./scriptsRunner.js generate validate test:*",
     "test-all-extended": "node --unhandled-rejections=strict ./scriptsRunner.js generate-extended validate generate validate test:*",
     "test-specific": "node ./scriptsRunner.js generate validate test:*",
+    "test-specific-only": "node ./scriptsRunner.js test:*",
     "prepare": "npm run test-all-extended",
     "generate": "node tests/generate.js",
     "generate-extended": "node tests/generate-extended.js",
@@ -52,6 +54,7 @@
   "typings": "./index.d.ts",
   "main": "src/index.js",
   "devDependencies": {
+    "cross-env": "^7.0.3",
     "@types/axios": "^0.14.0",
     "@types/lodash": "^4.14.182",
     "@types/node": "^15.0.2",

package/src/apiConfig.js

@@ -1,30 +1,30 @@
-const _ = require("lodash");
-
-const createApiConfig = (swaggerSchema) => {
-  const { info, servers, host, basePath, externalDocs, tags } = swaggerSchema;
-  const server = (servers && servers[0]) || { url: "" };
-  const { title = "No title", version, description: schemaDescription = "" } = info || {};
-  const { url: serverUrl } = server;
-
-  return {
-    info: info || {},
-    servers: servers || [],
-    basePath,
-    host,
-    externalDocs: _.merge(
-      {
-        url: "",
-        description: "",
-      },
-      externalDocs,
-    ),
-    tags: _.compact(tags),
-    baseUrl: serverUrl,
-    title,
-    version,
-  };
-};
-
-module.exports = {
-  createApiConfig,
-};
+const _ = require("lodash");
+
+const createApiConfig = (swaggerSchema) => {
+  const { info, servers, host, basePath, externalDocs, tags } = swaggerSchema;
+  const server = (servers && servers[0]) || { url: "" };
+  const { title = "No title", version, description: schemaDescription = "" } = info || {};
+  const { url: serverUrl } = server;
+
+  return {
+    info: info || {},
+    servers: servers || [],
+    basePath,
+    host,
+    externalDocs: _.merge(
+      {
+        url: "",
+        description: "",
+      },
+      externalDocs,
+    ),
+    tags: _.compact(tags),
+    baseUrl: serverUrl,
+    title,
+    version,
+  };
+};
+
+module.exports = {
+  createApiConfig,
+};

package/src/common.js

@@ -1,28 +1,28 @@
-const _ = require("lodash");
-
-module.exports = {
-  formatDescription: (description, inline) => {
-    if (!description) return "";
-
-    let prettified = description;
-
-    prettified = _.replace(prettified, /\*\//g, "*/");
-
-    const hasMultipleLines = _.includes(prettified, "\n");
-
-    if (!hasMultipleLines) return prettified;
-
-    if (inline) {
-      return _(prettified)
-        .split(/\n/g)
-        .map((part) => _.trim(part))
-        .compact()
-        .join(" ")
-        .valueOf();
-    }
-
-    return _.replace(prettified, /\n$/g, "");
-  },
-  internalCase: (value) => _.camelCase(_.lowerCase(value)),
-  classNameCase: (value) => _.upperFirst(_.camelCase(value)),
-};
+const _ = require("lodash");
+
+module.exports = {
+  formatDescription: (description, inline) => {
+    if (!description) return "";
+
+    let prettified = description;
+
+    prettified = _.replace(prettified, /\*\//g, "*/");
+
+    const hasMultipleLines = _.includes(prettified, "\n");
+
+    if (!hasMultipleLines) return prettified;
+
+    if (inline) {
+      return _(prettified)
+        .split(/\n/g)
+        .map((part) => _.trim(part))
+        .compact()
+        .join(" ")
+        .valueOf();
+    }
+
+    return _.replace(prettified, /\n$/g, "");
+  },
+  internalCase: (value) => _.camelCase(_.lowerCase(value)),
+  classNameCase: (value) => _.upperFirst(_.camelCase(value)),
+};

package/src/config.js

@@ -1,7 +1,9 @@
 const { HTTP_CLIENT, TS_KEYWORDS, PRETTIER_OPTIONS } = require("./constants");
 const { NameResolver } = require("./utils/resolveName");
+const packageJson = require("../package.json");
 
 const config = {
+  version: packageJson.version,
   /** CLI flag */
   templates: "../templates/default",
   /** CLI flag */

package/src/filePrefix.js

@@ -1,14 +1,14 @@
-module.exports = {
-  filePrefix: `/* eslint-disable */
-/* tslint:disable */
-/*
- * ---------------------------------------------------------------
- * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
- * ##                                                           ##
- * ## AUTHOR: acacode                                           ##
- * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
- * ---------------------------------------------------------------
- */
-
-`,
-};
+module.exports = {
+  filePrefix: `/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+`,
+};