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

Make the OpenAPINormalizer extensible #20995

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jpfinne
Copy link
Contributor

@jpfinne jpfinne commented Mar 30, 2025

fix #20994

Allow configuration of the OpenAPINormalizer
New normalizer rule: NORMALIZER_CLASS to provide the class name of the extended OpenAPINormalizer.

Change the private modifiers to protected to allow overriding and extensions of behaviour.

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.

Add comment to force rebuild
* @param visitedSchemas a set of visited schemas
* @return Schema
*/
protected Schema doNormalizeSchema(Schema schema, Set<Schema> visitedSchemas) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the PR

which looks good overall

but what's the reason behind to further breaking down normalizeSchema with 1 additional function doNormalizeSchema?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but what's the reason behind to further breaking down normalizeSchema with 1 additional function doNormalizeSchema?

public Schema normalizeSchema(Schema schema, Set<Schema> visitedSchemas) {
has 2 purposes:

  1. check if not already processed
  2. perform the actual normalization

I want to be able to override the 2.

Another option is to keep the original normalizeSchema and be sure that all options can be overriden.
For example, there is a need to uncomment the handling of normalizeAdditionalProperties

     if (schema.getAdditionalProperties() != null) {
           normalizeAdditionalProperties(m, visitedSchemas);
     }

or split the normalization of composed schema:

} else if (ModelUtils.isComposedSchema(schema)) { // composed schema
   return normalizeComposedSchema(schema, schemaVisited);
}

and copy the content of the inner block to the new protected Schema normalizeComposedSchema() method

@wing328 wing328 added Enhancement: General OpenAPI Normalizer Normalize the spec for easier processing labels Apr 7, 2025
@wing328 wing328 added this to the 7.13.0 milestone Apr 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement: General OpenAPI Normalizer Normalize the spec for easier processing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[REQ] Make OpenApiNormalizer extensible
2 participants