Skip to content

Commit e39fa4e

Browse files
scarf005scarf005
committed
update docs for typescript-axios-slim
1 parent 111173a commit e39fa4e

2 files changed

Lines changed: 304 additions & 0 deletions

File tree

‎docs/generators.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ The following generators are available:
7575
* [typescript-angular](generators/typescript-angular.md)
7676
* [typescript-aurelia](generators/typescript-aurelia.md)
7777
* [typescript-axios](generators/typescript-axios.md)
78+
* [typescript-axios-slim](generators/typescript-axios-slim.md)
7879
* [typescript-fetch](generators/typescript-fetch.md)
7980
* [typescript-inversify](generators/typescript-inversify.md)
8081
* [typescript-jquery](generators/typescript-jquery.md)

‎docs/generators/typescript-axios-slim.md‎

Lines changed: 303 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,303 @@
1+
---
2+
title: Documentation for the typescript-axios-slim Generator
3+
---
4+
5+
## METADATA
6+
7+
| Property | Value | Notes |
8+
| -------- | ----- | ----- |
9+
| generator name | typescript-axios-slim | pass this to the generate command after -g |
10+
| generator stability | STABLE | |
11+
| generator type | CLIENT | |
12+
| generator language | Typescript | |
13+
| generator default templating engine | mustache | |
14+
| helpTxt | Generates a TypeScript client library using axios (slim direct API style with valibot validation). | |
15+
16+
## CONFIG OPTIONS
17+
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
18+
19+
| Option | Description | Values | Default |
20+
| ------ | ----------- | ------ | ------- |
21+
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
22+
|apiPackage|package for generated api classes| |null|
23+
|axiosVersion|Use this property to override the axios version in package.json| |^1.13.5|
24+
|disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|<dl><dt>**false**</dt><dd>The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.</dd><dt>**true**</dt><dd>Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.</dd></dl>|true|
25+
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
26+
|enumNameSuffix|Suffix that will be appended to all enum names.| |Enum|
27+
|enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |PascalCase|
28+
|enumPropertyNamingReplaceSpecialChar|Set to true to replace '-' and '+' symbols with 'minus_' and 'plus_' in enum of type string| |false|
29+
|enumUnknownDefaultCase|If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.|<dl><dt>**false**</dt><dd>No changes to the enum's are made, this is the default option.</dd><dt>**true**</dt><dd>With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.</dd></dl>|false|
30+
|importFileExtension|File extension to use with relative imports. Set it to '.js' or '.mjs' when using [ESM](https://nodejs.org/api/esm.html).| ||
31+
|legacyDiscriminatorBehavior|Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).|<dl><dt>**true**</dt><dd>The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.</dd><dt>**false**</dt><dd>The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.</dd></dl>|true|
32+
|licenseName|The name of the license| |Unlicense|
33+
|modelPackage|package for generated models| |null|
34+
|npmName|The name under which you want to publish generated npm package. Required to generate a full package| |null|
35+
|npmRepository|Use this property to set an url of your private npmRepo in the package.json| |null|
36+
|npmVersion|The version of your npm package. If not provided, using the version from the OpenAPI specification file.| |1.0.0|
37+
|nullSafeAdditionalProps|Set to make additional properties types declare that their indexer may return undefined| |false|
38+
|paramNaming|Naming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase|
39+
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
40+
|snapshot|When setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm| |false|
41+
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
42+
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
43+
|stringEnums|Generate string enums instead of objects for enum values.| |false|
44+
|supportsES6|Generate code that conforms to ES6.| |false|
45+
|useSingleRequestParameter|Setting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter.| |false|
46+
|useSquareBracketsInArrayNames|Setting this property to true will add brackets to array attribute names, e.g. my_values[].| |false|
47+
|withAWSV4Signature|whether to include AWS v4 signature support| |false|
48+
|withInterfaces|Setting this property to true will generate interfaces next to the default class implementations.| |false|
49+
|withNodeImports|Setting this property to true adds imports for NodeJS| |false|
50+
|withSeparateModelsAndApi|Put the model and api in separate folders and in separate classes. This requires in addition a value for 'apiPackage' and 'modelPackage'| |false|
51+
|withoutPrefixEnums|Don't prefix enum names with class names| |false|
52+
53+
## IMPORT MAPPING
54+
55+
| Type/Alias | Imports |
56+
| ---------- | ------- |
57+
58+
59+
## INSTANTIATION TYPES
60+
61+
| Type/Alias | Instantiated By |
62+
| ---------- | --------------- |
63+
|array|Array|
64+
65+
66+
## LANGUAGE PRIMITIVES
67+
68+
<ul class="column-ul">
69+
<li>Array</li>
70+
<li>Awaited</li>
71+
<li>Boolean</li>
72+
<li>Capitalize</li>
73+
<li>ConstructorParameters</li>
74+
<li>Date</li>
75+
<li>Double</li>
76+
<li>Error</li>
77+
<li>Exclude</li>
78+
<li>Extract</li>
79+
<li>File</li>
80+
<li>Float</li>
81+
<li>InstanceType</li>
82+
<li>Integer</li>
83+
<li>Long</li>
84+
<li>Lowercase</li>
85+
<li>Map</li>
86+
<li>NoInfer</li>
87+
<li>NonNullable</li>
88+
<li>Object</li>
89+
<li>Omit</li>
90+
<li>OmitThisParameter</li>
91+
<li>Parameters</li>
92+
<li>Partial</li>
93+
<li>Pick</li>
94+
<li>Readonly</li>
95+
<li>ReadonlyArray</li>
96+
<li>Record</li>
97+
<li>Required</li>
98+
<li>ReturnType</li>
99+
<li>Set</li>
100+
<li>String</li>
101+
<li>ThisParameterType</li>
102+
<li>ThisType</li>
103+
<li>Uncapitalize</li>
104+
<li>Uppercase</li>
105+
<li>any</li>
106+
<li>boolean</li>
107+
<li>number</li>
108+
<li>object</li>
109+
<li>string</li>
110+
</ul>
111+
112+
## RESERVED WORDS
113+
114+
<ul class="column-ul">
115+
<li>abstract</li>
116+
<li>await</li>
117+
<li>boolean</li>
118+
<li>break</li>
119+
<li>byte</li>
120+
<li>case</li>
121+
<li>catch</li>
122+
<li>char</li>
123+
<li>class</li>
124+
<li>const</li>
125+
<li>continue</li>
126+
<li>debugger</li>
127+
<li>default</li>
128+
<li>delete</li>
129+
<li>do</li>
130+
<li>double</li>
131+
<li>else</li>
132+
<li>enum</li>
133+
<li>export</li>
134+
<li>extends</li>
135+
<li>false</li>
136+
<li>final</li>
137+
<li>finally</li>
138+
<li>float</li>
139+
<li>for</li>
140+
<li>formParams</li>
141+
<li>function</li>
142+
<li>goto</li>
143+
<li>headerParams</li>
144+
<li>if</li>
145+
<li>implements</li>
146+
<li>import</li>
147+
<li>in</li>
148+
<li>instanceof</li>
149+
<li>int</li>
150+
<li>interface</li>
151+
<li>let</li>
152+
<li>long</li>
153+
<li>native</li>
154+
<li>new</li>
155+
<li>null</li>
156+
<li>options</li>
157+
<li>package</li>
158+
<li>private</li>
159+
<li>protected</li>
160+
<li>public</li>
161+
<li>queryParameters</li>
162+
<li>requestOptions</li>
163+
<li>return</li>
164+
<li>short</li>
165+
<li>static</li>
166+
<li>super</li>
167+
<li>switch</li>
168+
<li>synchronized</li>
169+
<li>this</li>
170+
<li>throw</li>
171+
<li>transient</li>
172+
<li>true</li>
173+
<li>try</li>
174+
<li>typeof</li>
175+
<li>useFormData</li>
176+
<li>var</li>
177+
<li>varLocalDeferred</li>
178+
<li>varLocalPath</li>
179+
<li>void</li>
180+
<li>volatile</li>
181+
<li>while</li>
182+
<li>with</li>
183+
<li>yield</li>
184+
</ul>
185+
186+
## FEATURE SET
187+
188+
189+
### Client Modification Feature
190+
| Name | Supported | Defined By |
191+
| ---- | --------- | ---------- |
192+
|BasePath|✓|ToolingExtension
193+
|Authorizations|✗|ToolingExtension
194+
|UserAgent|✗|ToolingExtension
195+
|MockServer|✗|ToolingExtension
196+
197+
### Data Type Feature
198+
| Name | Supported | Defined By |
199+
| ---- | --------- | ---------- |
200+
|Custom|✗|OAS2,OAS3
201+
|Int32|✓|OAS2,OAS3
202+
|Int64|✓|OAS2,OAS3
203+
|Float|✓|OAS2,OAS3
204+
|Double|✓|OAS2,OAS3
205+
|Decimal|✓|ToolingExtension
206+
|String|✓|OAS2,OAS3
207+
|Byte|✓|OAS2,OAS3
208+
|Binary|✓|OAS2,OAS3
209+
|Boolean|✓|OAS2,OAS3
210+
|Date|✓|OAS2,OAS3
211+
|DateTime|✓|OAS2,OAS3
212+
|Password|✓|OAS2,OAS3
213+
|File|✓|OAS2
214+
|Uuid|✗|
215+
|Array|✓|OAS2,OAS3
216+
|Null|✗|OAS3
217+
|AnyType|✗|OAS2,OAS3
218+
|Object|✓|OAS2,OAS3
219+
|Maps|✓|ToolingExtension
220+
|CollectionFormat|✓|OAS2
221+
|CollectionFormatMulti|✓|OAS2
222+
|Enum|✓|OAS2,OAS3
223+
|ArrayOfEnum|✓|ToolingExtension
224+
|ArrayOfModel|✓|ToolingExtension
225+
|ArrayOfCollectionOfPrimitives|✓|ToolingExtension
226+
|ArrayOfCollectionOfModel|✓|ToolingExtension
227+
|ArrayOfCollectionOfEnum|✓|ToolingExtension
228+
|MapOfEnum|✓|ToolingExtension
229+
|MapOfModel|✓|ToolingExtension
230+
|MapOfCollectionOfPrimitives|✓|ToolingExtension
231+
|MapOfCollectionOfModel|✓|ToolingExtension
232+
|MapOfCollectionOfEnum|✓|ToolingExtension
233+
234+
### Documentation Feature
235+
| Name | Supported | Defined By |
236+
| ---- | --------- | ---------- |
237+
|Readme|✓|ToolingExtension
238+
|Model|✓|ToolingExtension
239+
|Api|✓|ToolingExtension
240+
241+
### Global Feature
242+
| Name | Supported | Defined By |
243+
| ---- | --------- | ---------- |
244+
|Host|✓|OAS2,OAS3
245+
|BasePath|✓|OAS2,OAS3
246+
|Info|✓|OAS2,OAS3
247+
|Schemes|✗|OAS2,OAS3
248+
|PartialSchemes|✓|OAS2,OAS3
249+
|Consumes|✓|OAS2
250+
|Produces|✓|OAS2
251+
|ExternalDocumentation|✓|OAS2,OAS3
252+
|Examples|✓|OAS2,OAS3
253+
|XMLStructureDefinitions|✗|OAS2,OAS3
254+
|MultiServer|✗|OAS3
255+
|ParameterizedServer|✗|OAS3
256+
|ParameterStyling|✗|OAS3
257+
|Callbacks|✗|OAS3
258+
|LinkObjects|✗|OAS3
259+
260+
### Parameter Feature
261+
| Name | Supported | Defined By |
262+
| ---- | --------- | ---------- |
263+
|Path|✓|OAS2,OAS3
264+
|Query|✓|OAS2,OAS3
265+
|Header|✓|OAS2,OAS3
266+
|Body|✓|OAS2
267+
|FormUnencoded|✓|OAS2
268+
|FormMultipart|✓|OAS2
269+
|Cookie|✓|OAS3
270+
271+
### Schema Support Feature
272+
| Name | Supported | Defined By |
273+
| ---- | --------- | ---------- |
274+
|Simple|✓|OAS2,OAS3
275+
|Composite|✓|OAS2,OAS3
276+
|Polymorphism|✓|OAS2,OAS3
277+
|Union|✗|OAS3
278+
|allOf|✗|OAS2,OAS3
279+
|anyOf|✗|OAS3
280+
|oneOf|✗|OAS3
281+
|not|✗|OAS3
282+
283+
### Security Feature
284+
| Name | Supported | Defined By |
285+
| ---- | --------- | ---------- |
286+
|BasicAuth|✓|OAS2,OAS3
287+
|ApiKey|✓|OAS2,OAS3
288+
|OpenIDConnect|✗|OAS3
289+
|BearerToken|✓|OAS3
290+
|OAuth2_Implicit|✓|OAS2,OAS3
291+
|OAuth2_Password|✗|OAS2,OAS3
292+
|OAuth2_ClientCredentials|✗|OAS2,OAS3
293+
|OAuth2_AuthorizationCode|✗|OAS2,OAS3
294+
|SignatureAuth|✗|OAS3
295+
|AWSV4Signature|✓|ToolingExtension
296+
297+
### Wire Format Feature
298+
| Name | Supported | Defined By |
299+
| ---- | --------- | ---------- |
300+
|JSON|✓|OAS2,OAS3
301+
|XML|✓|OAS2,OAS3
302+
|PROTOBUF|✗|ToolingExtension
303+
|Custom|✗|OAS2,OAS3

0 commit comments

Comments
 (0)