workflows versions update

Update a specific workflow version

Synopsis

omics workbench workflows versions update VERSION_ID 
  [--workflow=WORKFLOW_ID]
  [--name=TEXT]
  [--description=FILE|TEXT]
  [--authors=JSON_DATA]

Description

Update the metadata of an existing workflow version specified by VERSION_ID. You can modify the name, description, and authors of the workflow version using the provided flags.

Examples

Update the name of an existing workflow version:

omics workbench workflows versions update v1 --workflow d37c4ea5-92c5-4ca8-b0cb-0e6171b2fca7 --name "New Version Name"

Update the description of the workflow version using a Markdown description from a file:

omics workbench workflows versions update v1 --workflow d37c4ea5-92c5-4ca8-b0cb-0e6171b2fca7  --description @new_description.md

Update the authors of the workflow version using JSON data:

omics workbench workflows versions update v1 --workflow d37c4ea5-92c5-4ca8-b0cb-0e6171b2fca7 --authors '["Author1", "Author2", "Author3"]'

Positional Arguments

VERSION_ID

The identifier of the specific version you want to update.

Flags

--workflow=WORKFLOW_ID

Note: The --workflow flag is required and specifies the identifier of the parent workflow. It cannot be modified through this command and retains its original reference.

--name=TEXT

Change the human-readable name of the workflow version.

--description=FILE|TEXT

Provide or update the description of the workflow version. You can either provide the description directly as text or use a file containing the description in Markdown format.

--authors=JSON_DATA

Modify the list of authors for the workflow version using JSON data. Provide an array of authors' names in valid JSON format.