[jboss-jira] [JBoss JIRA] (AS7-1758) CLI usability: operations need convenient help option too

[Alexey Loubyansky (JIRA)]

     [ https://issues.jboss.org/browse/AS7-1758?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Alexey Loubyansky resolved AS7-1758.
------------------------------------

    Fix Version/s: 7.1.1.Final
                       (was: Open To Community)
       Resolution: Done


read-operation command has been added for this purpose.
It can list all the available operations in the current context.
And describe any of them including the parameters, their types, return values, etc.
                
> 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: Feature Request
>          Components: CLI
>    Affects Versions: 7.0.0.Final, 7.0.1.Final
>            Reporter: Radoslav Husar
>            Assignee: Alexey Loubyansky
>            Priority: Critical
>              Labels: eap6-ux
>             Fix For: 7.1.1.Final
>
>
> 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 at 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 at localhost:9999 /]  
> {code}

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.jboss.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira