Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[NodeJS] [CSharp] - CSV / Arrays / Lists in URL's are not replaced correctly

See original GitHub issue

Hello everybody,

having a Java EE REST-Endpoint annotated like:

  @com.my-domain.ess.interceptor.binding.ServiceOperation("query")
  @javax.ws.rs.GET
  @javax.ws.rs.Path("{parentId}/query")         
  @javax.ws.rs.Produces({javax.ws.rs.core.MediaType.APPLICATION_XML, javax.ws.rs.core.MediaType.APPLICATION_JSON})
  @io.swagger.annotations.ApiOperation(value="Wer suchet, der findet", nickname="MischtabellenQuery",
      authorizations = {
      @io.swagger.annotations.Authorization(
          value="oauth", 
          scopes = { @io.swagger.annotations.AuthorizationScope(scope = "ess", description = "OAuth-Authentifizierung f. ESS") }
          )
    }
  )

  @io.swagger.annotations.ApiResponses(value = 
  {
    @io.swagger.annotations.ApiResponse(code = 200, message = "OK", response=com.gfi.eva.serviceschicht.zentral.SchluesseltabellenEintragQueryResponse.class), 
  })                                  
  public javax.ws.rs.core.Response query(@javax.ws.rs.PathParam("parentId") java.util.List<String> parentIds) throws Exception

I’m getting this swagger:

"/Services/Mischtabellen/{parentId}/query" : {
      "get" : {
        "tags" : [ "MischtabellenRessource" ],
        "summary" : "Wer suchet, der findet",
        "description" : "",
        "operationId" : "MischtabellenQuery",
        "produces" : [ "application/xml", "application/json" ],
        "parameters" : [ {
          "name" : "parentId",
          "in" : "path",
          "required" : true,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "csv"
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "schema" : {
              "$ref" : "#/definitions/SchluesseltabellenEintragQueryResponse"
            }
          }
        },
        "security" : [ {
          "oauth" : [ "ess" ]
        } ]
      }
    }

The relevant part of the generated client is this:

ESS.prototype.query = function (parentId, options, callback) {
  var client = this;
  if(!callback && typeof options === 'function') {
    callback = options;
    options = null;
  }
  if (!callback) {
    throw new Error('callback cannot be null.');
  }
  // Validate
  ...
  // Construct URL
  var requestUrl = this.baseUri +
                   '//Services/Mischtabellen/{parentId:commaSeparated}/query';
  requestUrl = requestUrl.replace('{parentId}', encodeURIComponent(parentId.toString()));

The parameter parentId is an array and got validated correctly. In the requestUrl the {parentId:commaSeparated} should be replaced by the array in parentId. But the call requestUrl.replace() tries to replace {parentId} instead of {parentId:commaSeparated}. Hence the replacement never happenes and the called URL is wrong.

Fixing the replacement to {parentId:commaSeparated} works as expected.

The problem occurs in the NodeJS and CSharp client in the same way.

Thanks! Alex