]
Rostislav Svoboda reopened AS7-1758:
------------------------------------
Hi Alexey.
Please reconsider reject on this issue.
I think it could be quite helpful for users to have consistent way to get help for
commands and operations.
$ :upload-deployment-url --help would be transformed to
:read-operation-description(name="upload-deployment-url")
For me it's just wrapper which transforms command to :read-operation-description
operation, but maybe there are implementation details which makes it little bit
complicated.
Users would just remember that they need to specify '--help' option to whatever
command/operation and they will receive help.
Remembering ':read-operation-description(name="whatever-operation")' is
quite complicated if you don't use CLI on daily basis.
CLI usability: operations need convenient help option too
---------------------------------------------------------
Key: AS7-1758
URL:
https://issues.jboss.org/browse/AS7-1758
Project: Application Server 7
Issue Type: Bug
Components: CLI
Affects Versions: 7.0.0.Final, 7.0.1.Final
Reporter: Radoslav Husar
Assignee: Alexey Loubyansky
Priority: Critical
This is a critical usability issue. We must provide a way to get help about operations
usage too. Its difficult to comprehend how to use operations from this model:
{code}
[domain@localhost:9999 /]
:read-operation-description(name="upload-deployment-url")
{
"outcome" => "success",
"result" => {
"operation-name" => "upload-deployment-url",
"description" => "Indicates that the deployment content
available at the included URL should be added to the deployment content repository. Note
that this operation does not indicate the content should be deployed into the
runtime.",
"request-properties" => {"url" => {
"type" => STRING,
"description" => "The URL at which the deployment content
is available for upload to the domain's or standalone server's deployment content
repository.. Note that the URL must be accessible from the target of the operation (i.e.
the Domain Controller or standalone server).",
"required" => true,
"min-length" => 1,
"nillable" => false
}},
"reply-properties" => {
"type" => BYTES,
"description" => "The hash of managed deployment content
that has been uploaded to the domain's or standalone server's deployment content
repository.",
"min-length" => 20,
"max-length" => 20,
"nillable" => false
}
}
}
[domain@localhost:9999 /]
{code}
--
This message is automatically generated by JIRA.
For more information on JIRA, see: