1 | |Property|Parent|Default/Example|Description|
|
2 | |---|---|---|---|
|
3 | |apis||||
|
4 | |models||||
|
5 | |supportingFiles||||
|
6 | |modelTests||||
|
7 | |modelDocs||||
|
8 | |apiTests||||
|
9 | |apiDocs||||
|
10 | |apiPackage||IO.OpenAPI|package for generated api classes|
|
11 | |modelPackage||IO.OpenAPI|package for generated models|
|
12 | |templateDir||./templates/nodejs||
|
13 | |allowUnicodeIdentifiers||false|boolean, toggles whether unicode identifiers are allowed in names or not, default is false|
|
14 | |invokerPackage||IO.OpenAPI|root package for generated code|
|
15 | |phpInvokerPackage||IO.OpenAPI|root package for generated php code|
|
16 | |perlModuleName||IO.OpenAPI|root module name for generated perl code|
|
17 | |pythonPackageName||IO.OpenAPI|package name for generated python code|
|
18 | |groupId|||groupId in generated pom.xml|
|
19 | |artifactId|||artifactId in generated pom.xml|
|
20 | |artifactVersion|||artifact version in generated pom.xml|
|
21 | |artifactUrl|||artifact URL in generated pom.xml|
|
22 | |scmConnection|||SCM connection in generated pom.xml|
|
23 | |scmDeveloperConnection|||SCM developer connection in generated pom.xml|
|
24 | |scmUrl|||SCM URL in generated pom.xml|
|
25 | |developerName|||developer name in generated pom.xml|
|
26 | |developerEmail|||developer email in generated pom.xml|
|
27 | |developerOrganization|||developer organization in generated pom.xml|
|
28 | |developerOrganizationUrl|||developer organization URL in generated pom.xml|
|
29 | |licenseName||Unlicense|The name of the license|
|
30 | |licenseUrl||http://www.apache.org/licenses/LICENSE-2.0.html|The URL of the license|
|
31 | |sourceFolder||./out/nodejs|source folder for generated code|
|
32 | |implFolder||./out/nodejs|folder for generated implementation code|
|
33 | |localVariablePrefix|||prefix for generated code members and local variables|
|
34 | |serializableModel||true|boolean - toggle "implements Serializable" for generated models|
|
35 | |bigDecimalAsString||false|Treat BigDecimal values as Strings to avoid precision loss.|
|
36 | |library|||library template (sub-template)|
|
37 | |sortParamsByRequiredFlag||true|Sort method arguments to place required parameters before optional parameters.|
|
38 | |useDateTimeOffset||0|Use DateTimeOffset to model date-time properties|
|
39 | |ensureUniqueParams||false|Whether to ensure parameter names are unique in an operation (rename parameters that are not).|
|
40 | |projectName||swagger_petstore||
|
41 | |packageName||IO.OpenAPI||
|
42 | |packageVersion||1.0.0||
|
43 | |packageTitle||swagger_petstore|Specifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.|
|
44 | |packageProductName||swagger_petstore|Specifies an AssemblyProduct for the .NET Framework global assembly attributes stored in the AssemblyInfo file.|
|
45 | |packageCompany||Smartbear Software|Specifies an AssemblyCompany for the .NET Framework global assembly attributes stored in the AssemblyInfo file.|
|
46 | |packageAuthors||Swagger-Codegen authors|Specifies Authors property in the .NET Core project file.|
|
47 | |packageCopyright||Copyright 2016 Smartbear Software|Specifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.|
|
48 | |podVersion||1.0.0||
|
49 | |optionalMethodArgument||false|Optional method argument, e.g. void square(int x=10) (.net 4.0+ only).|
|
50 | |optionalAssemblyInfo||false|Generate AssemblyInfo.cs.|
|
51 | |netCoreProjectFile||true|Use the new format (.NET Core) for .NET project files (.csproj).|
|
52 | |useCollection||false|Deserialize array types to Collection<T> instead of List<T>.|
|
53 | |interfacePrefix|||Prefix interfaces with a community standard or widely accepted prefix.|
|
54 | |returnICollection||false|Return ICollection<T> instead of the concrete type.|
|
55 | |optionalProjectFile||false|Generate {PackageName}.csproj.|
|
56 | |packageGuid||3cff8b0e-c6e1-4589-9efb-60cf16d72585|The GUID that will be associated with the C# project|
|
57 | |modelPropertyNaming||original|{camelCase, PascalCase, snake_case, original, UPPERCASE}|
|
58 | |targetFramework||4|The target .NET framework version.|
|
59 | |{camelCase, PascalCase, snake_case, original}||||
|
60 | |enumPropertyNaming|||Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'|
|
61 | |modelNamePrefix|||Prefix that will be prepended to all model names. Default is the empty string.|
|
62 | |modelNameSuffix|||Suffix that will be appended to all model names. Default is the empty string.|
|
63 | |optionalEmitDefaultValues||false|Set DataMember's EmitDefaultValue.|
|
64 | |emitModelMethods||true||
|
65 | |emitJSDoc||true|Whether to emit JSDoc comments|
|
66 | |gitUserId||Mermade|Git user ID, e.g. swagger-api.|
|
67 | |gitRepoId||openapi-codegen|Git repo ID, e.g. swagger-codegen.|
|
68 | |releaseNote||Minor update|Release note, default to 'Minor update'.|
|
69 | |httpUserAgent||OpenAPI-Codegen/1.0.0/nodejs|HTTP user agent, e.g. codegen_csharp_api_client, default to 'Swagger-Codegen/{packageVersion}}/{language}'|
|
70 | |supportsES6||true|Generate code that conforms to ES6.|
|
71 | |supportsAsync||true|Generate code that supports async operations.|
|
72 | |excludeTests||false|Specifies that no tests are to be generated.|
|
73 | |generateApiDocs||true|Not user-configurable. System provided for use in templates.|
|
74 | |generateApiTests||true|Specifies that api tests are to be generated.|
|
75 | |generateModelDocs||true|Not user-configurable. System provided for use in templates.|
|
76 | |generateModelTests||true|Specifies that model tests are to be generated.|
|
77 | |hideGenerationTimestamp||false|Hides the generation timestamp when files are generated.|
|
78 | |generatePropertyChanged||true|Specifies that models support raising property changed events.|
|
79 | |nonPublicApi||false|Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.|
|
80 | |validatable||true|Generates self-validatable models.|
|
81 | |variableNamingConvention||original|camelCase, PascalCase, snake_case, original, or UPPERCASE.|
|
82 | |ignoreFileOverride||.swagger-codegen-ignore|Specifies an override location for the .swagger-codegen-ignore file. Most useful on initial generation.|
|
83 | |removeOperationIdPrefix||false|Remove prefix of operationId, e.g. config_getId => getId|
|
84 | |nickname|operation|addPet||
|
85 | |httpMethod|operation|post||
|
86 | |path|operation|/pet||
|
87 | |operationId|operation|addPet||
|
88 | |operationIdLowerCase|operation|addpet||
|
89 | |operationIdSnakeCase|operation|undefined||
|
90 | |description|operation|||
|
91 | |summary|operation|Add a new pet to the store||
|
92 | |allParams|operation|[array]||
|
93 | |pathParams|operation|[array]||
|
94 | |queryParams|operation|[array]||
|
95 | |headerParams|operation|[array]||
|
96 | |formParams|operation|[array]||
|
97 | |notes|operation|||
|
98 | |responseHeaders|operation|[array]||
|
99 | |hasMore|operation|true||
|
100 | |isResponseBinary|operation|false||
|
101 | |baseName|operation|pet||
|
102 | |consumes|operation|[array]||
|
103 | |hasParams|operation|false||
|
104 | |hasOptionalParams|operation|false||
|
105 | |hasRequiredParams|operation|true||
|
106 | |hasQueryParams|operation|false||
|
107 | |hasFormParams|operation|false||
|
108 | |hasPathParams|operation|false||
|
109 | |hasHeaderParams|operation|false||
|
110 | |hasBodyParam|operation|true||
|
111 | |openapi|operation|{object}||
|
112 | |bodyParam|operation|{object}||
|
113 | |hasConsumes|operation|true||
|
114 | |bodyParams|operation|[array]||
|
115 | |tags|operation|[array]||
|
116 | |imports|operation|[array]||
|
117 | |vendorExtensions|operation|{object}||
|
118 | |responses|operation|[array]||
|
119 | |hasExamples|operation|false||
|
120 | |isBodyParam|parameter|true||
|
121 | |isHeaderParam|parameter|false||
|
122 | |isQueryParam|parameter|false||
|
123 | |isPathParam|parameter|false||
|
124 | |isFormParam|parameter|false||
|
125 | |isDate|parameter|false||
|
126 | |isDateTime|parameter|false||
|
127 | |baseName|parameter|body||
|
128 | |paramName|parameter|body||
|
129 | |required|parameter|true||
|
130 | |optional|parameter|false||
|
131 | |dataType|parameter|object||
|
132 | |description|parameter|Pet object that needs to be added to the store||
|
133 | |schema|parameter|{object}||
|
134 | |isEnum|parameter|false||
|
135 | |vendorExtensions|parameter|{object}||
|
136 | |type|parameter|object||
|
137 | |jsonSchema|parameter|"string"||
|
138 | |hasMore|parameter|false||
|
139 | |isFile|parameter|false||
|
140 | |code|response|405||
|
141 | |nickname|response|response405||
|
142 | |message|response|Invalid input||
|
143 | |description|response|Invalid input||
|
144 | |simpleType|response|true||
|
145 | |schema|response|{object}||
|
146 | |jsonSchema|response|"string"||
|
147 | |openapi|response|{object}||
|
148 | |name|model|Order||
|
149 | |classname|model|Order||
|
150 | |classVarName|model|Order||
|
151 | |modelJson|model|"string"||
|
152 | |title|model|undefined||
|
153 | |unescapedDescription|model|undefined||
|
154 | |classFilename|model|clsOrder||
|
155 | |modelPackage|model|Order||
|
156 | |hasEnums|model|false||
|
157 | |vars|model|[array]||
|
158 | |isMapContainer|model|false|boolean - set to true when container is a map|
|
159 | |isArrayContainer|model|false|boolean - set to true when container is an array|
|
160 | |itemsComplexType|vars|OrderDetails|Stores the name of the model for array elements|
|