OpenAPITools / OpenAPITools/openapi-generator
[BUG][Elm] Invalid syntax for array type query params
Open
Nobody has claimed this yet.
Client: Elm
Issue: Bug
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the supplied openapi.yaml and reproduce the issue using the documented java -jar ... generate -i openapi.yaml -g elm command. Inspect the Elm generator's handling of optional array query parameters; done means the generated function type uses valid Elm syntax, including parentheses around List ArticleCategory, while preserving the request behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- elm
- Domain
- api, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100