Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
2 changes: 2 additions & 0 deletions src/OpenApi/src/Schemas/OpenApiJsonSchema.Helpers.cs
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,8 @@ internal sealed partial class OpenApiJsonSchema
{
type = "array";
var array = new OpenApiArray();
// Read to process JsonTokenType.StartArray before advancing
reader.Read();
while (reader.TokenType != JsonTokenType.EndArray)
{
array.Add(ReadOpenApiAny(ref reader));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -722,4 +722,93 @@
return true;
}
}

// Regression test for https://github.com/dotnet/aspnetcore/issues/62023
// Testing that the array parsing in our OpenApiJsonSchema works
[Fact]
public async Task CustomConverterThatOutputsArrayWithDefaultValue()
{
// Arrange
var serviceCollection = new ServiceCollection();
serviceCollection.ConfigureHttpJsonOptions(options =>
{
options.SerializerOptions.Converters.Add(new EnumArrayTypeConverter());
});
var builder = CreateBuilder(serviceCollection);

// Act
builder.MapPost("/api", (EnumArrayType e = EnumArrayType.None) => { });

// Assert
await VerifyOpenApiDocument(builder, document =>
{
var operation = document.Paths["/api"].Operations[HttpMethod.Post];

Check failure on line 745 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-quarantined-pr (Tests: Ubuntu x64)

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L745

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(745,63): error CS0103: (NETCORE_ENGINEERING_TELEMETRY=Build) The name 'HttpMethod' does not exist in the current context

Check failure on line 745 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-ci (Build Test: Ubuntu x64)

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L745

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(745,63): error CS0103: (NETCORE_ENGINEERING_TELEMETRY=Build) The name 'HttpMethod' does not exist in the current context

Check failure on line 745 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-quarantined-pr (Tests: macOS)

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L745

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(745,63): error CS0103: (NETCORE_ENGINEERING_TELEMETRY=Build) The name 'HttpMethod' does not exist in the current context

Check failure on line 745 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-quarantined-pr

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L745

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(745,63): error CS0103: (NETCORE_ENGINEERING_TELEMETRY=Build) The name 'HttpMethod' does not exist in the current context

Check failure on line 745 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-ci (Build Test: macOS)

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L745

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(745,63): error CS0103: (NETCORE_ENGINEERING_TELEMETRY=Build) The name 'HttpMethod' does not exist in the current context

Check failure on line 745 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-ci

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L745

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(745,63): error CS0103: (NETCORE_ENGINEERING_TELEMETRY=Build) The name 'HttpMethod' does not exist in the current context
var param = Assert.Single(operation.Parameters);
Assert.NotNull(param.Schema);
Assert.IsType<JsonArray>(param.Schema.Default);

Check failure on line 748 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-quarantined-pr (Tests: Ubuntu x64)

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L748

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(748,27): error CS0246: (NETCORE_ENGINEERING_TELEMETRY=Build) The type or namespace name 'JsonArray' could not be found (are you missing a using directive or an assembly reference?)

Check failure on line 748 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-ci (Build Test: Ubuntu x64)

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L748

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(748,27): error CS0246: (NETCORE_ENGINEERING_TELEMETRY=Build) The type or namespace name 'JsonArray' could not be found (are you missing a using directive or an assembly reference?)

Check failure on line 748 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-quarantined-pr (Tests: macOS)

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L748

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(748,27): error CS0246: (NETCORE_ENGINEERING_TELEMETRY=Build) The type or namespace name 'JsonArray' could not be found (are you missing a using directive or an assembly reference?)

Check failure on line 748 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-quarantined-pr

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L748

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(748,27): error CS0246: (NETCORE_ENGINEERING_TELEMETRY=Build) The type or namespace name 'JsonArray' could not be found (are you missing a using directive or an assembly reference?)

Check failure on line 748 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-ci (Build Test: macOS)

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L748

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(748,27): error CS0246: (NETCORE_ENGINEERING_TELEMETRY=Build) The type or namespace name 'JsonArray' could not be found (are you missing a using directive or an assembly reference?)

Check failure on line 748 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-ci

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L748

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(748,27): error CS0246: (NETCORE_ENGINEERING_TELEMETRY=Build) The type or namespace name 'JsonArray' could not be found (are you missing a using directive or an assembly reference?)
// Type is null, it's up to the user to configure this via a custom schema
// transformer for types with a converter.
Assert.Null(param.Schema.Type);
});
}

