Set `AdditionalProperties` if Type has `JsonExtensionData` attribute. · dotnet/aspnetcore#66338

(3 评论) (0 反应) (0 负责人)C# (37,933 star) (10,653 fork)batch import

area-minimalfeature-openapifeature-requesthelp wanted

描述

Is there an existing issue for this?

I have searched the existing issues

Is your feature request related to a problem? Please describe the problem.

No problem, just a nice to have.

Describe the solution you'd like

This was originally filed in Microsoft/OpenAPI.NET under #2809

If a schema has a field with the [JsonExtensionData] attribute it should specify AdditionalProperties: {} or AdditionalProperties: true to allow for a free-form object.

Describe alternatives you've considered I've setup my own SchemaTransformer that does this:

options.AddSchemaTransformer((schema, context, cancellationToken) =>
{
    var extensionDataProperty = context.JsonTypeInfo.Type
        .GetProperties(BindingFlags.Public | BindingFlags.Instance)
        .FirstOrDefault(p => Attribute.IsDefined(p, typeof(JsonExtensionDataAttribute)));

    if (extensionDataProperty is not null)
    {
        schema.AdditionalPropertiesAllowed = true;
        schema.AdditionalProperties = new OpenApiSchema();
    }

    return Task.CompletedTask;
});

Additional context

I believe it makes sense for this to be supported because if you have a model that has ExtensionData it accepts additional properties, but the OpenApi schema gen doesn't represent this without manual intervention.

贡献者指南

技术栈: csharp
领域: backendapi
议题类型: feature
难度: 3
预计时间: 1-2 days
活动状态: fresh
清晰度: clear
前置要求: C#ASP.NET CoreOpenAPIJsonExtensionData
新手友好度: 75
研究方向: Examine the OpenAPI schema generation in dotnet/aspnetcore, focusing on where model properties are processed. The original issue in Microsoft/OpenAPI.NET (#2809) provides context. Look for code that applies SchemaTransformer (e.g., in OpenApiOptions) and add logic to detect [JsonExtensionData] attributes, setting AdditionalPropertiesAllowed to true and AdditionalProperties to an empty schema.