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

Enhancement: Allow MergedSpecBuilder title, version and description to be configured to fix [#20822] #20839

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

saulgillEST
Copy link

Allow MergedSpecBuilder title, version and description to be configured to fix #20822

I have made small changes to MErgedSpecBuilder and CodeGenMojo to allow users of the openapi-generator-maven-plugin to add a custom info header in merged open api files.

Before making this change, the fields in the info header were hard-coded as title="merged spec", description="merged spec" and version=1.0.0

Now, through the use of 3 maven plugin tags, the setting of these fields by the user of the plugin is now possible. An example is provided below. With these changes, one can easily verify that the new plugin configuration is being adopted. The new info header values will appear in the open api file and any generated documentation too.

<configuration>
	<inputSpecRootDirectory>some-directory</inputSpecRootDirectory>
	<mergedFileName>openapi-file</mergedFileName>  <!-- Merged output file -->
	<mergedFileInfoName>My Info Name/Title</mergedFileInfoName>
	<mergedFileInfoDescription>My Description</mergedFileInfoDescription>
	<mergedFileInfoVersion>1.0.0</mergedFileInfoVersion>
	<generatorName>openapi-yaml</generatorName>  <!-- Change based on required language -->
</configuration>`

The default values remain the same as before. Old functionality is not impacted at all.

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08)

PR checklist

  • Read the contribution guidelines.
  • 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.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in Git BASH)
    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*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@JohnKeeneyEST
Copy link

Looks good. Thanks.

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

Successfully merging this pull request may close these issues.

[REQ] Allow MergedSpecBuilder title, version and description to be configured
3 participants