[Fact]
public async Task CustomConverterThatOutputsObjectWithDefaultValue()
{
// Arrange
var serviceCollection = new ServiceCollection();
serviceCollection.ConfigureHttpJsonOptions(options =>
{
options.SerializerOptions.Converters.Add(new EnumObjectTypeConverter());
});
var builder = CreateBuilder(serviceCollection);

// Act
builder.MapPost("/api", (EnumArrayType e = EnumArrayType.None) => { });

// Assert
await VerifyOpenApiDocument(builder, document =>
{
var operation = document.Paths["/api"].Operations[HttpMethod.Post];

Check failure on line 772 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-quarantined-pr (Tests: Ubuntu x64)

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L772

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(772,63): error CS0103: (NETCORE_ENGINEERING_TELEMETRY=Build) The name 'HttpMethod' does not exist in the current context

Check failure on line 772 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-ci (Build Test: Ubuntu x64)

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L772

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(772,63): error CS0103: (NETCORE_ENGINEERING_TELEMETRY=Build) The name 'HttpMethod' does not exist in the current context

Check failure on line 772 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-quarantined-pr (Tests: macOS)

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L772

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(772,63): error CS0103: (NETCORE_ENGINEERING_TELEMETRY=Build) The name 'HttpMethod' does not exist in the current context

Check failure on line 772 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-quarantined-pr

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L772

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(772,63): error CS0103: (NETCORE_ENGINEERING_TELEMETRY=Build) The name 'HttpMethod' does not exist in the current context

Check failure on line 772 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-ci (Build Test: macOS)

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L772

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(772,63): error CS0103: (NETCORE_ENGINEERING_TELEMETRY=Build) The name 'HttpMethod' does not exist in the current context

Check failure on line 772 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-ci

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L772

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(772,63): error CS0103: (NETCORE_ENGINEERING_TELEMETRY=Build) The name 'HttpMethod' does not exist in the current context
var param = Assert.Single(operation.Parameters);
Assert.NotNull(param.Schema);
Assert.IsType<JsonObject>(param.Schema.Default);

Check failure on line 775 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-quarantined-pr (Tests: Ubuntu x64)

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L775

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(775,27): error CS0246: (NETCORE_ENGINEERING_TELEMETRY=Build) The type or namespace name 'JsonObject' could not be found (are you missing a using directive or an assembly reference?)

Check failure on line 775 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-ci (Build Test: Ubuntu x64)

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L775

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(775,27): error CS0246: (NETCORE_ENGINEERING_TELEMETRY=Build) The type or namespace name 'JsonObject' could not be found (are you missing a using directive or an assembly reference?)

Check failure on line 775 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-quarantined-pr (Tests: macOS)

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L775

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(775,27): error CS0246: (NETCORE_ENGINEERING_TELEMETRY=Build) The type or namespace name 'JsonObject' could not be found (are you missing a using directive or an assembly reference?)

Check failure on line 775 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-quarantined-pr

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L775

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(775,27): error CS0246: (NETCORE_ENGINEERING_TELEMETRY=Build) The type or namespace name 'JsonObject' could not be found (are you missing a using directive or an assembly reference?)

Check failure on line 775 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-ci (Build Test: macOS)

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L775

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(775,27): error CS0246: (NETCORE_ENGINEERING_TELEMETRY=Build) The type or namespace name 'JsonObject' could not be found (are you missing a using directive or an assembly reference?)

Check failure on line 775 in src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

View check run for this annotation

Azure Pipelines / aspnetcore-ci

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs#L775

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs(775,27): error CS0246: (NETCORE_ENGINEERING_TELEMETRY=Build) The type or namespace name 'JsonObject' could not be found (are you missing a using directive or an assembly reference?)
// Type is null, it's up to the user to configure this via a custom schema
// transformer for types with a converter.
Assert.Null(param.Schema.Type);
});
}

public enum EnumArrayType
{
None = 1
}

public class EnumArrayTypeConverter : JsonConverter<EnumArrayType>
Copy link

@Arnab-Developer Arnab-Developer Jul 9, 2025

Choose a reason for hiding this comment

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

The EnumArrayTypeConverter and EnumObjectTypeConverter classes has been used only in the tests. Can we not make those classes as private?

Suggested change
public class EnumArrayTypeConverter : JsonConverter<EnumArrayType>
private class EnumArrayTypeConverter : JsonConverter<EnumArrayType>

{
public override EnumArrayType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
return new EnumArrayType();
}

public override void Write(Utf8JsonWriter writer, EnumArrayType value, JsonSerializerOptions options)
{
writer.WriteStartArray();
writer.WriteEndArray();
}
}

public class EnumObjectTypeConverter : JsonConverter<EnumArrayType>
Copy link

@Arnab-Developer Arnab-Developer Jul 9, 2025

Choose a reason for hiding this comment

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

Suggested change
public class EnumObjectTypeConverter : JsonConverter<EnumArrayType>
private class EnumObjectTypeConverter : JsonConverter<EnumArrayType>

{
public override EnumArrayType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
return new EnumArrayType();
}

public override void Write(Utf8JsonWriter writer, EnumArrayType value, JsonSerializerOptions options)
{
writer.WriteStartObject();
writer.WriteEndObject();
}
}
}
Loading