From 72e00b2cc79d3d9b8b28f9b76f1fe8df83b5cebc Mon Sep 17 00:00:00 2001 From: MoustaphaCamara Date: Tue, 5 May 2026 17:50:37 +0200 Subject: [PATCH 1/2] docs: tutorials: update api workshop page Add some description and better phrasing for the links --- docs/tutorials/api-workshop.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/docs/tutorials/api-workshop.md b/docs/tutorials/api-workshop.md index a6f4cbf..8414ca5 100644 --- a/docs/tutorials/api-workshop.md +++ b/docs/tutorials/api-workshop.md @@ -5,18 +5,25 @@ title: API Workshop # API Workshop -We created a workshop to get started with the HTTP REST API provided by eLabFTW. +This workshop introduces how to interact with the **eLabFTW REST API** using **Jupyter notebooks**. It provides a hands-on, step-by-step learning experience where you can execute requests, explore responses, and automate workflows directly from your browser or local environment. + +The workshop is organized into multiple notebooks, guiding you from basic API concepts to practical usage with tools like `curl` and Python. It is designed for beginners as well as intermediate users who want to better understand and use the API in real scenarios. + +You can run the notebooks: +- **Locally** with JupyterLab (recommended for full control) +- **Online** using Google Colab (no installation required) + +Detailed setup instructions are available in the repository. ## Video -A recording of this workshop, suitable to beginners, is available in this video: +A full walkthrough of the workshop is available in the video below. It follows the same structure as the notebooks and demonstrates how to interact with the API step by step using Jupyter. ## Links -- [Repository link](https://github.com/elabftw/api-workshop/?tab=readme-ov-file#elabftw-api-workshop) -- [Endpoints documentation](https://doc.elabftw.net/api/v2/) -- [Python library repository](https://github.com/elabftw/elabapi-python) -- [HTML documentation](https://doc.elabftw.net/api/elabapi-html/) - +- [API Workshop repository](https://github.com/elabftw/api-workshop/?tab=readme-ov-file#elabftw-api-workshop)
➡️ Contains the Jupyter notebooks used in this workshop, along with setup instructions to run them locally or in Google Colab. +- [API endpoints documentation](https://doc.elabftw.net/api/v2/)
➡️ Reference documentation listing all available API endpoints, parameters, and expected responses. +- [Python library (elabapi-python)](https://github.com/elabftw/elabapi-python)
➡️ Official Python client to interact with the eLabFTW API without writing raw HTTP requests. +- [Python library HTML documentation](https://doc.elabftw.net/api/elabapi-html/)
➡️ Detailed documentation of the Python library, including available methods and usage examples. From a5d74a7fc3619f170456ff85049a19e5960460da Mon Sep 17 00:00:00 2001 From: MoustaphaCamara Date: Tue, 5 May 2026 17:53:17 +0200 Subject: [PATCH 2/2] replace
to closing tag
for markdown compatibility --- docs/tutorials/api-workshop.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/tutorials/api-workshop.md b/docs/tutorials/api-workshop.md index 8414ca5..47b7c9a 100644 --- a/docs/tutorials/api-workshop.md +++ b/docs/tutorials/api-workshop.md @@ -23,7 +23,7 @@ A full walkthrough of the workshop is available in the video below. It follows t ## Links -- [API Workshop repository](https://github.com/elabftw/api-workshop/?tab=readme-ov-file#elabftw-api-workshop)
➡️ Contains the Jupyter notebooks used in this workshop, along with setup instructions to run them locally or in Google Colab. -- [API endpoints documentation](https://doc.elabftw.net/api/v2/)
➡️ Reference documentation listing all available API endpoints, parameters, and expected responses. -- [Python library (elabapi-python)](https://github.com/elabftw/elabapi-python)
➡️ Official Python client to interact with the eLabFTW API without writing raw HTTP requests. -- [Python library HTML documentation](https://doc.elabftw.net/api/elabapi-html/)
➡️ Detailed documentation of the Python library, including available methods and usage examples. +- [API Workshop repository](https://github.com/elabftw/api-workshop/?tab=readme-ov-file#elabftw-api-workshop)
➡️ Contains the Jupyter notebooks used in this workshop, along with setup instructions to run them locally or in Google Colab. +- [API endpoints documentation](https://doc.elabftw.net/api/v2/)
➡️ Reference documentation listing all available API endpoints, parameters, and expected responses. +- [Python library (elabapi-python)](https://github.com/elabftw/elabapi-python)
➡️ Official Python client to interact with the eLabFTW API without writing raw HTTP requests. +- [Python library HTML documentation](https://doc.elabftw.net/api/elabapi-html/)
➡️ Detailed documentation of the Python library, including available methods and usage examples.