# workflows versions update

## Synopsis

```shell
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:

```shell
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:

```shell
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:

```shell
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.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.omics.ai/products/command-line-interface/reference/workbench/workflows-versions-update.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.