openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

[R][Client] catch enum classes in toJSON

Open joXemMx opened this issue 1 year ago • 1 comments

PR checklist

  • [x] Read the contribution guidelines.
  • [x] 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.
  • [x] Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH) 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*. IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • [x] File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • [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.

Related to https://github.com/OpenAPITools/openapi-generator/pull/18183

If an enum-class is parameter of another class, it currently gets serialized by toJSON like every other class:

EnumObject[["enum"]] <-
  self$`enum`$toJSON()

This runs into issues as an enum class is essentially just a class holding a singular string value "ENUM". In the JSON that is being put into the http request, "ENUM" is then turned into "\"ENUM\"", which will not be recognized by the API as it is not a valid enum, but rather the same enum with quotations marks around it.

To circumvent this, I implemented a check in toJSON that looks at the class in JSON form and checks if it has no keys and its only value is a string (this should apply only to enum classes in my mind, but please prove me wrong otherwise).

if (length(names(self$`{{name}}`$toJSON())) == 0L && is.character(jsonlite::fromJSON(self$`{{name}}`$toJSON()))) {
  jsonlite::fromJSON(self$`{{name}}`$toJSON())
} else {
  self$`{{name}}`$toJSON()
}

This way, the enum will be assigned as a string instead of an JSON object and serialized correctly. If you see any better fixes for this problem, please feel free to pitch some ideas. This was just the easiest and most obvious fix for me right now. Technical committee @Ramanth @saigiridhar21

joXemMx avatar Mar 21 '24 17:03 joXemMx

This seems to still have some hickups, I converted to draft until I sorted them out

joXemMx avatar Mar 22 '24 16:03 joXemMx