From 9e852c17ac05fb6f680738c00b46f124e40b2ca4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mose=20M=C3=BCller?= <mosemueller@gmail.com>
Date: Tue, 30 Jul 2024 10:36:40 +0200
Subject: [PATCH] docs: updates documentation

---
 README.md                                  | 19 +++++++++++++++++++
 docs/user-guide/interaction/RESTful API.md | 18 +++++++++++++-----
 2 files changed, 32 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 460dec7..118e598 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,7 @@
   - [Connecting to the Service via Python Client](#connecting-to-the-service-via-python-client)
     - [Tab Completion Support](#tab-completion-support)
     - [Integration within Another Service](#integration-within-another-service)
+  - [RESTful API](#restful-api)
 - [Understanding the Component System](#understanding-the-component-system)
   - [Built-in Type and Enum Components](#built-in-type-and-enum-components)
   - [Method Components](#method-components)
@@ -209,6 +210,24 @@ In this setup, the `MyService` class has a `proxy` attribute that connects to a
 The `block_until_connected=False` argument allows the service to start up even if the initial connection attempt fails.
 This configuration is particularly useful in distributed systems where services may start in any order.
 
+### RESTful API
+The `pydase` RESTful API allows for standard HTTP-based interactions and provides access to various functionalities through specific routes. 
+
+For example, you can get a value like this:
+
+```python
+import json
+
+import requests
+
+response = requests.get(
+    "http://<hostname>:<port>/api/v1/get_value?access_path=<full_access_path>"
+)
+serialized_value = json.loads(response.text)
+```
+
+For more information, see [here](https://pydase.readthedocs.io/en/stable/user-guide/interaction/main/#restful-api).
+
 <!--usage-end-->
 
 ## Understanding the Component System
diff --git a/docs/user-guide/interaction/RESTful API.md b/docs/user-guide/interaction/RESTful API.md
index ecd76de..f8d73fd 100644
--- a/docs/user-guide/interaction/RESTful API.md	
+++ b/docs/user-guide/interaction/RESTful API.md	
@@ -2,13 +2,21 @@
 
 The `pydase` RESTful API allows for standard HTTP-based interactions and provides access to various functionalities through specific routes. This is particularly useful for integrating `pydase` services with other applications or for scripting and automation.
 
+For example, you can get a value like this:
+
+```python
+import json
+
+import requests
+
+response = requests.get(
+    "http://<hostname>:<port>/api/v1/get_value?access_path=<full_access_path>"
+)
+serialized_value = json.loads(response.text)
+```
+
 To help developers understand and utilize the API, we provide an OpenAPI specification. This specification describes the available endpoints and corresponding request/response formats.
 
 ## OpenAPI Specification
-**Base URL**:
-
-```
-http://<hostname>:<port>/api/
-```
 
 <swagger-ui src="./openapi.yaml"/>