Skip to content
GitLab
    • Explore Projects Groups Snippets
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Merge requests
  • !2579

Update README.md file with language specific parameters for Maven module

  • Review changes

  • Download
  • Email patches
  • Plain diff
Closed Administrator requested to merge github/fork/gursahibsahni/update-readme-with-language-specific-options into master 6 years ago
  • Overview 0
  • Commits 1
  • Pipelines 0
  • Changes 1

Created by: gursahibsahni

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\
  • Filed the PR against the correct branch: master, 3.4.x, 4.0.x. Default: master
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

The README.md file for OpenAPI code generator doesn't highlight about the language specific parameters. As a developer, it took me a while figuring out documentation for the implicitHeaders parameter to avoid seeing header parameters in the api generated request methods.

@bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03)

Compare
  • master (base)

and
  • latest version
    b34c1a81
    1 commit, 2 years ago

1 file
+ 6
- 0

    Preferences

    File browser
    Compare changes
modules/openapi-generator-maven-plugin/README.md
+ 6
- 0
  • View file @ b34c1a81


@@ -84,6 +84,12 @@ mvn clean compile
- `reservedWordsMappings` - specifies how a reserved name should be escaped to. Otherwise, the default `_<name>` is used. For example `id=identifier`. You can also have multiple occurrences of this option
- `skipIfSpecIsUnchanged` - Skip the execution if the source file is older than the output folder (`false` by default. Can also be set globally through the `codegen.skipIfSpecIsUnchanged` property)
### Language Specific Configuration Parameters
:bulb: These **language specific** configurations should be under the `configOptions` XML tag
- `implicitHeaders` - skips header parameters in the generated api methods (Only available if `generateApis` is `true`).
- `sourceFolder` - specifies generated folder path
### Custom Generator
0 Assignees
None
Assign to
0 Reviewers
None
Request review from
Labels
2
Issue: Bug Server: Spring
2
Issue: Bug Server: Spring
    Assign labels
  • Manage project labels

Milestone
No milestone
None
None
Time tracking
No estimate or time spent
Lock merge request
Unlocked
0
0 participants
Reference: OpenAPITools/openapi-generator!2407
Source branch: github/fork/gursahibsahni/update-readme-with-language-specific-options

Menu

Explore Projects Groups Snippets