Skip to content

Commit 5581bb2

Browse files
committed
added more doc
Signed-off-by: munishchouhan <hrma017@gmail.com>
1 parent 991b945 commit 5581bb2

File tree

3 files changed

+34
-6
lines changed

3 files changed

+34
-6
lines changed

docs/api.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -310,12 +310,16 @@ curl --location 'http://localhost:9090/v1alpha2/container' \
310310

311311
```json
312312
{
313-
"containerToken":"a3f9c8d2e7b1",
314-
"targetImage":"wave.seqera.io/wt/a3f9c8d2e7b1/library/r-base:dplyr_ggplot2--8a7c3f4d92e6b583",
315-
"expiration":"2025-11-08T21:19:01.715321Z",
316-
"buildId":"8a7c3f4d92e6b583_1",
317-
"cached":false,
318-
"freeze":false
313+
"requestId": "22d3c6c1cb06",
314+
"containerToken": "22d3c6c1cb06",
315+
"targetImage": "wave.seqera.io/wt/22d3c6c1cb06/wave/build:49b26ca0c3a07b1b",
316+
"expiration": "2025-11-09T02:50:23.254497148Z",
317+
"containerImage": "private.cr.seqera.io/wave/build:49b26ca0c3a07b1b",
318+
"buildId": "bd-49b26ca0c3a07b1b_1",
319+
"cached": false,
320+
"freeze": false,
321+
"mirror": false,
322+
"scanId": "sc-a6acedfe6969f4bf_1"
319323
}
320324
```
321325

typespec/models/ContainerRequest.tsp

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,20 @@ import "./ScanLevel.tsp";
1313
format: "docker",
1414
containerPlatform:"linux/amd64"
1515
})
16+
@example(#{
17+
packages:#{
18+
type: "CRAN",
19+
entries: #["dplyr", "ggplot2", "bioc::GenomicRanges"],
20+
channels: #["cran", "bioconductor"],
21+
cranOpts: #{
22+
rImage: "rocker/r-ver:4.4.1",
23+
basePackages: "littler r-cran-docopt",
24+
commands: #["apt-get update", "apt-get install -y libcurl4-openssl-dev"]
25+
}
26+
},
27+
format: "docker",
28+
containerPlatform:"linux/amd64"
29+
})
1630
model ContainerRequest {
1731
buildContext?: ContainerLayer;
1832
@doc("Container repository where container builds should be pushed, e.g., `docker.io/user/my-image` (optional).")

typespec/models/PackagesSpec.tsp

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,16 @@ import "./CranOpts.tsp";
77
entries: #["salmon", "bwa"],
88
channels: #["conda-forge", "bioconda"]
99
})
10+
@example(#{
11+
type: "CRAN",
12+
entries: #["dplyr", "ggplot2"],
13+
channels: #["cran"],
14+
cranOpts: #{
15+
rImage: "rocker/r-ver:4.4.1",
16+
basePackages: "littler r-cran-docopt",
17+
commands: #["apt-get update && apt-get install -y libcurl4-openssl-dev"]
18+
}
19+
})
1020
model PackagesSpec {
1121
@doc("The type of package manager: CONDA or CRAN.")
1222
type: "CONDA" | "CRAN";

0 commit comments

Comments
 (0)