Fixes #37587 - Reuse API parameter handling from base #11126
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This method has been unused since ElasticSearch was dropped. Fixes: 26cbfb4 ("Refs #11753 - remove elastic search from content view filter rules")
Foreman's API base controller provides a search_and_pagination parameter group that has all the fields needed. Then it also provides some helpers to parse these values properly. This reuses those helpers. It also aligns on per_page=all handling instead of a separate full_result=true. That parameter is now deprecated.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What are the changes introduced in this pull request?
Foreman's API base controller provides a
search_and_paginationparameter group that has all the fields needed. Then it also provides some helpers to parse these values properly.This reuses those helpers. It also aligns on
per_page=allhandling instead of a separatefull_result=true. That parameter is now deprecated.Considerations taken when implementing this change?
This doesn't go all the way and reuse Foreman's
resource_scope_for_indexsince that's a much bigger refactor. Katello's API method here is also bigger and allows more options. Whether that's a good thing is questionable, but one I didn't have time to look at.Long term I'd like to see both APIs aligned. If Foreman's base controller should be extended, that's entirely possible.
Right now it's a very much untested idea based on what I saw in #11124.
What are the testing steps for this pull request?
There should be no regressions in the API. Since it touches on the base API, that can be difficult to test.