Exception in client when processing binary response

[xplicit]

When response schema contains binary format for representing byte [] array similar like in the sample, autorest should generate method with return type byte[]

autorest/Samples/petstore/petstore.json

Lines 278 to 284 in 32b3008

	"200": {
	"description": "successful operation",
	"schema": {
	"type": "string",
	"format": "binary"
	}
	},

But it generates method with return type string which tries to convert binary array of bytes to string and when method is called, the exception is raised.

autorest/Samples/petstore/CSharp/SwaggerPetstoreExtensions.cs

Lines 214 to 217 in 75e583c

	public static string FindPetsWithByteArray(this ISwaggerPetstore operations, long petId)
	{
	return operations.FindPetsWithByteArrayAsync(petId).GetAwaiter().GetResult();
	}

Exception is thrown at this line:

autorest/Samples/petstore/CSharp/SwaggerPetstore.cs

Line 897 in 75e583c

_result.Body = SafeJsonConvert.DeserializeObject<string>(_responseContent, DeserializationSettings);

Releated info about binary format:

OAI/OpenAPI-Specification#50 (comment)
OAI/OpenAPI-Specification#430

[mannyvw]

Did you get anywhere with this having the same issue @xplicit . At moment am thinking might have to convert end point to return base64 encoded data but not ideal

thanks

[fearthecowboy]

Have no idea how we missed seeing this.

Is the whole response a byte array? if so, you should use stream for the response.

Otherwise, if the response is a json with embedded binary data, ... you have to encode it as a string. JSON doesn't support directly embedded binary data.

[MiYanni]

Answer provided. Closing.