Uploaded image for project: 'JBoss Enterprise Application Platform'
  1. JBoss Enterprise Application Platform
  2. JBEAP-7044

CLI operation parameter input-stream-index has a confusing name and description

    XMLWordPrintable

    Details

    • Type: Enhancement
    • Status: Closed (View Workflow)
    • Priority: Optional
    • Resolution: Rejected
    • Affects Version/s: 7.1.0.DR7
    • Fix Version/s: None
    • Component/s: Management, User Experience
    • Labels:
      None
    • Target Release:
    • Affects:
      User Experience

      Description

      With EAP7-574, a way to pass files from path as input stream index through CLI to operation was enabled. While the name and type is technically correct, this process should be completely transparent to user. The name, description and type of the parameter is quite unintuitive and hard to associate with file path:

      "input-stream-index" => {
          "type" => INT,
          "description" => "The index into the operation's attached input streams of the input stream that contains deployment content that should be uploaded to the domain's or standalone server's deployment content repository.",
          "expressions-allowed" => false,
          "nillable" => true,
          "alternatives" => [
              "hash",
              "bytes",
              "url",
              "path",
              "relative-to",
              "empty"
          ],
          "min" => 1L,
          "max" => 2147483647L,
          "filesystem-path" => true,
          "attached-streams" => true
      }

      Suggested improvements

      • Change the parameter name to source-path to be consistent with target-path in /deployment=deployment.jar:add-content operation.
      • Change the parameter type to STRING.
      • Write up a suitable description.
      • Since it was impossible to properly pass the input-stream-index parameter in CLI, all the changes mentioned should be committed only in the way this is rendered in CLI, not in the model. Changes in model could break the backwards compatibility, since it was possible to pass the input-stream-index through native management in previous versions.

        Attachments

          Activity

            People

            Assignee:
            ehugonnet Emmanuel Hugonnet
            Reporter:
            mjurc Michal Jurc
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: