> 1. We should ensure that information is never removed from command output, > unless it is deprecated and removed gracefully after some number of > releases. For JSON the existing field names and location in the JSON > structure should remain the same. > > 2. Information can be added to command output, and the output is still > considered compatible as all existing information is still present. > > 3. Following from (2), this means the format of the "Human Readable" output > may change if, for example, some new field or information is added on an > existing line, or new lines of output are added. > > 4. Due to (3), the "Human Readable" output is not intended to be consumed > programmatically. We recommend only JSON be consumed programmatically, as > existing structures will remain even if new information is added.
Thanks Stephen for the proposal. I agree on all 4 points. In addition to implementing JSON output for any commands where it makes sense and is missing, I think we should be writing any missing tests that verify JSON output to guarantee compatibility. -Attila --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@ozone.apache.org For additional commands, e-mail: dev-h...@ozone.apache.org
