CLOUDP-184341: add flag for compacting list results #2009
Conversation
matt-condon
force-pushed
the
fix/compactListResults
branch
from
62e00de to
60de93b
Compare
matt-condon
force-pushed
the
fix/compactListResults
branch
from
f9b657e to
786d382
Compare
| - Type | ||
| - Required | ||
| - Description | ||
| * - -c, --compact |
There was a problem hiding this comment.
I might be missing context. Did we agree for this flag to be present in docs (not hidden?)
There was a problem hiding this comment.
Jakub flagged that he wanted a note in --help for affected commands, which for me implies that it should be present in docs
Add note to --help for affected commands that provide a short explanation for the relevant (affected) CLI versions
| - Type | ||
| - Required | ||
| - Description | ||
| * - -c, --compact |
There was a problem hiding this comment.
--compact as name and description suggests feature but in reality is introduced only to support backward compatibility. Names are hard but if we can add something more descriptive:
--legacy-output
--old-format
Etc.
There was a problem hiding this comment.
Sure I'm happy to go with that
There was a problem hiding this comment.
Chatted offline. Compact seems much better as we do not use old SDK and this flag can stay with us without removal
|
Awesome work. If the decision is to make those flags temporary we might add some notes to the code to remeber to remove them at specific moment of time |
sarahsimpers
left a comment
sarahsimpers
left a comment
There was a problem hiding this comment.
A couple thoughts on wording for the flag
Co-authored-by: Sarah Simpers <82042374+sarahsimpers@users.noreply.github.com>
sarahsimpers
left a comment
sarahsimpers
left a comment
There was a problem hiding this comment.
LGTM, thanks for the changes!
Proposed changes
Jira ticket: CLOUDP-184341
In releases 1.7.x, with the integration of the new automated Go SDK, we introduced breaking change to several "list" commands that modified the response structure for "--output json"
This PR is to introduces a flag "--compact" to revert the behaviour for the same specific set of list commands, so that users can modify their scripts with the "-c" flag to align their scripts with the previous behavior
Checklist
make fmtand formatted my codeFurther comments