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
  • !2592

[Doc] Better highlight of generators docs page with generators specific parameters

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/karismann/Doc-Better-highlight-of-generators-docs-page into master 6 years ago
  • Overview 0
  • Commits 2
  • Pipelines 0
  • Changes 3

Created by: karismann

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.

Description of the PR

see #2579 (discussion)

Compare
  • master (base)

and
  • latest version
    9cdbcfa1
    2 commits, 2 years ago

3 files
+ 4
- 2

    Preferences

    File browser
    Compare changes
do‎cs‎
usag‎e.md‎ +2 -0
mod‎ules‎
openapi-generat‎or-gradle-plugin‎
READM‎E.adoc‎ +1 -1
openapi-generat‎or-maven-plugin‎
READ‎ME.md‎ +1 -1
docs/usage.md
+ 2
- 0
  • View file @ 9cdbcfa1

  • Edit in single-file editor

  • Open in Web IDE


@@ -426,6 +426,8 @@ To pass more than one generator property, these can be combined via comma:
--additional-properties=key1=value1,key2=value2
```
For the full list of generator-specified parameters, refer to [generators docs]((./generators.md))
#### Type Mappings and Import Mappings
Most generators allow for types bound to the OpenAPI Specification's types to be remapped to a user's desired types. Not _all_ type mappings can be reassigned, as some generators define mappings which are tightly coupled to the built-in templates.
modules/openapi-generator-gradle-plugin/README.adoc
+ 1
- 1
  • View file @ 9cdbcfa1

  • Edit in single-file editor

  • Open in Web IDE


@@ -266,7 +266,7 @@ The gradle plugin is not currently published to https://plugins.gradle.org/m2/.
|configOptions
|Map(String,String)
|None
|A map of options specific to a generator.
|A map of options specific to a generator. To see the full list of generator-specified parameters, please refer to [generators docs](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators.md)
|logToStderr
|Boolean
modules/openapi-generator-maven-plugin/README.md
+ 1
- 1
  • View file @ 9cdbcfa1

  • Edit in single-file editor

  • Open in Web IDE


@@ -51,7 +51,7 @@ mvn clean compile
- `invokerPackage` - the package to use for the generated invoker objects
- `modelNamePrefix` and `modelNameSuffix` - Sets the pre- or suffix for model classes and enums
- `withXml` - enable XML annotations inside the generated models and API (only works with Java `language` and libraries that provide support for JSON and XML)
- `configOptions` - a map of language-specific parameters. To show a full list of generator-specified parameters (options), please use `configHelp` (explained below)
- `configOptions` - a map of language-specific parameters. To show a full list of generator-specified parameters (options), please use `configHelp` (explained below) or refer to [generators docs](../../docs/generators.md)
- `configHelp` - dumps the configuration help for the specified library (generates no sources)
- `ignoreFileOverride` - specifies the full path to a `.openapi-generator-ignore` used for pattern based overrides of generated outputs
- `removeOperationIdPrefix` - remove operationId prefix (e.g. user_getName => getName)
0 Assignees
None
Assign to
0 Reviewers
None
Request review from
Labels
2
Client: Swift Issue: Bug
2
Client: Swift Issue: Bug
    Assign labels
  • Manage project labels

Milestone
5.0.0
5.0.0 (expired)
None
Time tracking
No estimate or time spent
Lock merge request
Unlocked
0
0 participants
Reference: OpenAPITools/openapi-generator!7527
Source branch: github/fork/karismann/Doc-Better-highlight-of-generators-docs-page

Menu

Explore Projects Groups Snippets