openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

enable User-defined templates to work with the gradle plugin #13705

Open Mintas opened this issue 3 years ago • 9 comments

fix https://github.com/OpenAPITools/openapi-generator/issues/13705 (more detail on issue)

Client is expected to use files as Map<String, Map<String,String>>, where external key - is TemplateDefinition.templateFile, and internal map contains fieldName<>value mapping for other fields in TemplateDefinitions, thus keys are: folder (string, default ""), destinationFilename (string), templateType(string, name of TemplateFileType enum constant, default "SupportingFiles").

Example:

    openApiGenerate {
        generatorName = "spring"
        templateDir = file("templates").absolutePath
        files = [
            "my.mustache": ["templateType": "Model", "destinationFilename":"My.java"]
        ]
    }

for more info, see User-defined Templates Customization docs

PR checklist

  • [x] Read the contribution guidelines.
  • [x] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • [x] Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*. For Windows users, please run the script in Git BASH.
  • [x] File the PR against the correct branch: master (6.3.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
  • [x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Mintas avatar Nov 25 '22 05:11 Mintas

@Mintas thanks for the PR. When you've time, can you please PM me via Slack for a quick chat (IM) ?

ref: https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g

wing328 avatar Nov 25 '22 07:11 wing328

I have the same issue: my custom templates are not picked up for the openApiGenerate task. Would it be possible to do a release with this fix?

narenmanoharan avatar Jan 17 '23 15:01 narenmanoharan

@narenmanoharan Hi! Glad that you have asked! Haven't been here for a while. Will continue my attemps to push my PR to release =)

Mintas avatar Jan 17 '23 15:01 Mintas

@narenmanoharan Hi! Glad that you have asked! Haven't been here for a while. Will continue my attemps to push my PR to release =)

Thanks for fixing this! :)

narenmanoharan avatar Jan 17 '23 16:01 narenmanoharan

@wing328 lets merge this one?)

Mintas avatar Feb 02 '23 08:02 Mintas

@borsch probably you can help merging this PR ?

Mintas avatar Feb 03 '23 10:02 Mintas

@Mintas could you add similar feature to maven plugin?

borsch avatar Feb 03 '23 13:02 borsch

@borsch may be in another issue and PR, cos I dont have enough spare time unfortunately =(

Mintas avatar Feb 05 '23 07:02 Mintas

@Mintas can you please resolve the merge conflicts? I'll try to get this into v7.0.0

sorry for the delay in reviewing and getting it merged as there are too many PRs.

wing328 avatar Aug 11 '23 01:08 wing328