Skip to content

Commit 32b2ea3

Browse files
authored
Fixes #9398: fix aspnet enum documentation (#9404)
1 parent 45d55f6 commit 32b2ea3

2 files changed

Lines changed: 12 additions & 12 deletions

File tree

docs/generators/aspnetcore.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,20 @@ These options may be applied as additional-properties (cli) or configOptions (pl
77

88
| Option | Description | Values | Default |
99
| ------ | ----------- | ------ | ------- |
10-
|aspnetCoreVersion|ASP.NET Core version: 5.0, 3.1, 3.0, 2.2, 2.1, 2.0 (deprecated)| |3.1|
11-
|buildTarget|Target to build an application or library| |program|
12-
|classModifier|Class Modifier for controller classes: Empty string or abstract.| ||
10+
|aspnetCoreVersion|ASP.NET Core version: 5.0, 3.1, 3.0, 2.2, 2.1, 2.0 (deprecated)|<dl><dt>**2.0**</dt><dd>ASP.NET Core 2.0</dd><dt>**2.1**</dt><dd>ASP.NET Core 2.1</dd><dt>**2.2**</dt><dd>ASP.NET Core 2.2</dd><dt>**3.0**</dt><dd>ASP.NET Core 3.0</dd><dt>**3.1**</dt><dd>ASP.NET Core 3.1</dd><dt>**5.0**</dt><dd>ASP.NET Core 5.0</dd></dl>|3.1|
11+
|buildTarget|Target to build an application or library|<dl><dt>**program**</dt><dd>Generate code for a standalone server</dd><dt>**library**</dt><dd>Generate code for a server abstract class library</dd></dl>|program|
12+
|classModifier|Class Modifier for controller classes: Empty string or abstract.|<dl><dt>****</dt><dd>Keep class default with no modifier</dd><dt>**abstract**</dt><dd>Make class abstract</dd></dl>||
1313
|compatibilityVersion|ASP.Net Core CompatibilityVersion| |Version_2_2|
1414
|enumNameSuffix|Suffix that will be appended to all enum names.| |Enum|
1515
|enumValueSuffix|Suffix that will be appended to all enum values.| |Enum|
1616
|generateBody|Generates method body.| |true|
1717
|isLibrary|Is the build a library| |false|
1818
|licenseName|The name of the license| |NoLicense|
1919
|licenseUrl|The URL of the license| |http://localhost|
20-
|modelClassModifier|Model Class Modifier can be nothing or partial| |partial|
20+
|modelClassModifier|Model Class Modifier can be nothing or partial|<dl><dt>****</dt><dd>Keep model class default with no modifier</dd><dt>**partial**</dt><dd>Make model class partial</dd></dl>|partial|
2121
|newtonsoftVersion|Version for Microsoft.AspNetCore.Mvc.NewtonsoftJson for ASP.NET Core 3.0+| |3.0.0|
2222
|operationIsAsync|Set methods to async or sync (default).| |false|
23-
|operationModifier|Operation Modifier can be virtual or abstract| |virtual|
23+
|operationModifier|Operation Modifier can be virtual or abstract|<dl><dt>**virtual**</dt><dd>Keep method virtual</dd><dt>**abstract**</dt><dd>Make method abstract</dd></dl>|virtual|
2424
|operationResultTask|Set methods result to Task&lt;&gt;.| |false|
2525
|packageAuthors|Specifies Authors property in the .NET Core project file.| |OpenAPI|
2626
|packageCopyright|Specifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |No Copyright|
@@ -32,7 +32,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
3232
|returnICollection|Return ICollection&lt;T&gt; instead of the concrete type.| |false|
3333
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
3434
|sourceFolder|source folder for generated code| |src|
35-
|swashbuckleVersion|Swashbuckle version: 3.0.0, 4.0.0, 5.0.0| |3.0.0|
35+
|swashbuckleVersion|Swashbuckle version: 3.0.0, 4.0.0, 5.0.0|<dl><dt>**3.0.0**</dt><dd>Swashbuckle 3.0.0</dd><dt>**4.0.0**</dt><dd>Swashbuckle 4.0.0</dd><dt>**5.0.0**</dt><dd>Swashbuckle 5.0.0</dd></dl>|3.0.0|
3636
|useCollection|Deserialize array types to Collection&lt;T&gt; instead of List&lt;T&gt;.| |false|
3737
|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
3838
|useDefaultRouting|Use default routing for the ASP.NET Core version.| |true|

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AspNetCoreServerCodegen.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -199,14 +199,14 @@ public AspNetCoreServerCodegen() {
199199
aspnetCoreVersion.addEnum("5.0", "ASP.NET Core 5.0");
200200
aspnetCoreVersion.setDefault("3.1");
201201
aspnetCoreVersion.setOptValue(aspnetCoreVersion.getDefault());
202-
addOption(aspnetCoreVersion.getOpt(), aspnetCoreVersion.getDescription(), aspnetCoreVersion.getOptValue());
202+
cliOptions.add(aspnetCoreVersion);
203203

204204
swashbuckleVersion.addEnum("3.0.0", "Swashbuckle 3.0.0");
205205
swashbuckleVersion.addEnum("4.0.0", "Swashbuckle 4.0.0");
206206
swashbuckleVersion.addEnum("5.0.0", "Swashbuckle 5.0.0");
207207
swashbuckleVersion.setDefault("3.0.0");
208208
swashbuckleVersion.setOptValue(swashbuckleVersion.getDefault());
209-
addOption(swashbuckleVersion.getOpt(), swashbuckleVersion.getDescription(), swashbuckleVersion.getOptValue());
209+
cliOptions.add(swashbuckleVersion);
210210

211211
// CLI Switches
212212
addSwitch(CodegenConstants.SORT_PARAMS_BY_REQUIRED_FLAG,
@@ -261,19 +261,19 @@ public AspNetCoreServerCodegen() {
261261
classModifier.addEnum("abstract", "Make class abstract");
262262
classModifier.setDefault("");
263263
classModifier.setOptValue(classModifier.getDefault());
264-
addOption(classModifier.getOpt(), classModifier.getDescription(), classModifier.getOptValue());
264+
cliOptions.add(classModifier);
265265

266266
operationModifier.addEnum("virtual", "Keep method virtual");
267267
operationModifier.addEnum("abstract", "Make method abstract");
268268
operationModifier.setDefault("virtual");
269269
operationModifier.setOptValue(operationModifier.getDefault());
270-
addOption(operationModifier.getOpt(), operationModifier.getDescription(), operationModifier.getOptValue());
270+
cliOptions.add(operationModifier);
271271

272272
buildTarget.addEnum("program", "Generate code for a standalone server");
273273
buildTarget.addEnum("library", "Generate code for a server abstract class library");
274274
buildTarget.setDefault("program");
275275
buildTarget.setOptValue(buildTarget.getDefault());
276-
addOption(buildTarget.getOpt(), buildTarget.getDescription(), buildTarget.getOptValue());
276+
cliOptions.add(buildTarget);
277277

278278
addSwitch(GENERATE_BODY,
279279
"Generates method body.",
@@ -292,7 +292,7 @@ public AspNetCoreServerCodegen() {
292292
modelClassModifier.addEnum("partial", "Make model class partial");
293293
modelClassModifier.setDefault("partial");
294294
modelClassModifier.setOptValue(modelClassModifier.getDefault());
295-
addOption(modelClassModifier.getOpt(), modelClassModifier.getDescription(), modelClassModifier.getOptValue());
295+
cliOptions.add(modelClassModifier);
296296
}
297297

298298
@Override

0 commit comments

Comments
 (0)