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.

Sign up for GitHub

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

Jump to bottom

Adjusted Maven plugin configuration options documentation #1524

Merged
merged 1 commit into from
Jul 29, 2023
Merged

Adjusted Maven plugin configuration options documentation #1524

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions tools/maven-plugin/README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ E.g. for includeDependenciesScopes could be configured as:
- `attachArtifacts` (boolean, default: false) - Attach the built OpenAPI schema as build artifact.
- `skip` (boolean, default: false) - Skip execution of the plugin.
- `encoding` (String) - Encoding of output OpenAPI files.
- `outputFileTypeFilter` (String) - Set this to "YAML" in order to let the generation process produce just *.yaml output, "JSON" to obtain *.json files only. The default is "ALL", which will generate both file types.
- `outputFileTypeFilter` (String, default: ALL) - Set this to `YAML` in order to let the generation process produce just *.yaml output, `JSON` to obtain *.json files only. The default is `ALL`, which will generate both file types.

== MicroProfile OpenAPI Properties

Expand Down Expand Up @@ -88,4 +88,4 @@ All properties from the SmallRye OpenAPI Implementation is supported. Properties
- `CLASS_METHOD` - The class name and method name is used as operationId.
- `PACKAGE_CLASS_METHOD` - The fully qualified class name and method name is used as operationId.
- `scanProfiles` (List<String>) - Profiles which explicitly include operations. Any operation without a matching profile is excluded.
- `scanExcludeProfiles` (List<String>) - Profiles which explicitly exclude operations. Any operation without a matching profile is included.
- `scanExcludeProfiles` (List<String>) - Profiles which explicitly exclude operations. Any operation without a matching profile is included.