swagger-api / swagger-api/swagger-codegen

[scala] collectionFormat not supported for tsv, pipes, ssv, multi

Open
#4,976 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: General help wanted Server: Scala
Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

Description

This is for the scalatra server (-l scalatra).

Generated code for collection parameters can only parse the csv format at the moment. Other formats, such as pipes, are not supported.

Swagger-codegen version

Latest github snapshot as of 2017-03-08

Swagger declaration file content or url

  /pathologies:
    get:
      summary: "Information about pathological findings."
      parameters:
        - name: sampleIdFilter
          description: "Sample IDs to get pathologies for"
          in: query
          type: array
          collectionFormat: pipes
          required: false
          items:
            type: string

Related issues

https://github.com/swagger-api/swagger-codegen/pull/4426

Suggest a Fix

I will try to submit a PR soon.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Scalatra server generator and locate the collection-parameter parsing used by generated query handling. Compare its current CSV behavior with the declared pipes, TSV, SSV, and multi formats; done means generated code parses each listed collection format correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
backend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.