Actions
Bug #18341
closedAPI sort hash is not working, but sort_by and sort_order are working but undocumented
Difficulty:
Triaged:
Yes
Bugzilla link:
Pull request:
Description
Cloned from https://bugzilla.redhat.com/show_bug.cgi?id=1138262
Description of problem:
In the API the order option is working. The documented sort hash is not working. There are undocumented sort_by and sort_order that are working instead.
Not working sort hash:
# curl -K /opt/hoici/etc/curl-admin.conf -H 'Content-Type: application/json' -d '{"per_page":"9999","sort":{"by":"name","order":"desc"}}' -XGET https://localhost/katello/api/v2/organizations/4/products | jq . | tail -n10 "sort": { "order": null, "by": null }, "search": null, "per_page": "9999", "page": 1, "subtotal": 19, "total": 19 }
Working order:
# curl -K /opt/hoici/etc/curl-admin.conf -H 'Content-Type: application/json' -d '{"per_page":"9999","order":"name desc"}' -XGET https://localhost/katello/api/v2/organizations/4/products | jq . | tail -n10 "sort": { "order": "desc", "by": "name" }, "search": null, "per_page": "9999", "page": 1, "subtotal": 19, "total": 19 }
Working sort_by and sort_order:
# curl -K /opt/hoici/etc/curl-admin.conf -H 'Content-Type: application/json' -d '{"per_page":"9999","sort_by":"name","sort_order":"desc"}' -XGET https://localhost/katello/api/v2/organizations/4/products | jq . | tail -n 10 "sort": { "order": "desc", "by": "name" }, "search": null, "per_page": "9999", "page": 1, "subtotal": 19, "total": 19 }
Expected results:
Consistent API functionality and documentation for sorting the results
Updated by Tomáš Strachota almost 8 years ago
- Blocks Bug #18340: Hammer params for ordering are inconsistent added
Updated by Justin Sherrill almost 8 years ago
- Subject changed from API sort hash is not working, but sort_by and sort_order are working but undocumented to API sort hash is not working, but sort_by and sort_order are working but undocumented
- Category set to API
- Translation missing: en.field_release set to 114
Updated by Tomáš Strachota about 7 years ago
Ideally we unify the parameters with 'order' and 'by' that foreman uses today.
The steps should be:
The steps should be:
- document the params correctly in the API of Katello
- fix the systems to use only one set of params for ordering (backward compatibility needs to be kept)
- add deprecation warnings when the old params are used
Updated by The Foreman Bot about 6 years ago
- Status changed from New to Ready For Testing
- Pull request https://github.com/Katello/katello/pull/7707 added
Updated by Oleh Fedorenko about 6 years ago
- Assignee deleted (
Bryan Kearney)
Assigned to Oleh Fedorenko (https://projects.theforeman.org/users/9990)
Also the description is not quite correct.
Working order actually:
# curl -K /opt/hoici/etc/curl-admin.conf -H 'Content-Type: application/json' -d '{"per_page":"9999","order":"name desc"}' -XGET https://localhost/katello/api/v2/organizations/4/products | jq . | tail -n10 "sort": { "order": "desc", "by": "name" }, "search": null, "per_page": "9999", "page": 1, "subtotal": 19, "total": 19 }
and not working sort hash:
# curl -K /opt/hoici/etc/curl-admin.conf -H 'Content-Type: application/json' -d '{"per_page":"9999","sort":{"by":"name","order":"desc"}}' -XGET https://localhost/katello/api/v2/organizations/4/products | jq . | tail -n10 "sort": { "order": null, "by": null }, "search": null, "per_page": "9999", "page": 1, "subtotal": 19, "total": 19 }
Updated by Tomáš Strachota about 6 years ago
- Description updated (diff)
I mixed section headings when I was reporting the bug. Sorry for that, it's fixed now.
Updated by Oleh Fedorenko about 6 years ago
- Status changed from Ready For Testing to Closed
Applied in changeset katello|0488a25ffdf8da51114d3d84c535fb09038b5922.
Actions