CSharp code generator - generated function's response type is string instead of byte[]

[boazsapir]

I defined the response data type of a POST api request as binary, according to the Swagger spec (type="string", format="byte"):

*   @SWG\Response(response=200, description="Encrypted data", @SWG\Schema(type="string", format="byte"))

The generated CSharp API call function has "string" as return type, and therefore apiInvoker.invokeAPI() will be called instead of apiInvoker.invokeBinaryAPI().

The generated code:

   if (typeof(string) == typeof(byte[])) {

      var response = apiInvoker.invokeBinaryAPI(basePath, path, "GET", queryParams, null, headerParams, formParams);
      return ((object)response) as string;


    } else {

      var response = apiInvoker.invokeAPI(basePath, path, "POST", queryParams, BinaryData, headerParams, formParams);
      if (response != null){
         return (string) ApiInvoker.deserialize(response, typeof(string));
      }
      else {
        return null;
      }


    }

[wing328]

In your example, is the HTTP response body/content encoded in base64 and you would expect the method to automatically convert the base64-encoded string to byte array using Convert.FromBase64String ?

Related discussion: OAI/OpenAPI-Specification#50

[boazsapir]

@wing328 in fact my response content is binary, not base64 encoded

[wing328]

@boazsapir OK. RESTSharp supports sending binary data so I'll try to address the issue in the csharp_restsharp branch.

[webron]

@boazsapir - what's the produces of your operation?

[boazsapir]

           "consumes": [
                "application/octet-stream"
            ],
            "produces": [
                "application/octet-stream"
            ],

[webron]

@boazsapir - hope you saw my comment regarding application/octet-stream and the byte format in the other thread.

[wing328]

@boazsapir currently the format byte in Swagger Spec (2.0) is a base64-encoded string so there's not much I can do at the moment to change the return type to byte[]

[wing328]

Fixed by #1864

[wing328]

@boazsapir when you've time, please kindly help perform a test.

Closing this issue for the time being.