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

Set removeEnumValuePrefix to false by default #20452

Merged
merged 2 commits into from
Jan 13, 2025

Conversation

wing328
Copy link
Member

@wing328 wing328 commented Jan 13, 2025

cc @OpenAPITools/generator-core-team

To fallback, simply set the option to true

e.g. --additional-properties removeEnumValuePrefix=true

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.

@wing328 wing328 changed the title et removeEnumValuePrefix to false by default Set removeEnumValuePrefix to false by default Jan 13, 2025
@wing328 wing328 added this to the 7.11.0 milestone Jan 13, 2025
@wing328 wing328 marked this pull request as ready for review January 13, 2025 08:24
@wing328 wing328 merged commit 09530b4 into master Jan 13, 2025
79 checks passed
@wing328 wing328 deleted the removeEnumValuePrefix-default branch January 13, 2025 08:25
danhumphreys-moj added a commit to ministryofjustice/hmpps-approved-premises-api that referenced this pull request Jan 23, 2025
In version 7.7 generating documentation via the openApi gradle task results in the following misleading warning:

"More than one inline schema specified in allOf:. Only the first one is recognized. All others are ignored."

See comments on this [PR](OpenAPITools/openapi-generator#19646).

In later versions of the plugin - and rather than fixing the issue - the severity of the warning has been reduced from [WARN to DEBUG](https://github.com/OpenAPITools/openapi-generator/pull/19646/files).

Also set removeEnumValuePrefix = true since this is a new additional property added to more recent versions which removes the prefix for enum definitions.  Previously in version 7.7 prefixes were removed automatically and the property didn't exist.  Since it [defaults to false](OpenAPITools/openapi-generator#20452), we need to set it to true.  Unfortunately this property isn't documented in the [README](OpenAPITools/openapi-generator#20452).
danhumphreys-moj added a commit to ministryofjustice/hmpps-approved-premises-api that referenced this pull request Jan 23, 2025
In version 7.7 generating documentation via the openApi gradle task results in the following misleading warning:

"More than one inline schema specified in allOf:. Only the first one is recognized. All others are ignored."

See comments on this PR: OpenAPITools/openapi-generator#19646.

In later versions of the plugin - and rather than fixing the issue - the severity of the warning has been reduced from WARN to DEBUG.  See: https://github.com/OpenAPITools/openapi-generator/pull/19646/files.

Also set removeEnumValuePrefix = true since this is a new additional property added to more recent versions which removes the prefix for enum definitions.  Previously in version 7.7 prefixes were removed automatically and the property didn't exist.  Since it defaults to false we need to set it to true.  See OpenAPITools/openapi-generator#20452).

Unfortunately this property isn't documented in the README OpenAPITools/openapi-generator#20452.
danhumphreys-moj added a commit to ministryofjustice/hmpps-approved-premises-api that referenced this pull request Jan 23, 2025
In version 7.7 generating documentation via the openApi gradle task results in the following misleading warning:

"More than one inline schema specified in allOf:. Only the first one is recognized. All others are ignored."

See comments on this PR: OpenAPITools/openapi-generator#19646.

In later versions of the plugin - and rather than fixing the issue - the severity of the warning has been reduced from WARN to DEBUG.  See: https://github.com/OpenAPITools/openapi-generator/pull/19646/files.

Also set removeEnumValuePrefix = true since this is a new additional property added to more recent versions which removes the prefix for enum definitions.  Previously in version 7.7 prefixes were removed automatically and the property didn't exist.  Since it defaults to false we need to set it to true.  See OpenAPITools/openapi-generator#20452.

Unfortunately this property isn't documented in the README https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/kotlin-server.md#config-options.
danhumphreys-moj added a commit to ministryofjustice/hmpps-approved-premises-api that referenced this pull request Jan 23, 2025
In version 7.7 generating documentation via the openApi gradle task results in the following misleading warning:

"More than one inline schema specified in allOf:. Only the first one is recognized. All others are ignored."

See comments on this PR: OpenAPITools/openapi-generator#19646.

In later versions of the plugin - and rather than fixing the issue - the severity of the warning has been reduced from WARN to DEBUG.  See: https://github.com/OpenAPITools/openapi-generator/pull/19646/files.

Also set removeEnumValuePrefix = true since this is a new additional property added to more recent versions which removes the prefix for enum definitions.  Previously in version 7.7 prefixes were removed automatically and the property didn't exist.  Since it defaults to false we need to set it to true.  See OpenAPITools/openapi-generator#20452.

Unfortunately this property isn't documented in the README https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/kotlin-server.md#config-options.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant