swagger-api / swagger-api/swagger-codegen
RxJava2 with retrofit2 generates wrong md doc
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
When I generate a Java client with {"useRxJava2":"true", "library":"retrofit2"} the generated docs are wrong, they don't match the api. Looks like it's just the standard java md-doc without the rxJava enhancements.
Swagger-codegen version
Version: 2.2.3 and 3.0.0-SNAPSHOT
Swagger declaration file content or url
can use Uber or any other example
Command line used for generation
java -jar /Users/rainer/bin/swagger-codegen-cli-2.2.3.jar generate -l java -o rx -i swagger.yaml -c rc2.cnf
rc2.cnf:
{"useRxJava2":"true", "library":"retrofit2"}
Steps to reproduce
- Generate code and look into the docs directory.
- md doc doesn't match (no Observables) the generated rx java api code.
Related issues/PRs
Suggest a fix/enhancement
Thanks,
Rainer Feike
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 reproducing the Java generation command with useRxJava2 enabled and library set to retrofit2, then compare the files in the generated docs directory with the generated RxJava API. Use the Uber example or another Swagger definition. Done means the Markdown documentation matches the generated API and includes the Observable-based signatures.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100