Bug 1881668

The BZ Fix should be in the API.

Created redmine issue https://projects.theforeman.org/issues/32703 from this bug

Moving this bug to POST for triage into Satellite since the upstream issue https://projects.theforeman.org/issues/32703 has been resolved.

FailedQE with Sat 7.0 snap 6.0.

The quotation marks are now correct but the example still uses 'id' column which is still not searchable:

```
# hammer user list --order 'id DESC'
400 Bad Request
  the field 'id' in the order statement is not valid field for search
```

I'd say it's OK to verify since the description says 

> Sort and order by a searchable field, e.g. 'id DESC'

Please, notice that there is explicit mention of a "searchable" field. The list of searchable fields is different for different entities. So, users entity can lack of this particular (id) searchable field, but other entities have this. This is simply a general description, it's not a call for an action.

The actual support for ordering by id for users was resolved in upstream in https://projects.theforeman.org/issues/33842.

Upstream bug assigned to aabramov

Oleh, it's not ok, this description is for `hammer user list` where `id` is never searchable, the example is wrong. (And yes, the general description is correct without the example.)

The description comes from the API and it's a general description for all the API endpoints and thus hammer commands.

The only way to resolve this BZ is to simply remove the example. Because I don't think it's a good idea to remove something general and add a specific description with a specific example for each endpoint to match the fields.

Unless you can offer a better solution, I'd vote for removal of the example.

How about '<column> DESC' as an example?
It would be more general but less of an example. Still better than removing it completely.
Without the example, it would be totally incomprehensible since there is no description of a correct syntax ('<column> <order>') - which can also be fixed easily.

Connecting redmine issue https://projects.theforeman.org/issues/34381 from this bug

FailedQA with Sat 6.11 snap 15.0.

# hammer user list --help | grep order
 --order VALUE                           Sort and order by a searchable field, e.g. 'id DESC'

# rpm -qa | grep ^foreman-3
foreman-3.1.1.9-1.el7sat.noarch

Verified with Sat 6.11 snap 16.0.

# rpm -qa | grep ^foreman-3
foreman-3.1.1.12-1.el7sat.noarch

# hammer user list --help | grep order
 --order VALUE                           Sort and order by a searchable field, e.g. '<field> DESC'

# hammer user list --order 'login DESC'
---|-------|------------|------------------------------|-------|----------|---------------------|--------------
ID | LOGIN | NAME       | EMAIL                        | ADMIN | DISABLED | LAST LOGIN          | AUTHORIZED BY
---|-------|------------|------------------------------|-------|----------|---------------------|--------------
4  | admin | Admin User | root@<FQDN> | yes   | no       | 2022/04/14 09:19:29 | Internal     
---|-------|------------|------------------------------|-------|----------|---------------------|--------------

# hammer host list --help | grep order
 --order VALUE                    Sort and order by a searchable field, e.g. '<field> DESC'

=> The help text is now general enough and the quotes are correct. Overall, the help text seems correct and only slightly less explanatory.

Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (Moderate: Satellite 6.11 Release), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHSA-2022:5498