Skip to content

Commit 62b4e22

Browse files
authored
Merge pull request #76 from biosustain/API-reference-links
- API reference links for most project and dataset actions - LIMS (Benchling) project url field
2 parents 02a3dfc + 1e1b790 commit 62b4e22

9 files changed

Lines changed: 51 additions & 4 deletions

File tree

-10.8 MB
Binary file not shown.
10.3 MB
Loading

_static/images/settings_button.png

868 Bytes
Loading

docs/Dataset/Add_Dataset.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,4 +206,10 @@ To remove a Lineage:
206206
```
207207
----------------------------
208208

209-
<br/>
209+
## API Availability
210+
211+
The actions described in this page can also be performed programmatically using our **FastAPI**. For more details, see the following endpoints in our API Reference:
212+
213+
* [**/datasets**](https://datacatalog.bright.dtu.dk/api/docs#/datasets/create_dataset_datasets_post)
214+
* [**/projects-datasets**](https://datacatalog.bright.dtu.dk/api/docs#/projects-datasets)
215+
* [**/lineage**](https://datacatalog.bright.dtu.dk/api/docs#/lineage)

docs/Dataset/Manage_Datasets.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,4 +121,11 @@ The tab displays a table view with:
121121
After the initial save, you can grant or remove additional permissions for a user, by selecting or deselecting the options available. Changes apply immediately.
122122
123123
```
124+
-------------------------------
125+
126+
## API Availability
127+
128+
The actions described above can also be performed programmatically using our **FastAPI**. For more details, see the following endpoints in our API Reference:
124129

130+
* [**/datasets**](https://datacatalog.bright.dtu.dk/api/docs#/datasets)
131+
* [**/policies/datasets**](https://datacatalog.bright.dtu.dk/api/docs#/policies)

docs/Project/Create_Project.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,15 @@ Complete all the required fields marked with **`*`**:
3232
* Project Description (**`*`**)
3333
* Access Rights (**`*`**)
3434
* Principal Investigator (PI) (**`*`**)
35+
* LIMS (Benchling) project URL _(must start with **https://bright.benchling.com**)_
36+
37+
38+
```{tip}
39+
40+
To find the Benchling project URL, log in to Benchling, open the **Projects** section in the left sidebar, and select the project you want.
41+
Click the **settings** button (<img src="../../_static/images/settings_button.png" alt="open_icon" style="height:1.2em; vertical-align:text-bottom;">) next to the project name and choose **Copy project link**.
42+
43+
```
3544

3645

3746
## Final Step: Complete Project Creation
@@ -43,7 +52,7 @@ Click **`Create project`** at the ***bottom*** of the page to complete the proce
4352

4453
<br/>
4554

46-
```{figure} ../../_static/images/project-creation-3.gif
55+
```{figure} ../../_static/images/project-creation-updated2.gif
4756
:alt: Project Creation
4857
:width: 93%
4958
:align: center
@@ -131,4 +140,13 @@ If either of these is missing, you will not be able to proceed.
131140

132141
```{note}
133142
This relationship also appears under the **Projects** tab on the **dataset home page**.
134-
```
143+
```
144+
145+
--------------------------------
146+
147+
## API Availability
148+
149+
The actions described in this page can also be performed programmatically using our **FastAPI**. For more details, see the following endpoints in our API Reference:
150+
151+
* [**/projects**](https://datacatalog.bright.dtu.dk/api/docs#/projects/create_project_projects_post)
152+
* [**/projects-datasets**](https://datacatalog.bright.dtu.dk/api/docs#/projects-datasets)

docs/Project/DMP.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,11 @@ This section includes questions about compliance and data sharing:
127127
→ **BRIGHT-visible**: READ-ONLY access for project and dataset metadata is granted to all BRIGHT employees. Access to files in Microsoft Azure Storage account remains restricted to project members and collaborators.
128128
```
129129

130+
----------------------------
130131

132+
## API Availability
131133

134+
Some of the fields used when creating a DMP can also be set programmatically using our **FastAPI**. For more details, see the following endpoints in our API Reference:
135+
136+
* [**/dmp**](https://datacatalog.bright.dtu.dk/api/docs#/dmp)
132137

docs/Project/Manage_Projects.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,13 @@ The tab displays a table view with:
111111
To grant or remove permissions for a user, simply click or unclick the options available. Changes apply immediately.
112112
```
113113

114+
----------------------------
115+
116+
## API Availability
117+
118+
The actions described above can also be performed programmatically using our **FastAPI**. For more details, see the following endpoints in our API Reference:
114119

120+
* [**/projects**](https://datacatalog.bright.dtu.dk/api/docs#/projects)
121+
* [**/policies/projects**](https://datacatalog.bright.dtu.dk/api/docs#/policies)
115122

116123

docs/Search.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,8 @@ To make your search more precise, try combining **multiple filters** at once.
4646
```
4747
----------------------------
4848

49-
<br/>
49+
## API Availability
50+
51+
The search can also be performed programmatically using our **FastAPI**. For more details, see the following endpoint in our API Reference:
52+
53+
* [**/search**](https://datacatalog.bright.dtu.dk/api/docs#/search/search_search_post)

0 commit comments

Comments
 (0)