Skip to content

[release/9.0] Apply schema transformer to AdditionalProperties #59730

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
Jan 10, 2025
Merged

[release/9.0] Apply schema transformer to AdditionalProperties #59730

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
Apply schema transformer to AdditionalProperties
  • Loading branch information
Jelle Teeuwissen authored and github-actions committed Jan 6, 2025
commit e5d7390773bbd857ab03f6ac2566018270cf2f10
8 changes: 7 additions & 1 deletion src/OpenApi/src/Services/Schemas/OpenApiSchemaService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,13 @@ private async Task InnerApplySchemaTransformersAsync(OpenApiSchema schema,
}
}
}
}

if (schema is { AdditionalPropertiesAllowed: true, AdditionalProperties: not null } && jsonTypeInfo.ElementType is not null)
{
var elementTypeInfo = _jsonSerializerOptions.GetTypeInfo(jsonTypeInfo.ElementType);
await InnerApplySchemaTransformersAsync(schema.AdditionalProperties, elementTypeInfo, null, context, transformer, cancellationToken);
}
}

private JsonNode CreateSchema(OpenApiSchemaKey key)
=> JsonSchemaExporter.GetJsonSchemaAsNode(_jsonSerializerOptions, key.Type, _configuration);
Expand Down
9 changes: 8 additions & 1 deletion src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Transformers/SchemaTransformerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -444,6 +444,7 @@ public async Task SchemaTransformer_CanModifyItemTypesInADocument()

builder.MapGet("/list", () => new List<int> { 1, 2, 3, 4 });
builder.MapGet("/single", () => 1);
builder.MapGet("/dictionary", () => new Dictionary<string, int> {{ "key", 1 }});

var options = new OpenApiOptions();
options.AddSchemaTransformer((schema, context, cancellationToken) =>
Expand All @@ -469,7 +470,13 @@ await VerifyOpenApiDocument(builder, options, document =>
getOperation = path.Operations[OperationType.Get];
responseSchema = getOperation.Responses["200"].Content["application/json"].Schema.GetEffective(document);
Assert.Equal("modified-number-format", responseSchema.Format);
});

// Assert that the schema represent dictionary values has been modified
path = document.Paths["/dictionary"];
getOperation = path.Operations[OperationType.Get];
responseSchema = getOperation.Responses["200"].Content["application/json"].Schema.GetEffective(document);
Assert.Equal("modified-number-format", responseSchema.AdditionalProperties.Format);
});
}

[Fact]
Expand Down
Loading