What about API (and CLI) being version-compatible? This can break existing scripts.

It's true, but I'm willing to break any such scripts in this case. It is reasonable to enforce a comment requirement.

This should be 'Comment is a required argument.'.

:+1: to the gist from me. One comment about about the text in the error response.

The comment should be ok now.
Let's wait also for @dcallagh opinion.

s/arguments/argument/

Yeah, in all our examples we have always shown it with --comment, I think because we always intended from the start that the comment should be mandatory. So I think the risk of breaking anyone here is low.

It might be nice if we could document somewhere why it's required. Maybe in the man page for the CLI that doesn't exist :-) I always hate when some tool tells me "you must supply this" but it's not obvious why it is making me do it.

It might be nice if we could document somewhere why it's required. Maybe in the man page for the CLI that doesn't exist :-) I always hate when some tool tells me "you must supply this" but it's not obvious why it is making me do it.

I like how --help shows "This is fine" as an example comment :) ... but it's still not obvious that the comment is required parameter (though it shouldn't be required for the new --get argument - #159).

Would it be ok to put that the parameter is required in the help and then add in the README file an explanation of why it's required? The same for all the other required parameters...

Hmm yeah there are lots of things we could improve about the docs and --help output. I think let's merge this as is, and I will put up something separately for docs.

Oh just the typo in api_v1.py needs fixing though.

It should be ok now.

+1

uff.. Please waite a sec to merge it. This breaks the greenwave's functional tests. I'll submit a greenwave PR as soon as possible.

greenwave's PR: https://pagure.io/greenwave/pull-request/164

:+1: