Skip to content

Commit 18c31d2

Browse files
committed
Merge remote-tracking branch 'refs/remotes/origin/develop' into feature/release-notes-1.62
# Conflicts: # docs/user-guide/doc-odm-user-guide/doc-odm-user-guide/images/data-model.png
2 parents 491230b + 06c39c1 commit 18c31d2

File tree

7 files changed

+1283
-12
lines changed

7 files changed

+1283
-12
lines changed

docs/assets/data_model.svg

Lines changed: 1257 additions & 0 deletions
Loading

docs/tools/odm-sdk/terminal/study/uploading-study.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Additional optional parameters:
7575
## Data model
7676

7777
The script supports several data models:
78-
![Data Model](uploading-study/data-model.png)
78+
![Data Model](../../../../assets/data_model.svg)
7979

8080
- Study - Samples - Omics data:
8181
- the script uses this data model if no parameters are specified for libraries or preparations loading;
-167 KB
Binary file not shown.

docs/user-guide/doc-odm-user-guide/attachment-transformation.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,17 @@ GET `transformations/images`. Endpoint response example:
4141
"output_formats": [
4242
"samples"
4343
]
44+
},
45+
{
46+
"name": "metadata-basic",
47+
"version": "0.0.3",
48+
"description": "Basic converter from attachment to metadata",
49+
"input_formats": [
50+
"csv"
51+
],
52+
"output_formats": [
53+
"samples"
54+
]
4455
},
4556
{
4657
"name": "metadata-basic",
@@ -81,7 +92,7 @@ Let’s create configuration that allows image to place transformed `CSV` file t
8192
"data": {
8293
"source": "csv",
8394
"destination": "samples"
84-
},
95+
},
8596
"description": "Configuration which allows you to transform csv file into Sample group",
8697
"name": "csv to samples"
8798
}
@@ -136,26 +147,28 @@ Initial request body:
136147

137148
```json
138149
{
139-
"attachment_accession": "string",
150+
"input_accessions": ["string"],
140151
"configuration_id": 1,
141152
"image_reference": {
142153
"name": "string",
143154
"version": "string"
144155
},
145-
"volume_size": 30
156+
"volume_size": 30,
157+
"dry_run": false
146158
}
147159
```
148160
Fill in information about attachment genestack accession, configuration, image name and version:
149161

150162
```json
151163
{
152-
"attachment_accession": "GSF016786",
164+
"input_accessions": ["GSF016786"],
153165
"configuration_id": 294862386,
154166
"image_reference": {
155167
"name": "metadata-basic",
156-
"version": "0.0.2"
168+
"version": "0.0.3"
157169
},
158-
"volume_size": 30
170+
"volume_size": 30,
171+
"dry_run": false
159172
}
160173
```
161174

@@ -175,14 +188,15 @@ To check the status of the Job use GET `transformations/jobs/{id}` endpoint:
175188
"$schema": "https://odm-processors-controller:8080/schemas/TransformationJobFields.json",
176189
"image_reference": {
177190
"name": "metadata-basic",
178-
"version": "0.0.2"
191+
"version": "0.0.3"
179192
},
180-
"attachment_accession": "GSF016786",
193+
"input_accessions": ["GSF016786"],
181194
"configuration_id": 294862386,
182195
"volume_size": 30,
196+
"dry_run": false,
183197
"create_time": "2025-10-31T12:28:57Z",
184198
"status": {
185-
"state": "TERMINATED"
199+
"state": "DONE"
186200
}
187201
}
188202
```
Binary file not shown.

docs/user-guide/doc-odm-user-guide/import-data-using-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The correct order of linking follows the system logic and available endpoints:
4747
- **Attached files** are linked directly to a **Study**
4848

4949

50-
![image](doc-odm-user-guide/images/data-model.png)
50+
![image](../../assets/data_model.svg)
5151
## Data Loading via APIs
5252
To load the data via APIs each entity is created via a separate endpoint specific for
5353
this data type. Then they are sequentially linked in the Integration layer.

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
mkdocs-material==9.7.1
1+
mkdocs-material==9.7.3
22
mike==2.1.3
33

44
# https://github.com/squidfunk/mkdocs-material/issues/3085#issuecomment-933373590

0 commit comments

Comments
 (0)