Skip to content
GitLab

sbt plugin for OpenAPI Generator

Closed Administrator requested to merge github/fork/chameleon82/openapi-generator-sbt-plugin into master

Created by: chameleon82

Regarding to #3650 sbt plugin for OpenAPI Generator added

Few concerns about this PR:

  • need to define which repositories this artefact will be published. At least, for sbt community it should be published to https://bintray.com/sbt/sbt-plugin-releases, I believe @eed3si9n can help us on it. (continued here https://github.com/OpenAPITools/sbt-openapi-generator/issues/5)
  • plugin name convention. Following OpenApi artefact should be named as openapi-generator-sbt-plugin, but sbt plugin best practices recommends to name it as sbt-openapi-generator. Resolution: sbt-openapi-generator as separate project
  • settings name convention. Right now all settings haven't prefix, but sbt has only global domain for all settings which can be conflicted with other sbt plugins. Should we change it following sbt best practices? Sbt recommends to reuse default settings if possible, but not much settings we can. Alternate way to keep original names for settings is to put all openapi settings in separate openapiSettings case class, but in this case sbt will loose description of each setting (which probably ok) Resolution: openApi prefix
  • maven integration. As i understand it is possible to build plugin with maven (sbt integration tests still require sbt anyway) and integrate this module as part of project, but have no experience on it. Resolution: don't needed as moved to separate project
  • should plugin support src_managed directory for generated files? Resolution: up to user. will be better described in README

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the (technical committee)[https://github.com/openapitools/openapi-generator/#62---openapi-generator-technical-committee] to review the pull request if your PR is targeting a particular programming language.

@jimschubert @wing328 @YanDoroshenko