search

canonical / ubuntu-pro-client

Ubuntu Pro Client for offerings from Canonical
https://canonical-ubuntu-pro-client.readthedocs-hosted.com/en/latest/
GNU General Public License v3.0
56 stars 75 forks source link

Feature: extend warning about human-readable output to all commands which have API alternatives #3045

Open renanrodrigo opened 7 months ago

renanrodrigo commented 7 months ago

Please describe the scenario where the new feature would be useful

We currently have a warning printed to stderr when running a command that is supposed to be human readable on scripts (actually, anywhere but a TTY). Those are implemented based on the """old""" --format json|yaml machine readable formats. The coverage is only status and security-status. We could instead put this warning anywhere but the API - so people consuming from Pro at least get a hint that they should not automate things based on human-readable output.

Describe the solution you'd like

Exactly what is implemented now for pro status and pro security-status, but for all commands that are supposed to present human readable output.

Current behavior

As described, only status and security-status have this implemented.

Additional context

This request reached us during the UX review process, and was considered good enough to justify this issue for the future. Tackling this one can wait until the new UX is actually implemented.

Hooloovoo commented 7 months ago

A specific mapping would be nice, if possible, for example pointing people using pro system reboot-required to https://canonical-ubuntu-pro-client.readthedocs-hosted.com/en/latest/references/api/#u-pro-security-status-reboot-required-v1 rather than just a generic warning.

renanrodrigo commented 5 months ago

Will do our best to solve this as part of the current UX redesign - if it is not there immediately, then we can do it at some future iteration