swagger-api / swagger-api/swagger-codegen
[FINCH] no enum support
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
The Finch code generator does not support enums. An inline enum generates a normal variable of the desired type; a referenced enum generates an empty case class.
Swagger-codegen version
2.2.2-SNAPSHOT
Swagger declaration file content or url
resultCode:
type: string
enum: [
"OK",
"EXCEPTION",
"BAD_REQUEST"
]
Suggest a Fix
As far as I know there is no single best implementation choice for enumerations in scala. Possible choices are:
- scala enumeration class (no warning for non-exhaustive match, type erasure issues)
- sealed case objects (no easy way of iterating through values, no default serialization / deserialization)
The serialization issue might not be a problem if circe supports it; still, scala enumerations might be easier to implement.
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 by locating the Finch generator entry points for inline and referenced schemas and reproduce both outputs from the supplied YAML. Compare the generated variable and empty case class with the intended enum representation; done requires an agreed Scala representation and coverage for both cases, including serialization behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- api, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100