swagger-api / swagger-api/swagger-codegen
[Scala] Inconsistency between *Api and *ApiAsyncHelper default parameters
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
In #6538, we defaulted non-required Option parameters to None for both sync and async methods in the *Api classes. However, the helper methods in *ApiAsyncHelper (which the methods in *Api simply wrap) default to defaultValue which is inconsistent and also error prone (will open a separate issue for this, but see https://github.com/swagger-api/swagger-codegen/pull/6538#discussion_r140950422 for context /cc @wing328).
Swagger-codegen version
2.3.0
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 Scala generator templates that produce *Api and *ApiAsyncHelper methods, then compare their default handling for non-required Option parameters. Use the behavior established in #6538 as the reference; done means the helper defaults are consistent with the corresponding API methods and the generated output remains valid.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100