Skip to content

Fix optional parameter ordering in generated TS/CS clients #5135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 16, 2025
Merged

Fix optional parameter ordering in generated TS/CS clients #5135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 62 additions & 1 deletion src/NSwag.CodeGeneration.CSharp.Tests/OptionalParameterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ public enum MyEnum
Two,
Three,
Four

}

public class MyClass
{
#pragma warning disable IDE0051
Expand Down Expand Up @@ -145,5 +145,66 @@ public async Task When_setting_is_enabled_then_parameters_are_reordered()
// Assert
Assert.Contains("TestAsync(string a, string b, string c = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))", code);
}

[Fact]
public async Task When_optional_parameter_comes_before_required()
{
// Arrange
const string specification = """
{
"openapi": "3.0.0",
"paths": {
"/": {
"get": {
"operationId": "Get",
"parameters": [
{
"name": "firstname",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 1
},
{
"name": "lastname",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
}
}
}
""";

// Act
var document = await OpenApiDocument.FromJsonAsync(specification, "", SchemaType.OpenApi3);
var generator = new CSharpClientGenerator(document, new CSharpClientGeneratorSettings
{
GenerateOptionalParameters = true
});
var code = generator.GenerateFile();

// Assert
Assert.Contains("GetAsync(string lastname, string firstname = null,", code);
}
}
}
20 changes: 13 additions & 7 deletions src/NSwag.CodeGeneration.CSharp/Models/CSharpOperationModel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,16 +55,22 @@ public CSharpOperationModel(
// TODO: Move to CSharpControllerOperationModel
if (generator is CSharpControllerGenerator)
{
parameters = [.. parameters
.OrderBy(p => p.Position ?? 0)
.ThenBy(p => !p.IsRequired)
.ThenBy(p => p.Default == null)];
parameters =
[
.. parameters
.OrderBy(p => !p.IsRequired)
.ThenBy(p => p.Default == null)
.ThenBy(p => p.Position ?? 0)
];
}
else
{
parameters = [.. parameters
.OrderBy(p => p.Position ?? 0)
.ThenBy(p => !p.IsRequired)];
parameters =
[
.. parameters
.OrderBy(p => !p.IsRequired)
.ThenBy(p => p.Position ?? 0)
];
}
}

Expand Down
69 changes: 69 additions & 0 deletions src/NSwag.CodeGeneration.TypeScript.Tests/OptionalParameterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
using NJsonSchema;
using Xunit;

namespace NSwag.CodeGeneration.TypeScript.Tests
{
public class OptionalParameterTests
{
[Fact]
public async Task When_optional_parameter_comes_before_required()
{
// Arrange
const string specification = """
{
"openapi": "3.0.0",
"paths": {
"/": {
"get": {
"operationId": "Get",
"parameters": [
{
"name": "firstname",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 1
},
{
"name": "lastname",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
}
}
}
""";

// Act
var document = await OpenApiDocument.FromJsonAsync(specification, "", SchemaType.OpenApi3);
var generator = new TypeScriptClientGenerator(document, new TypeScriptClientGeneratorSettings
{
GenerateOptionalParameters = true
});
var code = generator.GenerateFile();

// Assert
Assert.Contains("get(lastname: string, firstname?: string | null | undefined)", code);
}
}
}
7 changes: 6 additions & 1 deletion src/NSwag.CodeGeneration.TypeScript/Models/TypeScriptOperationModel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,12 @@ public TypeScriptOperationModel(

if (settings.GenerateOptionalParameters)
{
parameters = [.. parameters.OrderBy(p => p.Position ?? 0).ThenBy(p => !p.IsRequired)];
parameters =
[
.. parameters
.OrderBy(p => !p.IsRequired)
.ThenBy(p => p.Position ?? 0)
];
}

Parameters = parameters
Expand Down
Loading