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] [DART] The default readme file has missing/misleading information #9186

Closed
6 tasks
harsimranmaan opened this issue Apr 6, 2021 · 5 comments · Fixed by #9584
Closed
6 tasks

[BUG] [DART] The default readme file has missing/misleading information #9186

harsimranmaan opened this issue Apr 6, 2021 · 5 comments · Fixed by #9584

Comments

@harsimranmaan
Copy link
Contributor

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
openapi-generator version

5.1.1

Generation Details
java -jar ~/Downloads/openapi-generator-cli-5.1.0.jar generate -i trober.yaml -c config.yaml -g dart-dio-next -o trober_sdk -p pubVersion=1.1.1
Steps to reproduce

Generate a dart package with the dart-dio-next generator. Observe that the README.md has missing information for author and incorrect links to generated docs when published on pub.dev. eg: See https://pub.dev/packages/trober_sdk

Related issues/PRs
Suggest a fix

Requires fixes to the README.md template. would send a PR with fixes.

@kuhnroyal
Copy link
Contributor

@harsimranmaan Do you consider this solved with #9201?

@NANASHI0X74
Copy link
Contributor

I've run into this as well... AFAICT the README examples and documentation generated are still wrong, for example it will tell me to do something like this:

var api_instance = new CompaniesApi();

while the companiesApi constructor requires two arguments.

So now instead I'm looking at the tests generated that I found via looking into the changed files in #8869:
https://github.com/kuhnroyal/openapi-generator/blob/8240a4fbafff6ddb93d1e992488efb4a6d0c391b/samples/client/petstore/dart-dio/petstore_client_lib/test/pet_api_test.dart#L14-L15
where did that file go in the current master btw?

@NANASHI0X74
Copy link
Contributor

huh, was the dio generator's doc template already wrong before the migration to null safety? I just tried migrating from the default dart generator

@kuhnroyal
Copy link
Contributor

Yes it was.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants