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

[bugfix][Elm] Fix template when response schema is Map #10310

Merged

Conversation

matsubara0507
Copy link
Contributor

@matsubara0507 matsubara0507 commented Sep 2, 2021

cc @eriktim

Generate wrong Elm code when response schema is Map (Dict).

e.g. generate from

openapi: 3.0.1
info:
  title: My title
  description: API under test
  version: 1.0.0
servers:
  - url: https://localhost:9999/root
paths:
  /dict1:
    get:
      responses:
        '200':
          description: 'return dictonary'
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: boolean
  /dict2:
    get:
      responses:
        '200':
          description: 'return Object has dictionary'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Hoge'
components:
  schemas:
    Hoge:
      type: object
      properties:
        hoge:
          type: object
          additionalProperties:
            type: boolean

to

dict1Get : Api.Request (Dict.Dict String Bool)
dict1Get =
    Api.request
        "GET"
        "/dict1"
        []
        []
        []
        Nothing
        (Json.Decode.dict Api.Data.boolDecoder)

dict2Get : Api.Request Api.Data.Hoge
dict2Get =
    Api.request
        "GET"
        "/dict2"
        []
        []
        []
        Nothing
        Api.Data.hogeDecoder

hogeDecoder : Json.Decode.Decoder Hoge
hogeDecoder =
    Json.Decode.succeed Hoge
        |> maybeDecode "hoge" (Json.Decode.dict Json.Decode.boolboolDecoder) Nothing

but expected

dict1Get : Api.Request (Dict.Dict String Bool)
dict1Get =
    Api.request
        "GET"
        "/dict1"
        []
        []
        []
        Nothing
        (Json.Decode.dict Json.Decode.bool)

dict2Get : Api.Request Api.Data.Hoge
dict2Get =
    Api.request
        "GET"
        "/dict2"
        []
        []
        []
        Nothing
        Api.Data.hogeDecoder

hogeDecoder : Json.Decode.Decoder Hoge
hogeDecoder =
    Json.Decode.succeed Hoge
        |> maybeDecode "hoge" (Json.Decode.dict Json.Decode.bool) Nothing

fix it

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@wing328 wing328 added this to the 5.3.0 milestone Sep 4, 2021
@wing328
Copy link
Member

wing328 commented Sep 8, 2021

LGTM but I've not tested it locally.

@wing328 wing328 merged commit 2c5943d into OpenAPITools:master Sep 8, 2021
@matsubara0507 matsubara0507 deleted the fix-elm-templates-with-dict branch September 8, 2021 03:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants