diff --git a/_static/images/project-creation-3.gif b/_static/images/project-creation-3.gif deleted file mode 100644 index 8ffc314..0000000 Binary files a/_static/images/project-creation-3.gif and /dev/null differ diff --git a/_static/images/project-creation-updated2.gif b/_static/images/project-creation-updated2.gif new file mode 100644 index 0000000..ff11b0d Binary files /dev/null and b/_static/images/project-creation-updated2.gif differ diff --git a/_static/images/settings_button.png b/_static/images/settings_button.png new file mode 100644 index 0000000..f58d4ba Binary files /dev/null and b/_static/images/settings_button.png differ diff --git a/docs/Dataset/Add_Dataset.md b/docs/Dataset/Add_Dataset.md index d2b5b66..94eb926 100644 --- a/docs/Dataset/Add_Dataset.md +++ b/docs/Dataset/Add_Dataset.md @@ -206,4 +206,10 @@ To remove a Lineage: ``` ---------------------------- -
\ No newline at end of file +## API Availability + +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: + +* [**/datasets**](https://datacatalog.bright.dtu.dk/api/docs#/datasets/create_dataset_datasets_post) +* [**/projects-datasets**](https://datacatalog.bright.dtu.dk/api/docs#/projects-datasets) +* [**/lineage**](https://datacatalog.bright.dtu.dk/api/docs#/lineage) \ No newline at end of file diff --git a/docs/Dataset/Manage_Datasets.md b/docs/Dataset/Manage_Datasets.md index 229bd90..178a6c6 100644 --- a/docs/Dataset/Manage_Datasets.md +++ b/docs/Dataset/Manage_Datasets.md @@ -121,4 +121,11 @@ The tab displays a table view with: After the initial save, you can grant or remove additional permissions for a user, by selecting or deselecting the options available. Changes apply immediately. ``` +------------------------------- + +## API Availability + +The actions described above can also be performed programmatically using our **FastAPI**. For more details, see the following endpoints in our API Reference: +* [**/datasets**](https://datacatalog.bright.dtu.dk/api/docs#/datasets) +* [**/policies/datasets**](https://datacatalog.bright.dtu.dk/api/docs#/policies) diff --git a/docs/Project/Create_Project.md b/docs/Project/Create_Project.md index e29bc87..37cc010 100644 --- a/docs/Project/Create_Project.md +++ b/docs/Project/Create_Project.md @@ -32,6 +32,15 @@ Complete all the required fields marked with **`*`**: * Project Description (**`*`**) * Access Rights (**`*`**) * Principal Investigator (PI) (**`*`**) +* LIMS (Benchling) project URL _(must start with **https://bright.benchling.com**)_ + + +```{tip} + +To find the Benchling project URL, log in to Benchling, open the **Projects** section in the left sidebar, and select the project you want. +Click the **settings** button (open_icon) next to the project name and choose **Copy project link**. + +``` ## Final Step: Complete Project Creation @@ -43,7 +52,7 @@ Click **`Create project`** at the ***bottom*** of the page to complete the proce
-```{figure} ../../_static/images/project-creation-3.gif +```{figure} ../../_static/images/project-creation-updated2.gif :alt: Project Creation :width: 93% :align: center @@ -131,4 +140,13 @@ If either of these is missing, you will not be able to proceed. ```{note} This relationship also appears under the **Projects** tab on the **dataset home page**. -``` \ No newline at end of file +``` + +-------------------------------- + +## API Availability + +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: + +* [**/projects**](https://datacatalog.bright.dtu.dk/api/docs#/projects/create_project_projects_post) +* [**/projects-datasets**](https://datacatalog.bright.dtu.dk/api/docs#/projects-datasets) \ No newline at end of file diff --git a/docs/Project/DMP.md b/docs/Project/DMP.md index 9bcd40b..b825f3d 100644 --- a/docs/Project/DMP.md +++ b/docs/Project/DMP.md @@ -127,6 +127,11 @@ This section includes questions about compliance and data sharing: → **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. ``` +---------------------------- +## API Availability +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: + +* [**/dmp**](https://datacatalog.bright.dtu.dk/api/docs#/dmp) diff --git a/docs/Project/Manage_Projects.md b/docs/Project/Manage_Projects.md index 006da7a..43fd179 100644 --- a/docs/Project/Manage_Projects.md +++ b/docs/Project/Manage_Projects.md @@ -111,6 +111,13 @@ The tab displays a table view with: To grant or remove permissions for a user, simply click or unclick the options available. Changes apply immediately. ``` +---------------------------- + +## API Availability + +The actions described above can also be performed programmatically using our **FastAPI**. For more details, see the following endpoints in our API Reference: +* [**/projects**](https://datacatalog.bright.dtu.dk/api/docs#/projects) +* [**/policies/projects**](https://datacatalog.bright.dtu.dk/api/docs#/policies) diff --git a/docs/Search.md b/docs/Search.md index ebfbe46..4b695f8 100644 --- a/docs/Search.md +++ b/docs/Search.md @@ -46,4 +46,8 @@ To make your search more precise, try combining **multiple filters** at once. ``` ---------------------------- -
+## API Availability + +The search can also be performed programmatically using our **FastAPI**. For more details, see the following endpoint in our API Reference: + +* [**/search**](https://datacatalog.bright.dtu.dk/api/docs#/search/search_search_post)