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][GRADLE] missing documentation for systemProperties and additionalProperties #5979

Open
5 of 6 tasks
kleinph opened this issue Apr 19, 2020 · 0 comments
Open
5 of 6 tasks

Comments

@kleinph
Copy link

kleinph commented Apr 19, 2020

Bug Report Checklist

  • Have you provided a full/minimal spec to reproduce the issue? not relevant
  • Have you validated the input using an OpenAPI validator (example)? not relevant
  • What's the version of OpenAPI Generator used?
  • Have you search for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Bounty to sponsor the fix (example)
Description

The documentation for the gradle plugin is very unclear. The sections additionalProperties and systemProperties are mentioned, but not further documented. There should be documentation which describes the config options for this sections.

openapi-generator version

Version 4.3.1

OpenAPI declaration file content or url

Not relevant for documentation issue.

Command line used for generation

Not relevant for documentation issue.

Steps to reproduce

Read documentation at https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator-gradle-plugin. Try to understand what is allowed in systemProperties or additionalProperties

Related issues/PRs
Suggest a fix

Link to documentation explaining systemProperties and additionalProperties like it is done for configOptions

This may also be true for other openapi plugins (especially maven), but I only looked into the gradle one deeper.

@kleinph kleinph changed the title [BUG][GRADLE] documentation is very unclear [BUG][GRADLE] missing documentation for systemProperties and additionalProperties Apr 19, 2020
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

1 participant