Skip to content
GitLab

[Spring] Support disabling ApiIgnore & Pageable imports

Closed Administrator requested to merge github/fork/morphlne/fix_apiignore_and_pageable into master

Created by: morphlne

Issues

To fix https://github.com/OpenAPITools/openapi-generator/issues/8360, https://github.com/OpenAPITools/openapi-generator/issues/8192, https://github.com/OpenAPITools/openapi-generator/issues/8916, https://github.com/OpenAPITools/openapi-generator/issues/8776

Description

Support for vendor extension x-spring-paginated added in https://github.com/OpenAPITools/openapi-generator/pull/5022 provides non-configurable imports:

import org.springframework.data.domain.Pageable;
import springfox.documentation.annotations.ApiIgnore;

Both imports appears even if x-spring-paginated is not specified. Those imports are undesirable cause they demand additional dependencies, otherwise compilation fails.

Suggested fix

The PR adds config option for separately disabling imports usePageable, useApiIgnore. Both options are true by default for backward compatibility.

Alternative approach

On other hand, imports can be simple disabled using {{vendorExtension.x-spring-paginated}} without new configs, but i believe, that generator behavior should depends on generator config, not on API description.

Tests

Added generated samples with new config options

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.
  • If contributing template-only or documentation-only changes which will change sample output, build the project beforehand.
  • Run 
    mvn clean package
./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh
    to update all Petstore samples related to your fix. 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*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master, 5.1.x, 6.0.x
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.