Captions have been added #55
Conversation
There was a problem hiding this comment.
Could you please take a look, I've left some comments. Also, could you please remove all new uploaded images from this PR since they are not used anywhere? (it's a good practise to add only images if they're needed, if they are not used in this PR, it means that they should not be added)
|
|
||
| 3. The response indicates that the deletion of the following files and all linked data has been started. | ||
| You can verify the deletion by checking the Groups section in the | ||
| ODM interface; the "Demo version 2" group should no longer be listed. | ||
|  | ||
| <figcaption>The outcome 202 indicates that the operation to remove the study <strong>Demo version 2</strong> (ID GSF1147012) has been successful. You can corroborate the action by logging into ODM and searching for the specific study.</figcaption> |
There was a problem hiding this comment.
Can we please rephrase it somehow? 202 means only that deletion has been successfully started, but it doesn't mean that this operation has been successfully finished, you can check this code description in swagger.
| @@ -116,6 +125,7 @@ including definitions and requirements. | |||
| **List or search for study metadata objects.** | |||
|
|
|||
|  | |||
| <figcaption>Select the endpoint {==/api/v1/as-user/studies==} to retrieve study metadata only from a specific study</figcaption> | |||
There was a problem hiding this comment.
I've noticed that in the section "Select the endpoint of interest" we start to tell about endpoint GET api/v1/as-user/studies, after that we mention in the text endpoint GET api/v1/as-user/studies/{id}, after that on screenshots we show endpoint GET api/v1/as-user/studies, and later we have for the screenshot description related again to the endpoint GET api/v1/as-user/studies/{id}, could you please fix it and use only one endpoint?
(Because in general endpoint GET api/v1/as-user/studies/{id} should be used to get metadata of the certain study, endpoint GET api/v1/as-user/studies in the response can have lots of studies, not only one)
|  | ||
|
|
||
|  | ||
| <figcaption>The response confirms the upload of the study has started and an ID for the Job has been assigned (1269 for this example)</figcaption> |
There was a problem hiding this comment.
probably not study, but samples?
|  | ||
|
|
||
| {width=600} | ||
| <figcaption>Use the endpoint ==/api/v1/jobs/{jobExecId}/output== to review the status of the job import. An accession number will be assigned to the study if the import is successful</figcaption> |
There was a problem hiding this comment.
probably not study, but samples?
|
|
||
| 4. **Enter Parameters**: Indicate the required parameters: link to the data file, template, data class, etc. | ||
| Optionally you can specify a link to metadata. | ||
|  | ||
| * !!! warning "For all `.tsv` files "numberOfFeatureAttributes" parameter is mandatory." |
There was a problem hiding this comment.
Could you please explain why this important part has been removed?
|  | ||
|
|
||
|  | ||
| <figcaption>The response confirms the upload of the study has started and an ID for the Job has been assigned (1271 for this example)</figcaption> |
There was a problem hiding this comment.
not study but experimental data, probably?
|  | ||
|
|
||
|  | ||
| <figcaption>Use the endpoint ==/api/v1/jobs/{jobExecId}/output== to review the status of the job import. An accession number will be assigned to the study if the import is successful</figcaption> |
There was a problem hiding this comment.
not study but experimental data, probably?
|  | ||
|
|
||
|  | ||
| <figcaption>Click on Expression integration as Curator to find the endpoints to link experimental data with samples (and the study). Select the endpoint ==/api/v1/as-curator/integration/link/expression/group/{sourceId}/to/sample/group/{targetId}==</figcaption> |
There was a problem hiding this comment.
Could we please here and in general everywhere specify what type of endpoint do we need? because when we mention only its "name", e.g. /api/v1/as-curator/integration/link/expression/group/{sourceId}/to/sample/group/{targetId} - it's not enough, because with this name we have Post endpoint and also DELETE endpoint, it's better to mention also what type of endpoint should be used, not just mention its name
|
|
||
| 3. **Enter Accession Details:** Add the relevant information, including the data accession number and sample group accession | ||
| number, and click **Execute.** | ||
|  | ||
| <figcaption>Add the details of the accession numbers corresponding to the experimental data (<strong>GSF1147049</strong>) and the sample group object (<strong>GSF1147034</strong>). By default, the linking attribute will be the column <strong>Sample source ID</strong>, but you can customize it </figcaption> |
There was a problem hiding this comment.
Could we please use certain attribute name? Sample Source ID instead of Sample source ID
|
The changes have been made according to the comments. In addition, the additional pictures have been removed |
The captions for each figure have been added.