Skip to content

Commit

Permalink
Merge pull request #56 from elixir-cloud-aai/update-example
Browse files Browse the repository at this point in the history
Update examples so it is easier to test
  • Loading branch information
jemaltahir authored Jul 19, 2024
2 parents 28a5194 + 18033ec commit eceb7b4
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions src/main/java/uk/ac/ebi/tsc/tesk/tes/model/TesExecutor.java
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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() {
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/uk/ac/ebi/tsc/tesk/tes/model/TesInput.java
Original file line number Diff line number Diff line change
Expand Up @@ -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://<CHANGE_THIS>/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() {
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/uk/ac/ebi/tsc/tesk/tes/model/TesTask.java
Original file line number Diff line number Diff line change
Expand Up @@ -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://<CHANGE_THIS>/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

Expand Down Expand Up @@ -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://<CHANGE_THIS>/outfile-1\",\"type\":\"FILE\"}]", value = "Output files. Outputs will be uploaded from the executor container to long-term storage.")

@Valid

Expand Down

0 comments on commit eceb7b4

Please sign in to comment.