Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG][scala-akka] generates a readme linking to model docs that don't exist #10242

Closed
5 of 6 tasks
ckipp01 opened this issue Aug 24, 2021 · 1 comment
Closed
5 of 6 tasks

Comments

@ckipp01
Copy link

ckipp01 commented Aug 24, 2021

Bug Report Checklist

  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

While using scala-akka generator it seems impossible to get the model docs generated. For example, I followed the instructions similar to those in the WIKI to test this against the current master branch:

git clone https://github.com/openapitools/openapi-generator.git
cd openapi-generator
mvn clean install
java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate \
  -i modules/openapi-generator/src/test/resources/3_0/scala-akka/petstore.yaml \
  -o scala-test
  -g scala-akka

After doing this you'll see that there is a README.md created that has the following section:

## Documentation for Models

 - [ApiResponse](ApiResponse.md)
 - [Category](Category.md)
 - [Order](Order.md)
 - [Pet](Pet.md)
 - [Tag](Tag.md)
 - [User](User.md)

However, none of these model docs actually exist.

openapi-generator version

The last commit at the time of checking this is 158649a

OpenAPI declaration file content or url

https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/3_0/scala-akka/petstore.yaml

Generation Details

Just follow the steps up above in the description

Steps to reproduce

Just follow the steps up above in the description

Related issues/PRs

Not exactly sure if these are the same or related, but they all seems to have to do with scala-akka and doc generation not working as expected.

#8966
#5795

Suggest a fix

I'm pretty unfamiliar with how this is all supposed to work, so no idea.

@wing328
Copy link
Member

wing328 commented Feb 22, 2022

Closed via the PR by @nMoncho

Please pull the latest master to give it another try.

@wing328 wing328 closed this as completed Feb 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants