Generics not recognized well with OpenApiResponseWithBodyAttribute

[powerdude]

When using OpenApiResponseWithBody on 2 different methods with a generic MyResponse<int> and then MyResponse<string>, the UI doesn't render. Also, if only used on one method, the properties of MyResponse do not show in the Models section.

[justinyoo]

@powerdude Thanks for the issue. To repro on my side, could you provide more details how you got into that, including your class definitions?

[powerdude]

 public class RouterCreationSuccess
    {
        [JsonProperty("crmSuccess")] public bool CrmSuccess { get; set; }

        [JsonProperty("iotSuccess")] public bool IotSuccess { get; set; }
    }

 public class Response<T>
    {
        public Response()
        {
            ErrorCodes = new List<Error>();
            DebugMessage = "";

            Result = new Result<T>();
        }

        [JsonProperty("result")] public Result<T> Result { get; set; }

        [JsonProperty("debugMessage")] public string DebugMessage { get; set; }

        [JsonProperty("errorCodes")] public List<Error> ErrorCodes { get; set; }
    }

  public class Result<T>
    {
        [JsonProperty("value")] public T Value { get; set; }
    }

public class Error
    {
        [JsonProperty("message")] public string Message;
        [JsonProperty("error")] public string Type { get; set; }
    }

public class Router{}

  public class Bug
    {
        [FunctionName(FunctionNames.AddRouter)]
        [OpenApiOperation(operationId: nameof(AddRouter), tags: new[] { "router" }, Summary = "Adds a router", Description = "Registers a new router in the system", Visibility = OpenApiVisibilityType.Important)]
        [OpenApiRequestBody("application/json", typeof(Router), Required = true)]
        [OpenApiResponseWithBody(statusCode: HttpStatusCode.OK, contentType: "application/json", bodyType: typeof(Response<RouterCreationSuccess>), Summary = "The response", Description = "This returns the response")]
        [OpenApiResponseWithoutBody(statusCode: HttpStatusCode.MethodNotAllowed, Summary = "Invalid input", Description = "Invalid input")]
        public async Task<IActionResult> AddRouter(
            [HttpTrigger(AuthorizationLevel.Function, "post", Route = "router")]
            HttpRequest req,
            [FromBody] Router newRouter,
            ILogger log)
        {
            return null;
        }
        [FunctionName("FunctionNames.AddRouter2")]
        [OpenApiOperation(operationId: nameof(AddRouter2), tags: new[] { "router" }, Summary = "Adds a router", Description = "Registers a new router in the system", Visibility = OpenApiVisibilityType.Important)]
        [OpenApiRequestBody("application/json", typeof(Router), Required = true)]
        [OpenApiResponseWithBody(statusCode: HttpStatusCode.OK, contentType: "application/json", bodyType: typeof(Response<int>), Summary = "The response", Description = "This returns the response")]
        [OpenApiResponseWithoutBody(statusCode: HttpStatusCode.MethodNotAllowed, Summary = "Invalid input", Description = "Invalid input")]
        public async Task<IActionResult> AddRouter2(
            [HttpTrigger(AuthorizationLevel.Function, "post", Route = "router")]
            HttpRequest req,
            [FromBody] Router newRouter,
            ILogger log)
        {
            return null;
        }
    }

[powerdude]

this is the error i get if both use Response<T>:

[2021-03-10T01:15:20.522Z] Executed 'RenderSwaggerDocument' (Failed, Id=a442e2f7-a52c-4ccd-90d5-ea434e996a74, Duration=91ms)
[2021-03-10T01:15:20.524Z] System.Private.CoreLib: Exception while executing function: RenderSwaggerDocument. System.Private.CoreLib: An item with the same key has already been added. Key: response.

and if i change Response<int> to just int, then no error but the Response<RouterCreationSuccess> doesn't show correctly in models section

[Arseth]

Same problem here when using OpenApiResponseWithBody with a generic type MyGenericClass<Data>

[ssa3512]

@justinyoo I can pick this up if you give me some guidance on what the correct result should be. The call that is failing is Line 253 here because GetOpenApiTypeName is returning the generic root. If two methods have two responses with the same generic root and different type params the dictionary tries to add twice with the same key.

azure-functions-openapi-extension/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/DocumentHelper.cs

Lines 251 to 255 in 2a58b60

	var schemas = new Dictionary<string, OpenApiSchema>();
	this._acceptor.Types = types.ToDictionary(p => p.GetOpenApiTypeName(namingStrategy), p => p);
	this._acceptor.RootSchemas = rootSchemas;
	this._acceptor.Schemas = schemas;

Based on what I am seeing in the samples, the convention being used for generics is to append a _ to the generic type with the generic type param.

Edit: Repro is here: https://github.com/ssa3512/azure-functions-openapi-extension/commit/d889f35c9c16fa9f7eb5b7021f96a59647254962

[justinyoo]

@powerdude It's been released to NuGet. Please have a look and let us know.

[powerdude]

thanks @justinyoo . I've already changed my object structure since i was under a timeline crunch, but if it works for the sample, then i'll eventually migrate back to my old setup. Thanks for the fix!

[Vivannaboa]

Hello, with a generic type it's working now.
Here I am having a problem when there are two generic types.

it works:

Response<T>

It does not work:

Response<IEnumerable<T>>