Skip to content
GitLab

Mark postProcessOperations(Map) as deprecated

Merged Administrator requested to merge github/fork/jmini/mark_postProcessOperations_as_deprecated into master

Created by: jmini

Instead of postProcessOperations(Map)

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 and ./bin/security/{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.1.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language. @OpenAPITools/generator-core-team

Description of the PR

On Codegen Classes we have 2 methods that are similar and redundant:

  • Map<String, Object> postProcessOperations(Map<String, Object> objs)
  • Map<String, Object> postProcessOperationsWithModels(Map<String, Object> objs, List<Object> allModels)

They are called at the exact same place with the difference that postProcessOperationsWithModels(..) also gives access to the list of models.

This PR marks postProcessOperations(..) as deprecated and recommend to use postProcessOperationsWithModels(..) instead.

In a future major release (like 4.0.0) we might want to remove postProcessOperations(..) in order to avoid redundant similar methods in our API.