a setting for disabling documentation to internal APIs #2233
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.
Our application has 3 APIs, 2 of them are internal and don't require documentation. However, there has not been any option to prevent Grape from documenting parameters for internal APIs.
This change adds a
do_not_document!
setting which instructs Grape to not document parameters, thus needless objects allocation is avoided.The logic for documenting parameters was moved to a separate class, the
Grape::Validations::ParamsScope
class has to many responsibilities, it would be better to split it.Our API has lots of endpoints like this:
With documentation:
Without documentation:
1,78 Kb is saved.