Skip to content

Fix/csharp reserved headers and file parameter not serialising correctly #23593

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

Open
BottlecapDave wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Fix/csharp reserved headers and file parameter not serialising correctly #23593

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
44a20ed
fix: Fixed issue where reserved headers were added to the request ins…
BottlecapDave Apr 21, 2026
78b3384
fix: Fixed issue where file parameter object is incorrectly JSON seri…
BottlecapDave Apr 21, 2026
b7eee79
chore: Updated samples based on csharp changes
BottlecapDave Apr 21, 2026
7f890c1
fix: Moved content header checks to client utils
BottlecapDave Apr 22, 2026
210df50
fix: Fixed reference to new IsContentHeader static method
BottlecapDave Apr 22, 2026
99fbc55
chore: Added "content-disposition" to content header check
BottlecapDave Apr 22, 2026
dd199ab
fix: Updated ContentHeaders to be compatible with older versions of .NET
BottlecapDave Apr 23, 2026
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
115 changes: 91 additions & 24 deletions modules/openapi-generator/src/main/resources/csharp/libraries/generichost/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,21 @@ namespace {{packageName}}.{{apiPackage}}
{
private JsonSerializerOptions _jsonSerializerOptions;

private readonly string[] _contentHeaders =
[
Copy link
Copy Markdown
Contributor

@devhl-labs devhl-labs Apr 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider making this static readonly, or move it to ClientUtils.

Copy link
Copy Markdown
Author

@BottlecapDave BottlecapDave Apr 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to ClientUtils

"allow",
"content-encoding",
"content-language",
"content-length",
"content-location",
"content-md5",
"content-range",
"content-type",
"expires",
"last-modified",
"extension-header"
Copy link
Copy Markdown
Contributor

@devhl-labs devhl-labs Apr 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot is telling me extension-header is demonstrating the format, but isn't a real entry. Consider removing it. I'd also appreciate if you remove the spaces that appear after these values.

];

/// <summary>
/// The logger factory
/// </summary>
Expand Down Expand Up @@ -452,23 +467,6 @@ namespace {{packageName}}.{{apiPackage}}

{{/-last}}
{{/queryParams}}
{{#constantParams}}
{{#isHeaderParam}}
// Set client side default value of Header Param "{{baseName}}".
httpRequestMessageLocalVar.Headers.Add("{{baseName}}", ClientUtils.ParameterToString({{#_enum}}"{{{.}}}"{{/_enum}})); // Constant header parameter
{{/isHeaderParam}}
{{/constantParams}}
{{#headerParams}}
{{#required}}
httpRequestMessageLocalVar.Headers.Add("{{baseName}}", ClientUtils.ParameterToString({{paramName}}));

{{/required}}
{{^required}}
if ({{paramName}}.IsSet)
httpRequestMessageLocalVar.Headers.Add("{{baseName}}", ClientUtils.ParameterToString({{paramName}}.Value));

{{/required}}
{{/headerParams}}
{{#formParams}}
{{#-first}}
{{#isMultipart}}
Expand Down Expand Up @@ -561,18 +559,87 @@ namespace {{packageName}}.{{apiPackage}}
{{/formParams}}
{{#bodyParam}}
{{#required}}
httpRequestMessageLocalVar.Content = ({{paramName}}{{^required}}.Value{{/required}} as object) is System.IO.Stream stream
? httpRequestMessageLocalVar.Content = new StreamContent(stream)
: httpRequestMessageLocalVar.Content = new StringContent(JsonSerializer.Serialize({{paramName}}{{^required}}.Value{{/required}}, _jsonSerializerOptions));
if (({{paramName}}{{^required}}.Value{{/required}} as object) is System.IO.Stream stream)
Copy link
Copy Markdown
Contributor

@devhl-labs devhl-labs Apr 22, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In generichost I don't believe it will ever be a System.IO.Stream anymore, I think its always going to be a FileParameter. Im not positive though. Worth looking into. You can leave this alone if you want though.

edit - I had copilot check and despite the type mapping being a Stream, the templates actually use FileParameter, so it should be safe to remove.

Copy link
Copy Markdown
Author

@BottlecapDave BottlecapDave Apr 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

{
httpRequestMessageLocalVar.Content = new StreamContent(stream);
}
{{#isFile}}
else if (({{paramName}}{{^required}}.Value{{/required}} as object) is {{packageName}}.{{clientPackage}}.FileParameter fileParameterLocalVar)
{
httpRequestMessageLocalVar.Content = new StreamContent(fileParameterLocalVar.Content);
}
{{/isFile}}
else
{
httpRequestMessageLocalVar.Content = new StringContent(JsonSerializer.Serialize({{paramName}}{{^required}}.Value{{/required}}, _jsonSerializerOptions));
}
{{/required}}
{{^required}}
if ({{paramName}}.IsSet)
httpRequestMessageLocalVar.Content = ({{paramName}}{{^required}}.Value{{/required}} as object) is System.IO.Stream stream
? httpRequestMessageLocalVar.Content = new StreamContent(stream)
: httpRequestMessageLocalVar.Content = new StringContent(JsonSerializer.Serialize({{paramName}}{{^required}}.Value{{/required}}, _jsonSerializerOptions));
{
if (({{paramName}}{{^required}}.Value{{/required}} as object) is System.IO.Stream stream)
{
httpRequestMessageLocalVar.Content = new StreamContent(stream);
}
{{#isFile}}
else if (({{paramName}}{{^required}}.Value{{/required}} as object) is {{packageName}}.{{clientPackage}}.FileParameter fileParameterLocalVar)
{
httpRequestMessageLocalVar.Content = new StreamContent(fileParameterLocalVar.Content);
}
{{/isFile}}
else
{
httpRequestMessageLocalVar.Content = new StringContent(JsonSerializer.Serialize({{paramName}}{{^required}}.Value{{/required}}, _jsonSerializerOptions));
}
}
{{/required}}

{{/bodyParam}}

{{#constantParams}}
{{#isHeaderParam}}
// Set client side default value of Header Param "{{baseName}}".
if (_contentHeaders.Contains("{{baseName}}".ToLowerInvariant()))
{
httpRequestMessageLocalVar.Content.Headers.Add("{{baseName}}", ClientUtils.ParameterToString({{#_enum}}"{{{.}}}"{{/_enum}})); // Constant header parameter
}
else
{
httpRequestMessageLocalVar.Headers.Add("{{baseName}}", ClientUtils.ParameterToString({{#_enum}}"{{{.}}}"{{/_enum}})); // Constant header parameter
}

{{/isHeaderParam}}
{{/constantParams}}
{{#headerParams}}
{{#required}}
// Set client side default value of Header Param "{{baseName}}".
if (_contentHeaders.Contains("{{baseName}}".ToLowerInvariant()))
{
httpRequestMessageLocalVar.Content.Headers.Add("{{baseName}}", ClientUtils.ParameterToString({{paramName}}));
}
else
{
httpRequestMessageLocalVar.Headers.Add("{{baseName}}", ClientUtils.ParameterToString({{paramName}}));
}

{{/required}}
{{^required}}
if ({{paramName}}.IsSet)
{
// Set client side default value of Header Param "{{baseName}}".
if (_contentHeaders.Contains("{{baseName}}".ToLowerInvariant()))
{
httpRequestMessageLocalVar.Content.Headers.Add("{{baseName}}", ClientUtils.ParameterToString({{paramName}}.Value));
}
Comment thread
cubic-dev-ai[bot] marked this conversation as resolved.
else
{
httpRequestMessageLocalVar.Headers.Add("{{baseName}}", ClientUtils.ParameterToString({{paramName}}.Value));
}
}

{{/required}}
{{/headerParams}}

{{#authMethods}}
{{#-first}}
List<TokenBase> tokenBaseLocalVars = new List<TokenBase>();
Expand Down Expand Up @@ -907,4 +974,4 @@ namespace {{packageName}}.{{apiPackage}}
}
{{/operations}}
}
{{/lambda.trimLineBreaks}}
{{/lambda.trimLineBreaks}}
28 changes: 25 additions & 3 deletions ...ient/petstore/csharp/generichost/latest/HelloWorld/src/Org.OpenAPITools/Api/DefaultApi.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,21 @@ public sealed partial class DefaultApi : IDefaultApi
{
private JsonSerializerOptions _jsonSerializerOptions;

private readonly string[] _contentHeaders =
[
"allow",
"content-encoding",
"content-language",
"content-length",
"content-location",
"content-md5",
"content-range",
"content-type",
"expires",
"last-modified",
"extension-header"
];

/// <summary>
/// The logger factory
/// </summary>
Expand Down Expand Up @@ -249,9 +264,16 @@ public async Task<IHelloWorldPostApiResponse> HelloWorldPostAsync(Option<HelloWo
: string.Concat(HttpClient.BaseAddress.AbsolutePath.TrimEnd('/'), "/helloWorld");

if (helloWorldPostRequest.IsSet)
httpRequestMessageLocalVar.Content = (helloWorldPostRequest.Value as object) is System.IO.Stream stream
? httpRequestMessageLocalVar.Content = new StreamContent(stream)
: httpRequestMessageLocalVar.Content = new StringContent(JsonSerializer.Serialize(helloWorldPostRequest.Value, _jsonSerializerOptions));
{
if ((helloWorldPostRequest.Value as object) is System.IO.Stream stream)
{
httpRequestMessageLocalVar.Content = new StreamContent(stream);
}
else
{
httpRequestMessageLocalVar.Content = new StringContent(JsonSerializer.Serialize(helloWorldPostRequest.Value, _jsonSerializerOptions));
}
}

httpRequestMessageLocalVar.RequestUri = uriBuilderLocalVar.Uri;

Expand Down
15 changes: 15 additions & 0 deletions ...petstore/csharp/generichost/latest/InlineEnumAnyOf/src/Org.OpenAPITools/Api/DefaultApi.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,21 @@ public sealed partial class DefaultApi : IDefaultApi
{
private JsonSerializerOptions _jsonSerializerOptions;

private readonly string[] _contentHeaders =
[
"allow",
"content-encoding",
"content-language",
"content-length",
"content-location",
"content-md5",
"content-range",
"content-type",
"expires",
"last-modified",
"extension-header"
];

/// <summary>
/// The logger factory
/// </summary>
Expand Down
28 changes: 25 additions & 3 deletions ...lient/petstore/csharp/generichost/latest/OneOfList/src/Org.OpenAPITools/Api/DefaultApi.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,21 @@ public sealed partial class DefaultApi : IDefaultApi
{
private JsonSerializerOptions _jsonSerializerOptions;

private readonly string[] _contentHeaders =
[
"allow",
"content-encoding",
"content-language",
"content-length",
"content-location",
"content-md5",
"content-range",
"content-type",
"expires",
"last-modified",
"extension-header"
];

/// <summary>
/// The logger factory
/// </summary>
Expand Down Expand Up @@ -230,9 +245,16 @@ public async Task<IOneOfArrayApiResponse> OneOfArrayAsync(Option<OneOfArrayReque
: string.Concat(HttpClient.BaseAddress.AbsolutePath.TrimEnd('/'), "/one-of-array");

if (oneOfArrayRequest.IsSet)
httpRequestMessageLocalVar.Content = (oneOfArrayRequest.Value as object) is System.IO.Stream stream
? httpRequestMessageLocalVar.Content = new StreamContent(stream)
: httpRequestMessageLocalVar.Content = new StringContent(JsonSerializer.Serialize(oneOfArrayRequest.Value, _jsonSerializerOptions));
{
if ((oneOfArrayRequest.Value as object) is System.IO.Stream stream)
{
httpRequestMessageLocalVar.Content = new StreamContent(stream);
}
else
{
httpRequestMessageLocalVar.Content = new StringContent(JsonSerializer.Serialize(oneOfArrayRequest.Value, _jsonSerializerOptions));
}
}

httpRequestMessageLocalVar.RequestUri = uriBuilderLocalVar.Uri;

Expand Down
15 changes: 15 additions & 0 deletions ...les/client/petstore/csharp/generichost/latest/Tags/src/Org.OpenAPITools/Api/APIKEYSApi.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,21 @@ public sealed partial class APIKEYSApi : IAPIKEYSApi
{
private JsonSerializerOptions _jsonSerializerOptions;

private readonly string[] _contentHeaders =
[
"allow",
"content-encoding",
"content-language",
"content-length",
"content-location",
"content-md5",
"content-range",
"content-type",
"expires",
"last-modified",
"extension-header"
];

/// <summary>
/// The logger factory
/// </summary>
Expand Down
15 changes: 15 additions & 0 deletions ...es/client/petstore/csharp/generichost/latest/Tags/src/Org.OpenAPITools/Api/APIKeys0Api.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,21 @@ public sealed partial class APIKeysApi : IAPIKeysApi
{
private JsonSerializerOptions _jsonSerializerOptions;

private readonly string[] _contentHeaders =
[
"allow",
"content-encoding",
"content-language",
"content-length",
"content-location",
"content-md5",
"content-range",
"content-type",
"expires",
"last-modified",
"extension-header"
];

/// <summary>
/// The logger factory
/// </summary>
Expand Down
15 changes: 15 additions & 0 deletions ...es/client/petstore/csharp/generichost/latest/Tags/src/Org.OpenAPITools/Api/ApiKeys1Api.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,21 @@ public sealed partial class ApiKeysApi : IApiKeysApi
{
private JsonSerializerOptions _jsonSerializerOptions;

private readonly string[] _contentHeaders =
[
"allow",
"content-encoding",
"content-language",
"content-length",
"content-location",
"content-md5",
"content-range",
"content-type",
"expires",
"last-modified",
"extension-header"
];

/// <summary>
/// The logger factory
/// </summary>
Expand Down
26 changes: 23 additions & 3 deletions ...re/csharp/generichost/latest/UseDateTimeOffset/src/Org.OpenAPITools/Api/AnotherFakeApi.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,21 @@ public sealed partial class AnotherFakeApi : IAnotherFakeApi
{
private JsonSerializerOptions _jsonSerializerOptions;

private readonly string[] _contentHeaders =
[
"allow",
"content-encoding",
"content-language",
"content-length",
"content-location",
"content-md5",
"content-range",
"content-type",
"expires",
"last-modified",
"extension-header"
];

/// <summary>
/// The logger factory
/// </summary>
Expand Down Expand Up @@ -277,9 +292,14 @@ public async Task<ICall123TestSpecialTagsApiResponse> Call123TestSpecialTagsAsyn
? "/another-fake/dummy"
: string.Concat(HttpClient.BaseAddress.AbsolutePath.TrimEnd('/'), "/another-fake/dummy");

httpRequestMessageLocalVar.Content = (modelClient as object) is System.IO.Stream stream
? httpRequestMessageLocalVar.Content = new StreamContent(stream)
: httpRequestMessageLocalVar.Content = new StringContent(JsonSerializer.Serialize(modelClient, _jsonSerializerOptions));
if ((modelClient as object) is System.IO.Stream stream)
{
httpRequestMessageLocalVar.Content = new StreamContent(stream);
}
else
{
httpRequestMessageLocalVar.Content = new StringContent(JsonSerializer.Serialize(modelClient, _jsonSerializerOptions));
}

httpRequestMessageLocalVar.RequestUri = uriBuilderLocalVar.Uri;

Expand Down
15 changes: 15 additions & 0 deletions ...tstore/csharp/generichost/latest/UseDateTimeOffset/src/Org.OpenAPITools/Api/DefaultApi.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,21 @@ public sealed partial class DefaultApi : IDefaultApi
{
private JsonSerializerOptions _jsonSerializerOptions;

private readonly string[] _contentHeaders =
[
"allow",
"content-encoding",
"content-language",
"content-length",
"content-location",
"content-md5",
"content-range",
"content-type",
"expires",
"last-modified",
"extension-header"
];

/// <summary>
/// The logger factory
/// </summary>
Expand Down
Loading