[openapi] specific ProducesResponseType's SchemaReferenceId(name) by ProducesResponseTypeAttribute

[ngyyuusora]

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.

Like https://github.com/dotnet/aspnetcore/pull/58193/files

Describe the solution you'd like

Usage in mvc controller

[ProducesResponseType<PaginatedResponseResult<GetAdminUserDto>>(StatusCodes.Status200OK, SchemaId = "PaginatedGetAdminUserDto")]

Output schema: PaginatedGetAdminUserDto

Additional context

add a schemaId filed. then we can read customized schemaId in there,

internal static string? GetSchemaReferenceId(this JsonTypeInfo jsonTypeInfo, bool isTopLevel = true)
    {
        var type = jsonTypeInfo.Type;
        var underlyingType = Nullable.GetUnderlyingType(type);
        if (isTopLevel && OpenApiConstants.PrimitiveTypes.Contains(underlyingType ?? type))
        {
            return null;
        }

        // Short-hand if the type we're generating a schema reference ID for is
        // one of the simple types defined above.
        if (_simpleTypeToName.TryGetValue(type, out var simpleName))
        {
            return simpleName;
        }

        // Although arrays are enumerable types they are not encoded correctly
        // with JsonTypeInfoKind.Enumerable so we handle the Enumerable type
        // case here.
        if (jsonTypeInfo is JsonTypeInfo { Kind: JsonTypeInfoKind.Enumerable } || type.IsArray)
        {
            return null;
        }

        if (jsonTypeInfo is JsonTypeInfo { Kind: JsonTypeInfoKind.Dictionary })
        {
            return null;
        }

        return type.GetSchemaReferenceId(jsonTypeInfo.Options);
    }

No response

[ngyyuusora]

At now, if a generic type ProducesResponseType, will assemble such as "fooOfBarOfXyz", add this feature/field will be able to specifc schema name directly.

Current behavior: in OpenApi/src/Extensions/JsonTypeInfoExtensions.cs

  var genericTypeName = isNestedGenericType ? type.Name : type.Name[..backtickIndex];
            var genericArguments = type.GetGenericArguments();
            var argumentNames = string.Join("And", genericArguments.Select(arg => arg.GetSchemaReferenceId(options)));
            return $"{genericTypeName}Of{argumentNames}";

[captainsafia]

@ngyyuusora Thanks for proposing this idea! I don't know that I would include this API built-in to the framework but it should be feasible to implement this on the primitives introduces in the Microsoft.AspNetCore.OpenApi package. You can define a [SchemaId] attribute then have a SchemaTransformer/OperationTransformer that queries the inspected type for that attribute.