SaltGUI icon indicating copy to clipboard operation
SaltGUI copied to clipboard

should always use full_return

Open erwindon opened this issue 6 years ago • 4 comments

Is your feature request related to a problem? Please describe. Some commands return only very simple information, like true/false. This is indistinguishable from the return of false on a timeout.

Describe the solution you'd like The API should use full_return as much as possible. The response from that clearly indicates success/failure as well as a separate result.

Update: while the data is better separated from the meta-data, it does not indicate success/failure. instead, it provided a result-code separate from the results. but the indication for success/failure is still missing.

Update: this is only relevant for free-format commands, not for the internal commands. When internal commands fail we don't show much extra information anyway.

Update: this must be arranged as a setting saltgui_use_full_return: True (default: False) as this is a breaking change. not only will the gui show different output, also the job history as maintained by the SaltStack system will change a little bit. And that may be an unpleasant surprise for some.

erwindon avatar Apr 14 '19 19:04 erwindon

retrieving setting is done TODO: use setting in many places TODO: testing

erwindon avatar Apr 18 '22 19:04 erwindon

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

sonarqubecloud[bot] avatar Nov 12 '22 21:11 sonarqubecloud[bot]

with full_return, also the JID is returned. this allows SaltGUI to jump directly to the JOB view for that

erwindon avatar Nov 15 '22 19:11 erwindon

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

sonarqubecloud[bot] avatar Jan 08 '23 20:01 sonarqubecloud[bot]