Skip to content

[OCaml] Fix enum returnType in of_json.mustache for Api Impl#8631

Merged
wing328 merged 2 commits intoOpenAPITools:masterfrom
syntakker:Fix_OCaml_Enum_ReturnType
Feb 27, 2021
Merged

[OCaml] Fix enum returnType in of_json.mustache for Api Impl#8631
wing328 merged 2 commits intoOpenAPITools:masterfrom
syntakker:Fix_OCaml_Enum_ReturnType

Conversation

@syntakker
Copy link
Copy Markdown
Contributor

@syntakker syntakker commented Feb 7, 2021 •
edited
Loading

@cgensoul

Enum return types seem to be incorrectly handled in api implementations *_api.ml for json swagger.txt.

For operations returning enums, processing of return values is rendered as

    Request.read_json_body_as_list_of (JsonSupport.unwrap Push_result.of_yojson) resp body

where PushResult is an enum. It should however render to

    Request.read_json_body_as_list_of (JsonSupport.unwrap Enums.pushresult_of_yojson) resp body

The cause seems to be that neither isEnum nor datatypeWithEnum is available for operations in of_json.mustache:

{{#isEnum}}JsonSupport.unwrap Enums.{{{datatypeWithEnum}}}_of_yojson{{/isEnum}}{{^isEnum}} ...

This fix works for me, however I suppose that a solution could be substantially more elegant if I only was more with conversant CodeGen internals.

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](https://gitforwindows.org/).
- [ ] File the PR against the [correct branch](https://github.com/OpenAPITools/openapi-generator/wiki/Git-Branches): `master`, `5.1.x`, `6.0.x`
- [ ] If your PR is targeting a particular programming language, @mention the [technical committee](https://github.com/openapitools/openapi-generator/#62---openapi-generator-technical-committee) members, so they are more likely to review the pull request.

@syntakker syntakker changed the title Fix OCaml enum returnType in of_json.mustache for Api Impl [OCaml] Fix enum returnType in of_json.mustache for Api Impl Feb 7, 2021
@wing328 wing328 added this to the 5.0.1 milestone Feb 7, 2021
@wing328 wing328 modified the milestones: 5.0.1, 5.1.0 Feb 8, 2021
@wing328
Copy link
Copy Markdown
Member

wing328 commented Feb 27, 2021

Tested locally and the code compiles without issues whereas without this fix, I got errors building the client, e.g.

# (cd _build/default && /Users/williamcheng/.opam/default/bin/ocamlopt.opt -w -40 -w -27 -g -I .petstore_client.objs/byte -I .petstore_client.objs/native -I /Users/williamcheng/.opam/default/lib/astring -I /Users/williamcheng/.opam/default/lib/base -I /Users/williamcheng/.opam/default/lib/base/caml -I /Users/williamcheng/.opam/default/lib/base/shadow_stdlib -I /Users/williamcheng/.opam/default/[...]
# File "src/apis/pet_api.ml", line 56, characters 50-69:
# 56 |     Request.read_json_body_as (JsonSupport.unwrap Enum_test.of_yojson) resp body
#                                                        ^^^^^^^^^^^^^^^^^^^
# Error: Unbound module Enum_test

@wing328 wing328 merged commit ebac91a into OpenAPITools:master Feb 27, 2021
@wing328
Copy link
Copy Markdown
Member

wing328 commented Mar 22, 2021

@syntakker thanks for the PR, which has been included in the v5.1.0 release: https://twitter.com/oas_generator/status/1373636654024380423

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

Client: OCaml Feature: Enum Issue: Bug

Projects

None yet

Milestone

5.1.0

Development

Successfully merging this pull request may close these issues.

2 participants

@syntakker @wing328