Optimize API parameter documentation and memory usage #2583
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.
Optimize API Parameter Documentation and Memory Usage
Motivation
The current implementation of parameter documentation in Grape can lead to unnecessary memory usage, especially for internal APIs where documentation is not required. This PR aims to optimize the way parameters are documented and stored, reducing memory footprint and improving efficiency.
Summary of Changes
ParamsDocumentationmodule inlib/grape/validations/params_documentation.rbto:do_not_documentis not set in the namespace).TypeCachefor type stringification, reducing repeated computation and memory usage.except_valuesin parameter documentation, which was previously missing. Now, parameters that specifyexcept_valueswill have this information included in the documentation output.Impact
except_valuesare now properly documented, improving the accuracy and completeness of generated API docs.Additional Notes