Skip to content

Property to exclude packages and paths from documentation #404

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

Closed
ilaktasic opened this issue Feb 5, 2020 · 1 comment
Closed

Property to exclude packages and paths from documentation #404

ilaktasic opened this issue Feb 5, 2020 · 1 comment
Labels
enhancement New feature or request

Comments

@ilaktasic
Copy link

Is your feature request related to a problem? Please describe.
Projects I'm working on have package by feature structure and most controllers need to be documented. Let's say there are two "maintenance" endpoints which are hidden. So there are two options to exclude documents from documentation

  1. Add @Hidden annotation to controllers:
    I'm not fond of adding extra annotations like @Hidden to code to disable default behavior if
    behavior can be changed.

  2. Add all packages to which need to be documented to springdoc.packagesToScan property:
    There would be too many packages in property and every time new controller is added property needs to be updated because of package by feature structure controllers are not in the same package.

Describe the solution you'd like
It would be useful to have property to exclude packages or paths from documentation.
For example: springdoc.packagesToExclude and springdoc.pathsToExclude properties.

@bnasslahsen
Copy link
Collaborator

Hi @ilaktasic,

The support will be added on v1.2.31.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants