diff --git a/src/main/java/uk/ac/ebi/tsc/tesk/tes/model/TesExecutor.java b/src/main/java/uk/ac/ebi/tsc/tesk/tes/model/TesExecutor.java index c75ba67..d99444e 100644 --- a/src/main/java/uk/ac/ebi/tsc/tesk/tes/model/TesExecutor.java +++ b/src/main/java/uk/ac/ebi/tsc/tesk/tes/model/TesExecutor.java @@ -52,7 +52,7 @@ public TesExecutor image(String image) { * Name of the container image. The string will be passed as the image argument to the containerization run command. Examples: - `ubuntu` - `quay.io/aptible/ubuntu` - `gcr.io/my-org/my-image` - `myregistryhost:5000/fedora/httpd:version1.0` * @return image */ - @ApiModelProperty(example = "ubuntu:20.04", required = true, value = "Name of the container image. The string will be passed as the image argument to the containerization run command. Examples: - `ubuntu` - `quay.io/aptible/ubuntu` - `gcr.io/my-org/my-image` - `myregistryhost:5000/fedora/httpd:version1.0`") + @ApiModelProperty(example = "ubuntu:22.04", required = true, value = "Name of the container image. The string will be passed as the image argument to the containerization run command. Examples: - `ubuntu` - `quay.io/aptible/ubuntu` - `gcr.io/my-org/my-image` - `myregistryhost:5000/fedora/httpd:version1.0`") @NotNull @NotBlank @@ -81,7 +81,7 @@ public TesExecutor addCommandItem(String commandItem) { * A sequence of program arguments to execute, where the first argument is the program to execute (i.e. argv). Example: ``` { \"command\" : [\"/bin/md5\", \"/data/file1\"] } ``` * @return command */ - @ApiModelProperty(example = "[\"/bin/md5\",\"/data/file1\"]", required = true, value = "A sequence of program arguments to execute, where the first argument is the program to execute (i.e. argv). Example: ``` { \"command\" : [\"/bin/md5\", \"/data/file1\"] } ```") + @ApiModelProperty(example = "[\"/bin/md5sum\",\"/data/file1\"]", required = true, value = "A sequence of program arguments to execute, where the first argument is the program to execute (i.e. argv). Example: ``` { \"command\" : [\"/bin/md5sum\", \"/data/file1\"] } ```") @NotNull @NotEmpty @@ -142,7 +142,7 @@ public TesExecutor stdout(String stdout) { * Path inside the container to a file where the executor's stdout will be written to. Must be an absolute path. Example: ``` { \"stdout\" : \"/tmp/stdout.log\" } ``` * @return stdout */ - @ApiModelProperty(example = "/tmp/stdout.log", value = "Path inside the container to a file where the executor's stdout will be written to. Must be an absolute path. Example: ``` { \"stdout\" : \"/tmp/stdout.log\" } ```") + @ApiModelProperty(example = "/data/outfile", value = "Path inside the container to a file where the executor's stdout will be written to. Must be an absolute path. Example: ``` { \"stdout\" : \"/data/outfile\" } ```") @Pattern(regexp = ABSOLUTE_PATH_REGEXP, message = ABSOLUTE_PATH_MESSAGE) public String getStdout() { diff --git a/src/main/java/uk/ac/ebi/tsc/tesk/tes/model/TesInput.java b/src/main/java/uk/ac/ebi/tsc/tesk/tes/model/TesInput.java index cbb0b83..2b833b0 100644 --- a/src/main/java/uk/ac/ebi/tsc/tesk/tes/model/TesInput.java +++ b/src/main/java/uk/ac/ebi/tsc/tesk/tes/model/TesInput.java @@ -86,7 +86,7 @@ public TesInput url(String url) { * REQUIRED, unless \"content\" is set. URL in long term storage, for example: - s3://my-object-store/file1 - gs://my-bucket/file2 - file:///path/to/my/file - /path/to/my/file * @return url */ - @ApiModelProperty(example = "s3://my-object-store/file1", value = "REQUIRED, unless \"content\" is set. URL in long term storage, for example: - s3://my-object-store/file1 - gs://my-bucket/file2 - file:///path/to/my/file - /path/to/my/file") + @ApiModelProperty(example = "s3:///file1", value = "REQUIRED, unless \"content\" is set. URL in long term storage, for example: - s3://my-object-store/file1 - gs://my-bucket/file2 - file:///path/to/my/file - /path/to/my/file") public String getUrl() { diff --git a/src/main/java/uk/ac/ebi/tsc/tesk/tes/model/TesTask.java b/src/main/java/uk/ac/ebi/tsc/tesk/tes/model/TesTask.java index 1720b13..fd0f54d 100644 --- a/src/main/java/uk/ac/ebi/tsc/tesk/tes/model/TesTask.java +++ b/src/main/java/uk/ac/ebi/tsc/tesk/tes/model/TesTask.java @@ -161,7 +161,7 @@ public TesTask addInputsItem(TesInput inputsItem) { * Input files that will be used by the task. Inputs will be downloaded and mounted into the executor container as defined by the task request document. * @return inputs */ - @ApiModelProperty(example = "[{\"url\":\"s3://my-object-store/file1\",\"path\":\"/data/file1\"}]", value = "Input files that will be used by the task. Inputs will be downloaded and mounted into the executor container as defined by the task request document.") + @ApiModelProperty(example = "[{\"url\":\"s3:///file1\",\"path\":\"/data/file1\"}]", value = "Input files that will be used by the task. Inputs will be downloaded and mounted into the executor container as defined by the task request document.") @Valid @@ -190,7 +190,7 @@ public TesTask addOutputsItem(TesOutput outputsItem) { * Output files. Outputs will be uploaded from the executor container to long-term storage. * @return outputs */ - @ApiModelProperty(example = "[{\"path\":\"/data/outfile\",\"url\":\"s3://my-object-store/outfile-1\",\"type\":\"FILE\"}]", value = "Output files. Outputs will be uploaded from the executor container to long-term storage.") + @ApiModelProperty(example = "[{\"path\":\"/data/outfile\",\"url\":\"s3:///outfile-1\",\"type\":\"FILE\"}]", value = "Output files. Outputs will be uploaded from the executor container to long-term storage.") @Valid