kdeps · jjuliano · Feb 10, 2025 · Feb 8, 2025 · Feb 8, 2025 · Feb 8, 2025
diff --git a/.github/workflows/docs-build.yml b/.github/workflows/docs-build.yml
@@ -26,7 +26,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: '16'
+          node-version: '20'
 
 
       - name: Install dependencies

diff --git a/docs/getting-started/configuration/workflow.md b/docs/getting-started/configuration/workflow.md
@@ -50,6 +50,21 @@ The `APIServer` block defines API routing configurations for the AI agent. These
 - **`hostIP` and `portNum`**: Define the IP address and port for the Docker container. The default values are
   `"127.0.0.1"` for `hostIP` and `3000` for `portNum`.
 
+#### TrustedProxies
+
+The `trustedProxies` allows setting the allowable `X-Forwarded-For` header IPv4, IPv5, CIDR addresses, used to limit the
+trusted request using the service. You can obtain the client's IP address through `@(request.IP())`.
+
+Example:
+
+```apl
+trustedProxies {
+  "127.0.0.1"
+  "192.168.1.2"
+  "10.0.0.0/8"
+}
+```
+
 #### API Routes
 
 - **`routes`**: API paths can be configured within the `routes` block. Each route is defined using a `new` block,

diff --git a/docs/getting-started/resources/global-functions.md b/docs/getting-started/resources/global-functions.md
@@ -17,6 +17,8 @@ Below is a list of the global functions available for each resource:
 
 | **Function**                    | **Description**                                                                |
 |:--------------------------------|:-------------------------------------------------------------------------------|
+| request.ID()                    | Retrieves the unique request UUID.                                             |
+| request.IP()                    | Retrieves the client IP address.                                               |
 | request.data()                  | Retrieves the request body data.                                               |
 | request.params("id")            | Fetches the value of a specific HTTP parameter from the request.               |
 | request.header("id")            | Fetches the value of a specific HTTP header from the request.                  |

diff --git a/go.mod b/go.mod
@@ -21,7 +21,7 @@ require (
 	github.com/google/uuid v1.6.0
 	github.com/joho/godotenv v1.5.1
 	github.com/kdeps/kartographer v0.0.0-20240808015651-b2afd5d97715
-	github.com/kdeps/schema v0.2.3
+	github.com/kdeps/schema v0.2.4
 	github.com/kr/pretty v0.3.1
 	github.com/spf13/afero v1.12.0
 	github.com/spf13/cobra v1.8.1

diff --git a/go.sum b/go.sum
@@ -40,8 +40,6 @@ github.com/charmbracelet/x/ansi v0.8.0 h1:9GTq3xq9caJW8ZrBTe0LIe2fvfLR/bYXKTx2ll
 github.com/charmbracelet/x/ansi v0.8.0/go.mod h1:wdYl/ONOLHLIVmQaxbIYEC/cRKOQyjTkowiI4blgS9Q=
 github.com/charmbracelet/x/editor v0.1.0 h1:p69/dpvlwRTs9uYiPeAWruwsHqTFzHhTvQOd/WVSX98=
 github.com/charmbracelet/x/editor v0.1.0/go.mod h1:oivrEbcP/AYt/Hpvk5pwDXXrQ933gQS6UzL6fxqAGSA=
-github.com/charmbracelet/x/exp/strings v0.0.0-20250206210616-ac5dd4e7ff44 h1:qQ+AlEwPP1CcrES0o9S5ZoDN0bTI3uWbRyqbhmlsL4Q=
-github.com/charmbracelet/x/exp/strings v0.0.0-20250206210616-ac5dd4e7ff44/go.mod h1:pBhA0ybfXv6hDjQUZ7hk1lVxBiUbupdw5R31yPUViVQ=
 github.com/charmbracelet/x/exp/strings v0.0.0-20250207233001-40534c389c2d h1:DfaFioLurGyvLkEVtVonWhPquBrujumJUtVqXebtgYg=
 github.com/charmbracelet/x/exp/strings v0.0.0-20250207233001-40534c389c2d/go.mod h1:pBhA0ybfXv6hDjQUZ7hk1lVxBiUbupdw5R31yPUViVQ=
 github.com/charmbracelet/x/term v0.2.1 h1:AQeHeLZ1OqSXhrAWpYUtZyX1T3zVxfpZuEQMIQaGIAQ=
@@ -134,8 +132,8 @@ github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnr
 github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo=
 github.com/kdeps/kartographer v0.0.0-20240808015651-b2afd5d97715 h1:CxUIVGV6VdgZo62Q84pOVJwUa0ONNqJIH3/rvWsAiUs=
 github.com/kdeps/kartographer v0.0.0-20240808015651-b2afd5d97715/go.mod h1:DYSCAer2OsX5F3Jne82p4P1LCIu42DQFfL5ypZYcUbk=
-github.com/kdeps/schema v0.2.3 h1:7EYAHgXqZ/aGolIiPOOVoWtPl2zkhFngt5YnnhK+yRY=
-github.com/kdeps/schema v0.2.3/go.mod h1:ovks1qmUtREjcCREAwKnuD06WlKZ1QeqjsBhGn4nL8s=
+github.com/kdeps/schema v0.2.4 h1:a3LkKbRr9BE6cmYvEo1e+L3Y2JmE27gtz3uvpwMN13s=
+github.com/kdeps/schema v0.2.4/go.mod h1:ovks1qmUtREjcCREAwKnuD06WlKZ1QeqjsBhGn4nL8s=
 github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI2bnpBCr8=
 github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
 github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg=
@@ -258,8 +256,6 @@ golang.org/x/arch v0.14.0/go.mod h1:FEVrYAQjsQXMVJ1nsMoVVXPZg6p2JE2mx8psSWTDQys=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
 golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
-golang.org/x/crypto v0.32.0 h1:euUpcYgM8WcP71gNpTqQCn6rC2t6ULUPiOzfWaXVVfc=
-golang.org/x/crypto v0.32.0/go.mod h1:ZnnJkOaASj8g0AjIduWNlq2NRxL0PlBrbKVyZ6V/Ugc=
 golang.org/x/crypto v0.33.0 h1:IOBPskki6Lysi0lo9qQvbxiQ+FvsCC/YWOecCHAixus=
 golang.org/x/crypto v0.33.0/go.mod h1:bVdXmD7IV/4GdElGPozy6U7lWdRXA4qyRVGJV57uQ5M=
 golang.org/x/exp v0.0.0-20250207012021-f9890c6ad9f3 h1:qNgPs5exUA+G0C96DrPwNrvLSj7GT/9D+3WMWUcUg34=