Support normalizing anyof/oneof enum constraints to a single enum #21917
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
based on #21893 with updated samples, fixed python tests and fixed unit tests (case sensitive file names)
Fixes #15701
This changes the OpenAPINormalizer: If you specify a oneOf or an anyOf where the schema and subschemas have the no or the same type, and all contain just enums, it will change the schema to an enum schema.
this is to support the following format:
Which it now normalizes into:
Which is a relatively common workaround-pattern to support the lack of descriptive labels for enum values.
It supports both anyOf and oneOf, and works with numbers, booleans and strings.
It does not keep the title or description in the model. Doing that would probably require moving this from the normalizer to the model or code generator, as openAPI as far as I know has no way of keeping these titles in enum constants.
I made this behaviour configurable with the
SIMPLIFY_ONEOF_ANYOF_ENUMconfiguration option. I enabled it by defaultTo check, see the automated tests I added, and the example I added to the documentation.
Potential discussion topics:
instanceof StringSchema, or write a utility function that gets the type from the type of schema, instead of just calling ModelUtils.getType().Potential additions (not within my current scope):
processSimplifyAnyOfStringAndEnumString, which does something similar, but only works with two schemas, where one is a string and one an enum. By also recognizing strings, this new normalization feature could also replace this functionality in a more generic way. But that would break compatibility of the old configuration aptionPR checklist
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.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)