Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG][Elm] Invalid syntax for array type query params #7889

Open
5 of 6 tasks
sayanarijit opened this issue Nov 5, 2020 · 4 comments
Open
5 of 6 tasks

[BUG][Elm] Invalid syntax for array type query params #7889

sayanarijit opened this issue Nov 5, 2020 · 4 comments

Comments

@sayanarijit
Copy link

sayanarijit commented Nov 5, 2020

Bug Report Checklist

  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

Openapi client generator for Elm generates invalid syntax for array type query params.

Output:

getArticles : Maybe List ArticleCategory -> Api.Request ()
getArticles category_query =
    Api.request
        "GET"
        "/articles"
        []
        [ ( "category", Maybe.map String.join "," << List.map  category_query ) ]
        []
        Nothing
        (Json.Decode.succeed ())

Expected output:

getArticles : Maybe (List ArticleCategory) -> Api.Request ()
getArticles category_query =
    Api.request
        "GET"
        "/articles"
        []
        [ ( "category", Maybe.map String.join "," << List.map  category_query ) ]
        []
        Nothing
        (Json.Decode.succeed ())
openapi-generator version

openapi-generator-cli-5.0.0-20201104.185152-853.jar

OpenAPI declaration file content or url
openapi: 3.0.0
info:
  version: 0.1.0-beta
  title: Foo API

paths:
  /articles:
    get:
      summary: Get articles
      operationId: GetArticles
      parameters:
        - name: category
          in: query
          description: Comma separated list of categories to filter
          required: false
          schema:
            # NOTE elm code generation for array type query params is buggy as of now.
           type: array
           items:
              $ref: "#/components/schemas/articleCategory"
      responses:
        "200":
          description: Articles
components:
  schemas:
    articleCategory:
      type: string
      enum:
        - Travel
        - Business
Generation Details
java -jar ~/Downloads/openapi-generator-cli-5.0.0-20201104.185152-853.jar generate -i openapi.yaml -g elm -o elm-client
Steps to reproduce
  • Write openapi.yaml.
  • Generate the elm client code.
Related issues/PRs
Suggest a fix
@auto-labeler
Copy link

auto-labeler bot commented Nov 5, 2020

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

@sayanarijit sayanarijit changed the title [BUG][Elm] Client code generation fails for array type query params [BUG][Elm] Invalid syntax for array type query params Nov 5, 2020
@wing328
Copy link
Member

wing328 commented Nov 5, 2020

@sayanarijit thanks for reporting the issue.

cc @eriktim

@wing328
Copy link
Member

wing328 commented Nov 5, 2020

@sayanarijit about the sponsorship option, simply put down the total amount you're willing to sponsor the fix and optionally how urgent you would like to get it fix (within a week? a month?)

Example: #6178

@sayanarijit
Copy link
Author

sayanarijit commented Nov 5, 2020

@wing328 Thanks for the clarification (and sorry for deleting the comment where I asked for clarification about the sponsorship). I've decided to give it a try myself.

@sayanarijit sayanarijit changed the title [BUG][Elm] Invalid syntax for array type query params [WIP] [BUG][Elm] Invalid syntax for array type query params Nov 22, 2020
@sayanarijit sayanarijit changed the title [WIP] [BUG][Elm] Invalid syntax for array type query params [BUG][Elm] Invalid syntax for array type query params Nov 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants